Tianpao/Arclight
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme. [ci skip]

Browse Source
This commit is contained in:
IzzelAliz 2020-06-11 10:05:44 +08:00
parent 58552371bf
commit 197985b60f
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -9,7 +9,7 @@ A Bukkit server implementation utilizing Mixin.
## Installing
1. Download the jar from [release page](https://github.com/IzzelAliz/Arclight/releases) or [build server](https://ci.appveyor.com/project/IzzelAliz/arclight/build/artifacts).
2. Launch with command `java -jar arclight-coremod-xxx.jar`
2. Launch with command `java -jar arclight-forge-mcversion-xxx.jar nogui`. The `nogui` argument will disable the server control panel.
## Support
@ -19,7 +19,18 @@ QQ Group chat 3556966
## Contributing
To setup development workspace, clone this repository and import the project.
This project uses Gradle 4.9 as build tool with [arclight-gradle-plugin](https://github.com/IzzelAliz/arclight-gradle-plugin).
To setup development workspace, clone this repository first, and type
```
./gradlew remapSpigotJar idea
```
This will generate proper spigot sources and srg mappings.
Finally, import the project. IntelliJ IDEA is the recommended IDE.
Due to a [MixinGradle bug](https://github.com/SpongePowered/MixinGradle/issues/9), you may build the project twice or the mixin shadows won't get reobfuscated.
## License