https://github.com/firstdarkdev/craterlib

A Library mod and modding api used by FDD Mods.
https://github.com/firstdarkdev/craterlib

minecraft mod

Last synced: 4 months ago
JSON representation

A Library mod and modding api used by FDD Mods.

• Host: GitHub
• URL: https://github.com/firstdarkdev/craterlib
• Owner: firstdarkdev
• License: mit
• Created: 2022-05-11T22:18:38.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2025-09-09T09:15:11.000Z (5 months ago)
• Last Synced: 2025-09-09T12:26:11.098Z (5 months ago)
• Topics: minecraft, mod
• Language: Java
• Homepage:
• Size: 2.12 MB
• Stars: 5
• Watchers: 1
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CraterLib

![badge-snapshot](https://maven.firstdarkdev.xyz/api/badge/latest/snapshots/me/hypherionmc/craterlib/CraterLib-common-1.20-pre6?color=40c14a&name=CraterLib-Snapshot)

***

A Library mod and modding api for easier multi-version minecraft and mod loader development

***

### Supported Minecraft Versions

| Minecraft Version | Support Status |

|-------------------| -------------- |

| < 1.18.2          | ❌              |

| 1.18.2-1.20.2     | ✳️             |

| 1.20.4            | ✳️             |

| 1.20.6            | ❌             |

| 1.21.x            | ✳️             |

- ❌ - 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.

***

## 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

* Cross Mod-Loader Events - Based on [Acara](https://github.com/Keksuccino/acara)

* Cross Mod-Loader Config Screens (Based on [Cloth Config Lite](https://github.com/shedaniel/cloth-config-lite))

* Automatic ModMenu and Forge Config screen registration

* Built in Cross Mod-Loader Network system

* Nojang Modding API

***

## Setup Instructions

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`