From 197985b60f91f8fbb7d501df2b6bfb350606db72 Mon Sep 17 00:00:00 2001 From: IzzelAliz Date: Thu, 11 Jun 2020 10:05:44 +0800 Subject: [PATCH] Update readme. [ci skip] --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 126ea4dc..9aa4b99b 100644 --- a/README.md +++ b/README.md @@ -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