Arclight/README.md

56 lines
2.4 KiB
Markdown
Raw Normal View History

2020-05-16 06:22:29 +00:00
# Arclight
A Bukkit server implementation utilizing Mixin.
2020-08-17 12:21:45 +00:00
![Actions](https://img.shields.io/github/workflow/status/IzzelAliz/Arclight/Java%20CI%20with%20Gradle?style=flat-square) ![GitHub](https://img.shields.io/github/license/IzzelAliz/Arclight?style=flat-square)
2020-06-15 13:53:14 +00:00
2020-08-17 12:21:45 +00:00
| Minecraft | Forge | Status | Build |
| :----: | :----: | :---: | :---: |
2021-01-21 14:27:58 +00:00
| 1.16.x | 36.0.1 | ACTIVE | [![1.16 Status](https://img.shields.io/appveyor/build/IzzelAliz/arclight-16?style=flat-square)](https://ci.appveyor.com/project/IzzelAliz/arclight-16) |
2020-12-11 13:34:34 +00:00
| 1.15.x | 31.2.47 | ACTIVE | [![1.15 Status](https://img.shields.io/appveyor/build/IzzelAliz/arclight-15?style=flat-square)](https://ci.appveyor.com/project/IzzelAliz/arclight-15) |
2020-08-17 12:21:45 +00:00
| 1.14.x | 28.2.0 | [LEGACY](https://github.com/IzzelAliz/Arclight/releases/tag/1.0.6) | [![1.14 Status](https://img.shields.io/appveyor/build/IzzelAliz/arclight?style=flat-square)](https://ci.appveyor.com/project/IzzelAliz/arclight) |
* Legacy version still accepts pull requests.
2020-05-16 07:03:32 +00:00
2020-05-16 06:22:29 +00:00
![](.github/arclightlogo.jpg)
## Installing
2020-08-17 12:21:45 +00:00
1. Download the jar from [release page](https://github.com/IzzelAliz/Arclight/releases) or build server. (see the table above)
2. Launch with command `java -jar arclight-forge-<mc>-<version>.jar nogui`. The `nogui` argument will disable the server control panel.
2020-05-16 06:22:29 +00:00
2020-05-16 08:50:31 +00:00
## Support
Discord server https://discord.gg/ZvTY5SC
QQ Group chat 3556966
2020-05-16 06:22:29 +00:00
## Contributing
2020-06-11 02:05:44 +00:00
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.
2020-05-16 06:22:29 +00:00
## License
This project in licensed under [GPL v3](LICENSE).
2020-11-03 04:18:26 +00:00
## Sponsor
[![](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com)
YourKit supports open source projects with innovative and intelligent tools
for monitoring and profiling Java and .NET applications.
YourKit is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>,
<a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,
and <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a>.