Skip to content

Commit 63bbe0c

Browse files
author
xnrand
committed
add readme
1 parent 6974707 commit 63bbe0c

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
SimpleIRCBridge
2+
===============
3+
4+
Building
5+
--------
6+
7+
```
8+
./gradlew build
9+
```
10+
11+
The output will be located at `build/libs/SimpleIRCBridge-VERSION.jar`.
12+
13+
Developing
14+
----------
15+
16+
Setup for IDEs is covered in the [Forge documentation](https://mcforge.readthedocs.io/en/latest/gettingstarted/#from-zero-to-modding).
17+
18+
The mod can easily be tested using `./gradlew runServer`. A `run` directory will be created, holding server files.
19+
20+
21+
Usage
22+
-----
23+
24+
Drop the jar file in your `mods` directory, start the server once, edit `config/simpleircbridge.cfg` and restart the server.

0 commit comments

Comments
 (0)