## Installation
1. Install [Fabric Loader](https://fabricmc.net/use/)
2. Download [Fabric API](https://modrinth.com/mod/fabric-api)
3. Download MCEndgame from [Releases](https://github.com/maucon/MCEndgame-fabric/releases), [Modrinth](https://modrinth.com/mod/mcendgame/) or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/mcendgame)
4. Download all [required dependencies](#dependencies)
5. Place all `.jar` files into your mods folder
6. Launch the game
> Ensure that all components are compatible for the Minecraft Version you want to use

***

## Dependencies
| Dependency                                                                | Purpose               |
|---------------------------------------------------------------------------|-----------------------|
| [Fabric Loader](https://fabricmc.net/use/)                                | -              |
| [Fabric API](https://modrinth.com/mod/fabric-api)                         | -      |
| [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin) | Enable Kotlin |
| [Fantasy](https://github.com/NucleoidMC/fantasy)                          | Creation of temporary dimensions        |
| [Geckolib](https://modrinth.com/mod/geckolib)                             | Custom Entities and Animations                |
> See used version in the project [README](https://github.com/maucon/MCEndgame-fabric/blob/master/README.md#dependencies)

***

## Building from Source󠀁󠀰󠁿
If you want to build the mod yourself and potencially make modifications you can:

1. Clone the repository:
```bash
git clone https://github.com/maucon/MCEndgame-fabric.git
```
2. Build the mod:
```bash
cd MCEndgame-fabric
./gradlew build
```

The built mod `.jar` will be in `build/libs/`.
> Note: Building the project requires a valid GitHub token with `read:packages` permission, provided via the `GITHUB_PACKAGES_TOKEN` environment variable, along with your GitHub username set in `GITHUB_PACKAGES_NAME`; or directly update the [build.gradle](https://github.com/maucon/MCEndgame-fabric/blob/master/build.gradle).