From d9684b3e264299a9933dad373dd4cd6219864416 Mon Sep 17 00:00:00 2001 From: Victor Popkov Date: Mon, 2 Sep 2024 23:15:52 +0300 Subject: [PATCH] Normalize configurations Closes #38. --- CHANGELOG.md | 20 ++++++++++---------- README.md | 30 +++++++++++++++--------------- modinfo.lua | 22 ++++++++-------------- 3 files changed, 33 insertions(+), 39 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6789804..7630672 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,9 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add "Reverse buttons" configuration +- Add "Reverse Buttons" configuration - Add "Target Entities" configuration -- Add "Target indicator usage" configuration +- Add "Target Indicator Usage" configuration - Add equipped "Bush Hat" and "Snurtle Shell Armor" hide support - Add following through wormholes support @@ -23,7 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed -- Remove "Hide changelog" configuration +- Remove "Hide Changelog" configuration - Remove changelog from modinfo ## [0.21.0] - 2020-08-26 @@ -49,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add "Hide changelog" configuration +- Add "Hide Changelog" configuration - Add tests and documentation ### Changed @@ -59,7 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed -- Remove "Mobs" configuration in favour of the "all" behaviour +- Remove "Mobs" configuration in favour of the "All" behaviour ## [0.19.0] - 2019-10-04 @@ -122,8 +122,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add "Following method" configuration -- Add "Push mass checking" configuration +- Add "Following Method" configuration +- Add "Push Mass Checking" configuration ### Changed @@ -247,19 +247,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add "Keep target distance" configuration +- Add "Keep Target Distance" configuration - Add support for "Bunnymen" ### Changed - Improve compatibility with some other mods -- Revert "Action key" and "Push key" configurations +- Revert "Action Key" and "Push Key" configurations ## [0.5.0] - 2019-08-19 ### Added -- Add "Action key" and "Push key" configurations +- Add "Action Key" and "Push Key" configurations ### Changed diff --git a/README.md b/README.md index 2a75797..123738b 100644 --- a/README.md +++ b/README.md @@ -28,21 +28,21 @@ another player to keep following or pushing him. Don't like the default behaviour? Choose your own configuration to match your needs: -| Configuration | Default | Description | -| --------------------------- | ------------- | ---------------------------------------------------------------------------- | -| **Action Key** | _Shift_ | Key used for both following and pushing | -| **Push Key** | _Ctrl_ | Key used in combination with an action key for pushing | -| **Reverse Buttons** | _Disabled_ | When enabled, LMB and RMB will be swapped | -| **Compatibility** | _Recommended_ | Which compatibility mode should be used? | -| **Target Entities** | _Default_ | Which target entities should be used for following and pushing? | -| **Target Indicator Usage** | _Binded_ | How should the target indicator interact with the action key? | -| **Follow Method** | _Default_ | Which follow method should be used? | -| **Follow Distance** | _2.5m_ | How close can a follower approach a leader? | -| **Follow Distance Keeping** | _Disabled_ | When enabled, a follower moves away from a leader within the follow distance | -| **Push With RMB** | _Disabled_ | When enabled, RMB + action key is used for pushing | -| **Push Mass Checking** | _Enabled_ | When enabled, disables pushing entities with very high mass. | -| **Push Lag Compensation** | _Enabled_ | When enabled, automatically disables the lag compensation during pushing | -| **Debug** | _Disabled_ | When enabled, displays debug data in the console. | +| Configuration | Default | Description | +| --------------------------- | ------------- | ------------------------------------------------------------------------ | +| **Action Key** | _Shift_ | Key used for both following and pushing | +| **Push Key** | _Ctrl_ | Key used in combination with an action key for pushing | +| **Reverse Buttons** | _Disabled_ | When enabled, LMB and RMB will be swapped | +| **Compatibility** | _Recommended_ | Which compatibility mode should be used? | +| **Target Entities** | _Default_ | Which target entities should be used for following and pushing? | +| **Target Indicator Usage** | _Binded_ | How should the target indicator interact with the action key? | +| **Follow Method** | _Default_ | Which follow method should be used? | +| **Follow Distance** | _2.5m_ | How close can you approach the target? | +| **Follow Distance Keeping** | _Disabled_ | When enabled, you move away from the target within the follow distance | +| **Push With RMB** | _Disabled_ | When enabled, RMB + action key is used for pushing | +| **Push Mass Checking** | _Enabled_ | When enabled, disables pushing entities with very high mass | +| **Push Lag Compensation** | _Enabled_ | When enabled, automatically disables the lag compensation during pushing | +| **Debug** | _Disabled_ | When enabled, displays debug data in the console | ## Documentation diff --git a/modinfo.lua b/modinfo.lua index ec1c880..52e79df 100644 --- a/modinfo.lua +++ b/modinfo.lua @@ -236,32 +236,26 @@ configuration_options = { AddConfig("follow_method", "Follow Method", "Which follow method should be used?", { { description = "Default", - hover = "Default: player follows a leader step-by-step", + hover = "Default: you follow the target step-by-step", data = "default", }, { description = "Closest", - hover = "Closest: player goes to the closest target point from a leader", + hover = "Closest: you go to the closest point to the target", data = "closest", }, }, "default"), - AddConfig( - "follow_distance", - "Follow Distance", - "How close can a follower approach a leader?", - { - { description = "1.5m", data = 1.5 }, - { description = "2.5m", data = 2.5 }, - { description = "3.5m", data = 3.5 }, - }, - 2.5 - ), + AddConfig("follow_distance", "Follow Distance", "How close can you approach the target?", { + { description = "1.5m", data = 1.5 }, + { description = "2.5m", data = 2.5 }, + { description = "3.5m", data = 3.5 }, + }, 2.5), AddBooleanConfig( "follow_distance_keeping", "Follow Distance Keeping", - "When enabled, a follower moves away from a leader within the follow distance", + "When enabled, you move away from the target within the follow distance", false ),