Skip to content

A Nukkit plugin which allows you to block or enable Onix Client modules, or modify their settings for players using Onix Client

Notifications You must be signed in to change notification settings

marioCST/OnixModuleControl-NK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OnixModuleControl

A Nukkit plugin that lets server owners block or modify Onix Client modules or settings for players who join their server.

Tested on Nukkit, Nukkit-MOT, NukkitPetteriM1Edition and PowerNukkitX.

What it does

NOTE: Players not using Onix Client will not be affected.

This plugin gives you more control over what players can or can't use when they join your server with Onix Client. Whether you want to block things like Freelook or Hitboxes, or auto-enable helpful features like Double Click Prevent, this plugin makes it easy to do that through a simple config file.

View the official documentation here.

Example config

# Onix Client Module Control Configuration
# You can find a list of modules here: https://github.com/OnixClient/translations/blob/main/client/languages/en_US.lang

# Verifies blocked_modules, forced_modules and module_settings entry names using https://github.com/OnixClient/translations/blob/main/client/languages/en_US.lang
# If a module or setting doesn't exist or a setting doesn't belong to a module, they'll get ignored
# No verification is done if the lang file couldn't be accessed or parsed
verify_entries: true

# Server name that will be shown in Onix Client UI
server_name: "Server Name"

# Custom notification message (optional, leave empty to use default)
notification_message: ""

# BLOCKED MODULES
# Format:
#   module_name:
#     block: true
#     restriction_reason: "Optional message explaining why it's blocked"
blocked_modules:
  module.freelook.name:
    block: true
  module.hitboxes.name:
    block: true
    restriction_reason: "Wear your glasses instead."

# FORCED MODULES
# Format:
#   module_name:
#     force_enable: true
#     restriction_reason: "Optional message explaining why it's forced"
#     settings:
#       setting_name:
#         value: setting_value
#         min: minimum_value (optional)
#         max: maximum_value (optional)
#         lock_value: true/false (optional)
#         removed_options: [1, 2] (optional, for enum settings)
forced_modules:
  module.double_click_prevent.name:
    force_enable: true
    restriction_reason: "High CPS is not allowed on this server."
    settings:
      module.double_click_prevent.setting.limit_left_click.name:
        value: true
      module.double_click_prevent.setting.left_max.name:
        max: 17

# MODULE SETTINGS ONLY
# For modules that you don't want to block or force, but just want to change settings
# Format is the same as in the "settings" section above
module_settings:
  module.fullbright.name:
    settings:
      module.fullbright.setting.gamma.name:
        max: 3

Result of the example config above

preview.png

About

A Nukkit plugin which allows you to block or enable Onix Client modules, or modify their settings for players using Onix Client

Resources

Stars

Watchers

Forks

Languages