Skip to content

Commit 1cde8cd

Browse files
authored
Update README.md
1 parent 86e6f47 commit 1cde8cd

1 file changed

Lines changed: 1 addition & 24 deletions

File tree

README.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1 @@
1-
### Setup
2-
3-
Clone this repository first.
4-
To edit the plugin display name and other data, take a look at `plugin.json`.
5-
Edit the name of the project itself by going into `settings.gradle`.
6-
7-
### Basic Usage
8-
9-
See `src/smp/ExamplePlugin.java` for some basic commands and event handlers.
10-
Every main plugin class must extend `Plugin`. Make sure that `plugin.json` points to the correct main plugin class.
11-
12-
Please note that the plugin system is in beta, and as such is subject to changes.
13-
14-
### Building a Jar
15-
16-
`gradlew jar` / `./gradlew jar`
17-
18-
Output jar should be in `build/libs`.
19-
20-
21-
### Installing
22-
23-
Simply place the output jar from the step above in your server's `config/mods` directory and restart the server.
24-
List your currently installed plugins/mods by running the `mods` command.
1+
Docs will be later

0 commit comments

Comments
 (0)