Skip to content

Commit 4a128b8

Browse files
authored
Update documentation to make it more friendly towards non-programmers
1 parent aca7795 commit 4a128b8

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

readme.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,22 @@ We have anticheat warnings for certain features already built into the client an
88

99
### Installation
1010

11-
Compile either the Bungee or the Bukkit example code and install on your server into the `plugins` directory. You then need to make a `config.json` and put it onto your server at `plugins/BadlionClientModAPI/config.json`. The first time you boot up the server with this either plugin installed it will automatically create the `plugins/BadlionClientModAPI` directory and a blank `config.json` file.
11+
How to install the Badlion Client Mod API on your server.
1212

13-
Feel free to modify your `config.json` at anytime, but note that it will require a reboot with this example plugin to load the new changes.
13+
#### Quick Installation (for non-programmers)
14+
15+
1. Download **either** the latest bukkit or bungee plugin from our releases (you don't need both, we recommend using the BungeeCord plugin if you are running BungeeCord): https://github.com/BadlionNetwork/BadlionClientModAPI/releases
16+
2. Place the downloaded plugin into your `plugins` directory on your server.
17+
3. Turn on the BungeeCord or Bukkit server and a default config will be automatically made in `plugins/BadlionClientModAPI/config.json`
18+
4. Edit the config as you see fit and reboot the server after you have finished editing the config (see below for more information).
19+
20+
#### Do it yourself (for programmers)
21+
22+
1. Clone this repository
23+
2. Compile the plugin(s) you want to use (you only need one per Minecraft network).
24+
2. Place the compiled plugins from the `target` directories into your `plugins` directory on your server.
25+
3. Turn on the BungeeCord or Bukkit server and a default config will be automatically made in `plugins/BadlionClientModAPI/config.json`
26+
4. Edit the config as you see fit and reboot the server after you have finished editing the config (see below for more information).
1427

1528
### Example Config
1629

0 commit comments

Comments
 (0)