https://github.com/kneelawk/nilclassic-api

API for Classic Minecraft as a NilMod
https://github.com/kneelawk/nilclassic-api

Last synced: about 1 month ago
JSON representation

API for Classic Minecraft as a NilMod

• Host: GitHub
• URL: https://github.com/kneelawk/nilclassic-api
• Owner: Kneelawk
• License: cc0-1.0
• Created: 2023-11-26T09:13:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-05T03:33:19.000Z (about 1 year ago)
• Last Synced: 2024-10-15T06:34:14.316Z (3 months ago)
• Language: Java
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/changelog-v0.1.0.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NilClassic-API

A simple API for modding classic using 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.

Additionally, NilLoader is currently *experimental* and ***API/ABI stability is

not yet guaranteed***.

If you're okay with that, then cool. Let's continue.

## The API

### Entrypoints

NilClassic-API provides entrypoints:

* `client-init` - Earliest point when it is safe to access Minecraft code. This can be used for registering event

  listeners.

* `server-init` - Earliest point when it is safe to access Minecraft server code. This can be used for registering event

  listeners.

## Depending on NilClassic-API

NilClassic can be used by depending on it in your gradle script:

```groovy

repositories {

    maven {

        name = 'Kneelawk'

        url = 'https://kneelawk.com/maven/'

    }

}

dependencies {

    // if you are working on a client-side mod:

    implementation "com.kneelawk.nilclassic-api:client:${nilclassicApiVersion}"

    // if you are working on a server-side mod:

    implementation "com.kneelawk.nilclassic-api:server:${nilclassicApiVersion}"

    // if you are working on common code shared between client-side and server-side:

    implementation "com.kneelawk.nilclassic-api:common:${nilclassicApiVersion}"

}

```

## Building

The current version of NilGradle gets confused by classic mappings causing the mod to need to be built in 3 stages via

separate gradle invocations. These can be run via a bash command:

```bash

./gradlew clean && ./gradlew check && ./gradlew build

```

## Decompiling

Decompiling is broken on classic versions. Something about the class files just break VineFlower.

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