https://github.com/unascribed/nilexample
An example mod for NilLoader.
https://github.com/unascribed/nilexample
Last synced: 4 months ago
JSON representation
An example mod for NilLoader.
- Host: GitHub
- URL: https://github.com/unascribed/nilexample
- Owner: unascribed
- License: cc0-1.0
- Created: 2022-05-15T07:21:15.000Z (about 3 years ago)
- Default Branch: trunk
- Last Pushed: 2025-01-02T03:11:17.000Z (5 months ago)
- Last Synced: 2025-01-02T04:21:12.251Z (5 months ago)
- Language: Java
- Homepage:
- Size: 73.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NilExample
A small example for getting started with NilLoader.
## A quick note
NilLoader is not a general purpose loader intended to replace Fabric or Forge.
If you're here, you should either have a specific use case (e.g. wanting to
patch mods on old versions with broken tooling) or just want to mess around with
a new toy for the sake of it.
## Steps to use the template
1. You must pick a unique nilmod ID and put it in build.gradle. You will then
have to rename src/main/resources/modid.nilmod.css to use your ID.
2. You need to rename the package from com.example.nilexample to a package
you have permission to use; see [this wizard](https://unascribed.com/old/javapkg.html)
for help if you don't know what a good package name is.
3. You will probably want to replace LICENSE with something else, unless CC0
Public Domain Dedication is what you want.
## How do I launch a development environment?
NilGradle does not currently (and likely never will) offer a dev environment. In
the future, NilLoader may gain the ability to be run a normal game in dev mode
and then be attached to an IDE for code hotswap. **You will have to restart the
game every time you make changes to your mod**.
## How do I decompile the game?
Pass `-Pnil.decompile` when running your initial Gradle command to generate a
sources jar. You may need to delete `build/nil`.
## Another note
NilGradle is very primitive at the moment, and can quite easily get confused.
If things don't make sense, then delete `build/nil`.