https://github.com/kyoripowered/adventure-platform-mod

An adapter for adventure to integrate with Fabric and NeoForge
https://github.com/kyoripowered/adventure-platform-mod

fabric java minecraft neoforge

Last synced: 11 days ago
JSON representation

An adapter for adventure to integrate with Fabric and NeoForge

• Host: GitHub
• URL: https://github.com/kyoripowered/adventure-platform-mod
• Owner: KyoriPowered
• License: mit
• Created: 2020-03-30T04:56:42.000Z (almost 5 years ago)
• Default Branch: mc/1.21
• Last Pushed: 2024-09-07T06:03:30.000Z (4 months ago)
• Last Synced: 2024-09-08T05:40:54.670Z (4 months ago)
• Topics: fabric, java, minecraft, neoforge
• Language: Java
• Homepage: https://docs.advntr.dev/platform/fabric.html
• Size: 2.11 MB
• Stars: 30
• Watchers: 7
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# adventure-platform-mod

![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/KyoriPowered/adventure-platform-mod/build.yml?branch=mc/1.21) [![MIT License](https://img.shields.io/badge/license-MIT-blue)](LICENSE) [![Maven Central](https://img.shields.io/maven-central/v/net.kyori/adventure-platform-mod-shared?label=stable)](https://search.maven.org/search?q=g:net.kyori%20AND%20a:adventure*) ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/net.kyori/adventure-platform-mod-shared?label=dev&server=https%3A%2F%2Fs01.oss.sonatype.org)

Integration between the [adventure](https://github.com/KyoriPowered/adventure) library and *Minecraft: Java Edition* for the [Fabric](https://fabricmc.net) and [NeoForge](https://neoforged.net) modding systems.

See the [documentation](https://docs.adventure.kyori.net/platform/modded.html) for usage and dependency information for this project and the main `adventure` library.

### Versions

`adventure-platform-mod` tends to not work on more than one major version of Minecraft at a time. See the docs for the latest tested versions on each Minecraft release.

### Contributing

We appreciate contributions of any type. For any new features or typo-fix/style changes, please open an issue or come talk to us in our [Discord] first, so we make sure you're going in the right direction for the project.

All the adventure projects are built with Gradle and use a common checkstyle configuration. `adventure-platform-mod` requires the same Java version that Minecraft itself does in the target version. Please make sure all tests pass, license headers are updated, and checkstyle passes to help us review your contribution.

An unfortunate quirk with Loom is that it resolves dependencies in the configuration phase, before any task execution can happen, so we have to run Gradle twice to generate templates (the first without the daemon, since loom caches some information), then apply our in-project interface injections. Sorry!

This looks like:

```sh

$ ./gradlew --no-daemon generateTemplates

$ ./gradlew build

```

To have browsable game source in your IDE, run `./gradlew genSources` before importing the mod

`adventure-platform-mod` is released under the terms of the [MIT License](LICENSE).

[Discord]: https://discord.gg/MMfhJ8F