Skip to content

Commit

Permalink
Updated README.md, as the mod is now public.
Browse files Browse the repository at this point in the history
  • Loading branch information
thetrouper committed May 9, 2024
1 parent 1c1568c commit 9d56f03
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
- Clone this project
- Use this template to create new modules/commands
- Run the mod with Meteor.
### How to build:
- Make sure you have [Git](https://git-scm.com/download/win) installed
- If you're on linux, you can figure it out.
- 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

0 comments on commit 9d56f03

Please sign in to comment.