Updated README.md, as the mod is now public.

This commit is contained in:
TheTrouper
2024-05-09 07:59:26 -05:00
parent 1c1568c037
commit 9d56f035f2

View File

@@ -1,8 +1,26 @@
# Meteor Addon Template # Meteor Butler Addon
A template to allow easy usage of the Meteor Addon API. Easily control multiple instances of meteor client through a single account.
### How to use: ### How to build:
- Clone this project - Make sure you have [Git](https://git-scm.com/download/win) installed
- Use this template to create new modules/commands - If you're on linux, you can figure it out.
- Run the mod with Meteor. - Clone into the repo and CD into it
- open a terminal
- run `git clone https://github.com/thetrouper/Bulter && cd Butler`
- Build the jar
- in the cloned directory, run `./gradlew build`
- If you are on linux, make sure to `chmod +x gradlew` or it wont run
- The built jar should be in `build/libs/meteor-butler-<version>.jar`
### Modules
- Swarm Plus Worker
- Used to connect to the host and receive commands
- Verbose option will send what you receive from the server in your chat
- Currently, connections will appear to fail, but it still works fine. Please do not open an issue unless it throws an error, then actually doesn't work. The errors are not visible to the host.
- Swarm Plus Host
- Used to host a server that can be connected to by the workers
- Verbose will display connection handshake packets
### Commands
- .manager
- View github wiki for usage guide