Skip to content

Commit cb74095

Browse files
committed
Default embed.
1 parent 5fcbe35 commit cb74095

3 files changed

Lines changed: 28 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
PearlPlus automatically detects new stasis pearls and registers them with its own pearl loader. Pearl throwers can then load these pearls through chat whispers.
44
The config is saved to `plugins/config/pearlplus.json`
55

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.
77

88
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).
99
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
5858
pearlplus droppearlafterload <on/off>
5959
```
6060

61-
### Ingame Whisper Commands
61+
### In-game Whisper Commands
6262

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.
6464

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.
6666

6767
`rename oldPearlID newPearlID` changes the pearlID.
6868

6969
`default PearlID` sets that pearl as default if `autodefault` disabled.
7070

7171
### Usage
7272

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.
7474
```bash
7575
/w <botName> load <optionalID>
7676
```
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`
7878

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.
8080

8181
Can be enabled with `pp autodetect temp on`
8282

8383
#### Manual setup
84-
Use the `pp add/del` commands to setup manually.
84+
Use the `pp add/del` commands to set up manually.
8585

8686
#### 2b2t / Anti-spam
8787

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.
8989

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`.
9191

9292
### Building The Plugin
9393

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
plugin_version=2.0.5
1+
plugin_version=2.0.6
22
plugin_name=PearlPlus
33
mc=1.21.4
44
maven_group=dev.zenith.pearlplus

src/main/java/dev/zenith/pearlplus/command/PearlPlusCommand.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,4 +328,21 @@ public LiteralArgumentBuilder<CommandContext> register() {
328328

329329
return builder;
330330
}
331+
332+
@Override
333+
public void defaultEmbed(final Embed builder) {
334+
String defaultPearlId = PLUGIN_CONFIG.defaultPearlId == null ? "None" : PLUGIN_CONFIG.defaultPearlId;
335+
builder
336+
.addField("Enabled", toggleStr(PLUGIN_CONFIG.autoLoad.enabled))
337+
.addField("Default Pearl ID", defaultPearlId)
338+
.addField("Return Position", toggleStr(PLUGIN_CONFIG.autoLoad.returnToStartPos))
339+
.addField("Strict", toggleStr(!PLUGIN_CONFIG.autoLoad.allowNoiseAfterPearl))
340+
.addField("Autodetect", toggleStr(PLUGIN_CONFIG.autoDetect.enabled))
341+
.addField("Autodetect Temp", toggleStr(PLUGIN_CONFIG.autoDetect.temporaryMode))
342+
.addField("Distance Check", toggleStr(PLUGIN_CONFIG.autoDetect.distanceCheck))
343+
.addField("Auto Default", toggleStr(PLUGIN_CONFIG.autoLoad.autoDefaultToPresent))
344+
.addField("Whitelist", toggleStr(PLUGIN_CONFIG.autoLoad.whitelistEnabled))
345+
.addField("Drop Pearl After Load", toggleStr(PLUGIN_CONFIG.autoLoad.dropPearlAfterLoad))
346+
.primaryColor();
347+
}
331348
}

0 commit comments

Comments
 (0)