2022-05-12 00:20:18 +02:00
|
|
|
# CraterLib
|
2022-05-12 00:18:53 +02:00
|
|
|
|
2023-05-29 18:23:56 +02:00
|
|
|
|
2022-07-03 22:39:42 +02:00
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
2024-05-09 13:27:22 +02:00
|
|
|
A Library mod and modding api for easier multi-version minecraft and mod loader development
|
2022-05-12 00:18:53 +02:00
|
|
|
|
2022-06-10 18:58:26 +02:00
|
|
|
***
|
|
|
|
|
|
2024-05-19 19:22:05 +02:00
|
|
|
### Supported Minecraft Versions
|
|
|
|
|
|
|
|
|
|
| Minecraft Version | Support Status |
|
|
|
|
|
|-------------------| -------------- |
|
|
|
|
|
| < 1.18.2 | ❌ |
|
|
|
|
|
| 1.18.2-1.20.2 | ✳️ |
|
|
|
|
|
| 1.20.4 | ✳️ |
|
|
|
|
|
| 1.20.6 | 🚧 |
|
|
|
|
|
|
|
|
|
|
- ❌ - Not Supported; no bug fixes or new features.
|
|
|
|
|
- 🚧 - Work in Progress; not ready for release.
|
|
|
|
|
- ✳️ - Long Term Support; receives changes through backports only.
|
|
|
|
|
- ✅ - In Support; the active version, receiving all bugfixes and features directly.
|
|
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
2022-06-10 18:58:26 +02:00
|
|
|
## Library Features
|
|
|
|
|
|
|
|
|
|
* Universal Config System (TOML Based)
|
|
|
|
|
* Built in Helper Classes for Various minecraft features
|
|
|
|
|
* Built in Optifine-Compat utilities
|
|
|
|
|
* Various utilities for Blockstates, LANG, Math and Rendering
|
2023-05-10 21:21:16 +02:00
|
|
|
* Cross Mod-Loader Events - Based on [Acara](https://github.com/Keksuccino/acara)
|
2022-07-03 22:29:09 +02:00
|
|
|
* Cross Mod-Loader Config Screens (Based on [Cloth Config Lite](https://github.com/shedaniel/cloth-config-lite))
|
2022-08-06 23:36:19 +02:00
|
|
|
* Automatic ModMenu and Forge Config screen registration
|
2022-09-25 01:52:45 +02:00
|
|
|
* Built in Cross Mod-Loader Network system
|
2024-05-09 13:27:22 +02:00
|
|
|
* Nojang Modding API
|
2022-06-10 18:58:26 +02:00
|
|
|
|
|
|
|
|
***
|
|
|
|
|
|
2022-05-12 00:20:18 +02:00
|
|
|
## Setup Instructions
|
2022-05-12 00:18:53 +02:00
|
|
|
|
2023-06-17 21:09:26 -05:00
|
|
|
There's a **wiki coming soon**, but for now, here's some basic instructions for building the project:
|
|
|
|
|
|
|
|
|
|
1. `git clone` the project to a safe spot.
|
|
|
|
|
2. Install Java's JDK 17. Make sure you have the development version explicitly:
|
|
|
|
|
* Fedora: `sudo dnf install java-17-openjdk-devel`
|
|
|
|
|
* Ubuntu: `sudo apt install openjdk-17-jdk`
|
|
|
|
|
* macOS: `brew install openjdk@17`
|
|
|
|
|
3. Set it accordingly:
|
|
|
|
|
* Windows/macOS: Set the `JAVA_HOME` environment variable or use system settings
|
|
|
|
|
* Linux: `sudo update-alternatives --config java`
|
|
|
|
|
4. Navigate to the CraterLib folder, then run a `gradlew` file depending on your operating system:
|
|
|
|
|
* Windows: `.\gradlew.bat build`
|
|
|
|
|
* macOS/Linux/BSD: `chmod +x gradlew` and `./gradlew`
|
