Skip to content

Home

Jump to bottom
Aeltumn edited this page Jan 7, 2025 · 9 revisions

Welcome to the Noxesium wiki! This wiki features information intended for developers that wish to work with Noxesium for their server-side creations.

This wiki has been formed over time through community contributions as new features and functionality has been added to the mod. Not all documentation may be of the same quality but we attempt to keep everything up-to-date.

Server developers are welcome to submit additional patches they need, feel free to open an issue to discuss your ideas.

Features

Usage

Public builds of Noxesium are available on Modrinth and CurseForge. Upcoming releases can be found on the Releases page here on GitHub.

Developers that want to use Noxesium as a dependency can add it can find the artifact on our public Maven repository.

The following artifacts are available:

  • api: General code for interacting with Noxesium on any platform.
  • common: Client mod specific code shared between Fabric and NeoForge.
  • fabric: Fabric-specific implementation.
  • neoforge: NeoForge-specific implementation.
  • paper: Server-side API implementation for Paper.

The two most relevant modules for server developers are the api and paper modules. The api module contains generic code which you can use on any server-side software to interact with Noxesium clients. The paper module directly contains our own server-side implementation written in Kotlin for Paper which allows you to interface with Noxesium clients. This also implements backwards compatibility for older Noxesium clients.

If you intend to interact with Noxesium from a server-side Fabric mod it is advised that you look into our Paper implementation first and copy its logic. The Fabric implementation provided here is only intended for client-side usage and does not properly handle registering plugin channels when new players connect.

Here are some examples for including Noxesium's API module into your Maven or Gradle project:

Maven:

<repository>
    <id>noxcrew-maven</id>
    <name>Noxcrew Public Maven Repository</name>
    <url>https://maven.noxcrew.com/public</url>
</repository>

<dependency>
  <groupId>com.noxcrew.noxesium</groupId>
  <artifactId>api</artifactId>
  <version>NOXESIUM_VERSION</version>
</dependency>

Gradle (Kotlin):

repositories {
    maven("https://maven.noxcrew.com/public")
}

dependencies {
    api("com.noxcrew.noxesium:api:NOXESIUM_VERSION")
}
Clone this wiki locally