|
3 | 3 | PearlPlus automatically detects new stasis pearls and registers them with its own pearl loader. Pearl throwers can then load these pearls through chat whispers. |
4 | 4 | The config is saved to `plugins/config/pearlplus.json` |
5 | 5 |
|
6 | | -In Zenith run `plugins download https://github.com/duccss/PearlPlus/releases/download/2.0.4/PearlPlus-2.0.4.jar` or download the [lastest build](https://github.com/duccss/PearlPlus/releases/latest) and place the jar file in your proxys plugin folder. |
| 6 | +In Zenith run `plugins download https://github.com/duccss/PearlPlus/releases/download/2.0.6/PearlPlus-2.0.6.jar` or download the [lastest build](https://github.com/duccss/PearlPlus/releases/latest) and place the jar file in your proxy's plugin folder. |
7 | 7 |
|
8 | 8 | This plugin **WILL NOT WORK** unless a correct `chatschema` is set in Zenith. Most vanilla servers like 2b2t and Constantiam don't require you to set one but other servers with custom whisper builders for example 9b9t will need one. Please check the wiki [here](https://wiki.2b2t.vc/Commands/#chatschema). |
9 | 9 | You might also need to set the whisper command for the server you're playing on using `extraChat whisperCommand <command>` to allow the bot to whisper back. |
@@ -58,36 +58,36 @@ pearlplus whitelist clear |
58 | 58 | pearlplus droppearlafterload <on/off> |
59 | 59 | ``` |
60 | 60 |
|
61 | | -### Ingame Whisper Commands |
| 61 | +### In-game Whisper Commands |
62 | 62 |
|
63 | | -There are a few ingame commands players can whisper to the bot to manage their pearls. |
| 63 | +There are a few in-game commands players can whisper to the bot to manage their pearls. |
64 | 64 |
|
65 | | -`pearls` will list all pearlID's with an asterisk next to ID's where a pearl isnt detected. |
| 65 | +`pearls` will list all pearlID's with an asterisk next to ID's where a pearl isn't detected. |
66 | 66 |
|
67 | 67 | `rename oldPearlID newPearlID` changes the pearlID. |
68 | 68 |
|
69 | 69 | `default PearlID` sets that pearl as default if `autodefault` disabled. |
70 | 70 |
|
71 | 71 | ### Usage |
72 | 72 |
|
73 | | -Simply throw a new ender pearl and once it becomes stable the bot will register it, setting the pearlID as "Base" by default with an incrementing number for subsequent pearls. That player can now whisper `load` to the zenith bot and the bot will load the pearl. Players with multiple pearls can add the pearlID after `load` to have a specific pearl loaded. Players will recieve a warning whisper when loading a stasis chamber where a pearl isnt detected. |
| 73 | +Simply throw a new ender pearl and once it becomes stable the bot will register it, setting the pearlID as "Base" by default with an incrementing number for subsequent pearls. That player can now whisper `load` to the zenith bot and the bot will load the pearl. Players with multiple pearls can add the pearlID after `load` to have a specific pearl loaded. Players will receive a warning whisper when loading a stasis chamber where a pearl isn't detected. |
74 | 74 | ```bash |
75 | 75 | /w <botName> load <optionalID> |
76 | 76 | ``` |
77 | | -By default, when a player doesnt specify which pearl they want loaded the bot will load whatever one where a pearl is detected. Can be disabled with `pp autodefault off` |
| 77 | +By default, when a player doesn't specify which pearl they want loaded the bot will load whatever one where a pearl is detected. Can be disabled with `pp autodefault off` |
78 | 78 |
|
79 | | -Temp mode automatically removes pearl positions where a pearl isnt detected. May be buggy. Not recommended. Do **NOT** use `pp distancecheck` with temp mode. |
| 79 | +Temp mode automatically removes pearl positions where a pearl isn't detected. May be buggy. Not recommended. Do **NOT** use `pp distancecheck` with temp mode. |
80 | 80 |
|
81 | 81 | Can be enabled with `pp autodetect temp on` |
82 | 82 |
|
83 | 83 | #### Manual setup |
84 | | -Use the `pp add/del` commands to setup manually. |
| 84 | +Use the `pp add/del` commands to set up manually. |
85 | 85 |
|
86 | 86 | #### 2b2t / Anti-spam |
87 | 87 |
|
88 | | -By default the bot resolves the username of pearl throwers with entity ID's. Some servers might not allow this so if the bot is unable to register pearls automatically use `pp distancecheck on`. This will get the throwers name from the closest player to the pearl. 2b2t players have reported autodetect ceasing to work occasionally. Always test before enabling this feature. |
| 88 | +By default, the bot resolves the username of pearl throwers with entity ID's. Some servers might not allow this so if the bot is unable to register pearls automatically use `pp distancecheck on`. This will get the throwers name from the closest player to the pearl. 2b2t players have reported autodetect ceasing to work occasionally. Always test before enabling this feature. |
89 | 89 |
|
90 | | -By default you can add a random word after `load` or the `pearlID` to get around anti-spam. This can be disabled using `pp strict on`. |
| 90 | +By default, you can add a random word after `load` or the `pearlID` to get around anti-spam. This can be disabled using `pp strict on`. |
91 | 91 |
|
92 | 92 | ### Building The Plugin |
93 | 93 |
|
|
0 commit comments