Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vectrix-space/ignite
A Mixin loader for Spigot/Paper/Velocity
https://github.com/vectrix-space/ignite
access-widener bukkit java minecraft mixins mod mod-loader paper paper-server spigot velocity
Last synced: about 1 month ago
JSON representation
A Mixin loader for Spigot/Paper/Velocity
- Host: GitHub
- URL: https://github.com/vectrix-space/ignite
- Owner: vectrix-space
- License: mit
- Created: 2021-01-05T00:00:21.000Z (almost 4 years ago)
- Default Branch: main/1.0.0
- Last Pushed: 2024-09-03T09:30:02.000Z (2 months ago)
- Last Synced: 2024-09-28T11:42:50.653Z (about 2 months ago)
- Topics: access-widener, bukkit, java, minecraft, mixins, mod, mod-loader, paper, paper-server, spigot, velocity
- Language: Java
- Homepage:
- Size: 993 KB
- Stars: 215
- Watchers: 3
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
[](license.txt)
[](https://discord.gg/rYpaxPFQrj)
[](https://search.maven.org/search?q=g:space.vectrix.ignite%20AND%20a:ignite*)
## Install
Download the `ignite.jar` from the [releases page](https://github.com/vectrix-space/ignite/releases/latest).
Place the `ignite.jar` into the same directory with your Minecraft Server jar (i.e `paper.jar`, `spigot.jar` or `server.jar`).
Run your original start command, but replace the normal server jar with `ignite.jar`. If you are using _Java 8_ you will need to
add `-javaagent:./ignite.jar` to your start command.
If Ignite cannot start your server, you may need to add additional startup flags. See the Advanced Section below for more information.
If you're still confused, be sure to [ask for help](https://discord.gg/rYpaxPFQrj).
The mods can then be placed into the mods directory that will be created.
## Making a Mod
The [ignite-mod-template](https://github.com/vectrix-space/ignite-mod-template) is a template you can use to start a project for Paper without needing to do all the setup yourself.
To depend on the Ignite API in order to create your mod, you will need to add the following to your buildscript:
#### Gradle
```groovy
repositories {
mavenCentral()
maven {
url = "https://maven.fabricmc.net/"
}
}
dependencies {
compileOnly "space.vectrix.ignite:ignite-api:1.1.0"
compileOnly "net.fabricmc:sponge-mixin:0.15.2+mixin.0.8.7"
compileOnly "io.github.llamalad7:mixinextras-common:0.4.1"
}
```
#### Maven
```xml
https://maven.fabricmc.net/
space.vectrix.ignite
ignite-api
1.1.0
net.fabricmc
sponge-mixin
0.15.2+mixin.0.8.7
io.github.llamalad7
mixinextras-common
0.4.1
```
**Note:** To support custom mappings you should check out [ignite-mod-template](https://github.com/vectrix-space/ignite-mod-template)
if you're running Paper. For Spigot check out [Pacifist Remapper](https://github.com/PacifistMC/pacifist-remapper).
### Configuring your Mod
Your mod will require a `ignite.mod.json` in order to be located as a mod. The `ignite.mod.json` provides the metadata needed to load
your mixins and access wideners.
Example `ignite.mod.json`:
```json
{
"id": "example",
"version": "1.0.0",
"mixins": [
"mixins.example.core.json"
],
"wideners": [
"example.accesswidener"
]
}
```
The mods will need to be placed in the directory the launcher will be targeting to load.
#### Using Mixins
The Mixin configuration files will need to be available in your mods binary in order to be loaded. The name of each configuration file
should be added to the `mixins` section in your `ignite.mod.json`, or alternatively could be added to your jar manifest.
[Mixin Specification]
#### Using Access Wideners
The Access Wideners configuration files will need to be available in your mods binary in order to be loaded. The name of each
configuration file should be added to the `wideners` section in your `ignite.mod.json`, or alternatively could be added to your
jar manifest with the `AccessWidener` key.
**Warning:** Access wideners should only be used in situations where Mixin will not work!
[Access Widener Specification]
## Advanced Usage
Ignite has some properties that can be set on startup to change the launch target, mod directory and more. The following could be added
to your startup script:
- The game locator service to use. (e.g `-Dignite.locator=dummy`)
- The path to the server jar. (e.g `-Dignite.jar=./server.jar`)
- The classpath to the server entry point. (e.g `-Dignite.target=org.bukkit.craftbukkit.Main`)
- The directory ignite libraries will be located. (e.g `-Dignite.libraries=./libraries`)
- The directory ignite mods will be located. (e.g `-Dignite.mods=./mods`)
### Game Locators
Game locators provide platform specific modifications to the launch process. In some cases where the platform cannot be automatically
detected, these flags can set the information it needs to launch.
The following targets could use the following flags:
- Paper (1.18+):
- Service name: `paper` (e.g `-Dignite.locator=paper`)
- Extra properties:
- The path to the paperclip jar. (e.g `-Dignite.paper.jar=./paper.jar`)
- The classpath to the paperclip entry point. (e.g `-Dignite.paper.target=io.papermc.paperclip.Paperclip`)
- The minecraft server version paperclip will be patching. (e.g `-Dignite.paper.version=1.20.4`)
- Spigot (1.18+):
- Service name: `spigot` (e.g `-Dignite.locator=spigot`)
- Extra properties:
- Tge path to the spigot bundler directory. (e.g `-Dignite.spigot.bundler=./bundler`)
- The path to the spigot bootstrap jar. (e.g `-Dignite.spigot.jar=./spigot.jar`)
- The classpath to the spigot bootstrap entry point. (e.g `-Dignite.spigot.target=org.bukkit.craftbukkit.bootstrap.Main`)
- The spigot version it will be using. (e.g `-Dignite.spigot.version=1.20.4-R0.1-SNAPSHOT`)
- Paper Legacy:
- Service name: `legacy_paper` (e.g `-Dignite.locator=legacy_paper`)
- Extra properties:
- The path to the paperclip jar. (e.g `-Dignite.paper.jar=./paper.jar`)
- The classpath to the paperclip entry point. (e.g `-Dignite.paper.target=io.papermc.paperclip.Paperclip`)
- The minecraft server version paperclip will be patching. (e.g `-Dignite.paper.version=1.12.2`)
- Velocity:
- Service name: `velocity` (e.g `-Dignite.locator=velocity`)
## Building
__Note:__ If you do not have [Gradle] installed then use `./gradlew` for Unix systems or Git Bash and gradlew.bat for Windows systems in
place of any 'gradle' command.
In order to build Ignite you simply need to run the `gradle build` command. You can find the compiled JAR file in `./build/libs/` named
'ignite.jar'.
## Inspiration
This project has many parts inspired by the following projects:
- [Orion]
- [Fabric]
- [Sponge]
- [Velocity]
- [plugin-spi]
[Mixin]: https://github.com/SpongePowered/Mixin
[Access Widener]: https://github.com/FabricMC/access-widener
[Mixin Specification]: https://github.com/SpongePowered/Mixin/wiki/Introduction-to-Mixins---The-Mixin-Environment#mixin-configuration-files
[Access Widener Specification]: https://fabricmc.net/wiki/tutorial:accesswideners
[Gradle]: https://www.gradle.org/
[Orion]: https://github.com/OrionMinecraft/Orion
[Fabric]: https://github.com/FabricMC/fabric-loader
[Sponge]: https://github.com/SpongePowered/Sponge
[Velocity]: https://github.com/VelocityPowered/Velocity
[plugin-spi]: https://github.com/SpongePowered/plugin-spi
