Skip to content

Home

Jump to bottom
Nazar edited this page Oct 16, 2024 · 3 revisions

Welcome to the NoxesiumUtils wiki!

⚠️ The Wiki is under development and may have missing information!

Table of contents

What is the purpose of this?

The Noxesium mod was created by Noxcrew (the creators of MCC) and it has a lot of very useful quality-of-life features for server developers. However there's an issue: there is no simple way to implement the usage of this mod on your server, which can be extremely hard for some teams (that create servers/events) or that they just don't have time to allocate to the development of their own communication interface for the mod.

NoxesiumUtils is a Paper plugin, that attempts to fix this problem. It is a communication interface, that communicates with the Noxesium mod on your players' client. It adds numerous configurations and commands, that make it much simpler to integrate Noxesium with your games.

Prerequisites

  • A Paper 1.21+ server (or its fork)
  • CommandAPI plugin
  • Have the Noxesium mod installed (so you can actually see what the plugin does for yourself)

Implementing Noxesium into your server

First you need to decide on how you want to use Noxesium and for what it is going to be used, what features and how.

Please note, that this plugin probably has a lot of limitations, but if you have any ideas on how to improve the plugin you can submit an issue. (if your idea involves changing the client's behavior, and not the server's, then you probably should create the issue on the Noxesium repository)

After you install the plugin on your server you can check out what you can do with it by typing /noxesiumutils, pressing spacebar and looking at the suggestions. You should also read the Commands page for more informations.

To modify default Server rules each player when they join, or set up The Qib system you should modify the configuration file (plugins/NoxesiumUtils/config.yml). For more information read The configuration file.

Also, you probably should keep this in mind:

  1. Any feature that you make should work for players without Noxesium too. It should always be possible to play your games, even without the mod installed. Never force your players to install it.
  2. The server trusts your players. A player can make a modified version of a mod or have other mods that can give the player unfair advantage. Noxesium is made in such a way that it cannot guarantee fair play. Use of an anti-cheat may lead to false possitives, especially when using The Qib system.
Clone this wiki locally