Compatibility
Minecraft: Java Edition
Platforms
Supported environments
75% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
NoxesiumUtils
Communicate with the Noxesium Mod with ease.
Made in Ukraine! Зроблено в Україні! 🇺🇦
Support me on Patreon ❤️
Warning
With Noxesium release 1.0.0 there were massive changes in the API, which forced me to almost completely rewrite my code, so if you ever depended on NoxesiumUtils, please go over the changes.
What is Noxesium and why does it need Utils?
Noxesium Mod (by Noxcrew) is a fabric mod with feature additions, bugfixes, and performance improvements. It allows servers to offer a better experience to clients through access to additional features beyond vanilla limitations. However, servers need to have a plugin to communicate with the mod to actually be able to use it's features, and that's where NoxesiumUtils comes in. It allows server owners to easily communicate with the mod via commands and can also be used as a dependency for plugin developers.
Features
- Send server rules on join
- Send server rules to players with commands
- Check player's client settings.
- There is a little more to it, lol.
- Maybe more soon
Requirements
- Spigot 1.19.2+
- The plugin won't do anything to players without the mod
Commands
Send Server Rule. Sends a server rule to a selection of players.
/noxesiumutils disableAutoSpinAttack <players: selector> <value: boolean>
/noxesiumutils globalCanDestroy <players: selector> <value: item> <value: item> <value: item> ...
/noxesiumutils globalCanPlaceOn <players: selector> <value: item> <value: item> <value: item> ...
<!-- Since Noxesium Protocol Version 2 -->
/noxesiumutils heldItemNameOffset <players: selector> <value: number>
<!-- Since Noxesium Protocol Version 2 -->
/noxesiumutils cameraLocked <players: selector> <value: boolean>
<!-- Since Noxesium Protocol Version 3 -->
/noxesiumutils enableCustomMusic <players: selector> <value: boolean>
Reset stuff
<!-- Since Noxesium Protocol Version 3 -->
/noxesiumutils resetServerRules <players: selector>
<!-- Since Noxesium Protocol Version 3 -->
/noxesiumutils reset <players: selector> <ALL_SERVER_RULES|CACHED_PLAYER_HEADS>
Check player's Noxesium Protocol Version.
/noxesiumutils check <player: player>
/noxesiumutils check <players: selector>
Check player's settings.
Note: Players with protocol version less than 3 will have most of their settings set to zeros.
<!-- Since Noxesium Protocol Version 3 -->
/noxesiumutils clientSettings <player: player>
For more detailed information on how everything here works, please refer to the Noxesium Mod README!
Config
The default config looks like this. Right now it only contains a setting to send server rules to a player on join.
# View Protocol documentation and information about the mod here:
# https://github.com/Noxcrew/noxesium
# If true will check the plugin's version once in a while.
checkForUpdates: true
# It true will send defaults to Noxesium Players on join.
sendDefaultsOnJoin: false
# Comment out the line if you don't want to send that rule.
defaults:
#disableAutoSpinAttack: false # since protocol 1
#globalCanPlaceOn: [] # since protocol 1
#globalCanDestroy: [] # since protocol 1
#heldItemNameOffset: 0 # since protocol 2
#cameraLocked: false # since protocol 2
#enableCustomMusic: false # since protocol 3
For example, the following config will automatically send the players disableAutoSpinAttack = true
on join.
# If true will check the plugin's version once in a while.
checkForUpdates: true
# It true will send defaults to Noxesium Players on join.
sendDefaultsOnJoin: true # Remember to turn this on, when you are using this feature
# Comment out the line if you don't want to send that rule.
defaults:
disableAutoSpinAttack: true # since protocol 1
#globalCanPlaceOn: [] # since protocol 1
#globalCanDestroy: [] # since protocol 1
#heldItemNameOffset: 0 # since protocol 2
#cameraLocked: false # since protocol 2
#enableCustomMusic: false # since protocol 3
Screenshots
For Developers
View on GitHub