Skip to content

harritaco/PearlPlusv2

Repository files navigation

PearlPlusv2

This is a continuation of https://github.com/duccss/PearlPlus/tree/1.21.4 It's almost exclusively updated using Claude Code as I don't know how to code.

PearlPlus automatically detects new stasis pearls and registers them with its own pearl loader. Pearl throwers can then load these pearls through chat whispers. The config is saved to plugins/config/pearlplus.json

In Zenith run plugins download https://github.com/duccss/PearlPlus/releases/download/2.0.1/PearlPlus-2.0.1.jar or download the lastest build and place the jar file in your proxys plugin folder.

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

Management Commands

You can use either pp or pearlplus

pearlplus <on/off>
pearlplus add <playerName> <pearlId> <x> <y> <z>
pearlplus del <playerName> <pearlId>
pearlplus list
pearlplus defaultpearlid <word/none>
pearlplus autodefault <on/off>
pearlplus strict <on/off>
pearlplus autodetect <on/off>
pearlplus autodetect temp <on/off>
pearlplus returnpos <on/off>
pearlplus distancecheck <on/off>

Ingame Whisper Commands

There are a few ingame commands players can whisper to the bot to manage their pearls.

pearls will list all pearlID's with an asterisk next to ID's where a pearl isnt detected.

rename oldPearlID newPearlID changes the pearlID.

default PearlID sets that pearl as default if autodefault disabled.

Usage

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.

/w <botName> load <optionalID> 

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

Temp mode automatically removes pearl positions where a pearl isnt detected. May be buggy. Not recommended. Do NOT use pp distancecheck with temp mode.

Can be enabled with pp autodetect temp on

Manual setup

Use the pp add/del commands to setup manually.

2b2t / Anti-spam

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.

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.

Building The Plugin

Clone the repo or download the zip. Run chmod +x gradlew then ./gradlew build

About

PearlPlus for ZenithProxy

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages