Noxesium Paper API

Noxesium Paper API

Noxesium is a client-side Fabric mod which gives server plugins more control over client behavior. This Paper plugin adds an API you can use to manage all interactions with the Noxesium client features.

Features ✏️

The primary method to interact with the API is through its code interface, the source code of which you can find here. You can also control various features through the in-game /noxesium command. Some functionality is exclusively accessible through code.

Commands 🎛️

Here's the currently supported sub-commands of /noxesium:

• component Configures components on entities or players which lets you control entity behaviors. See the list below for some examples of what components can do.
• link Opens up a pop-up for the target player to open a URL in a browser.
• list Shows a list of players using Noxesium and which version they are on.
• playsound Plays a sound with additional customisable settings such as a time offset, looping, or no attenuation. The code API for this feature can also modify previous sound instances and fade out sound effects.
• zoom Lets you control the zoom and FOV of a client.

Components 🦌

There's a number of components available for players and entities:

• Creating custom interactable objects like speed boosters or jump pads.
• Changing the color of beacon, guardian or end crystal beams.
• Customise properties of inventory items such as hover sounds, how the item's slot is rendered, and whether you can move the item.
• Move various movement systems to be controlled by the client such as riptide tridents, elytras, and lunge spears.
• Prevent clients from using debug features such as GUI hiding, showing hitboxes, and various debug renderers.

... And many more! These can all be changed at any time and tweaked through the command or in code.

Source 8️⃣

You can find the source code for the API here. The API has extensive code comments, no further documentation exists at this time.