Mod documentation

Thanks to @Weissnix4711 for the documentation

---

Mod documentation

Custom mods

Documentation for other mods can be found on their own GitHub repo, or by asking the creator(s).

Built-in mods

(Please note usage refers to in-game commands, while settings refers to the custom.yaml file.)

Audit

Records player actions and inventory transaction packet into database. This mod also provides an API to handle those events. For API usage, see the spawn protection mod.

Usage: /audit [on|off]

Settings: database: audit.db

BasicAntiCheat

It's an anti cheat. As the name suggests, it's fairly basic. But it does get the job done.

Usage: no commands

Settings: none

Blacklist

Finally! A /ban command. This plugin adds a functional blacklist, so you can block certain players from joining your server.

Usage:

/ban <name: string> [reason: string] - Ban a player
/unban <name: string> - Unban a player

Settings: enable-commands: true

BossBarSupport

Usage: no commands

Settings: none

Bus

WIP mod to allow for remote access / web interface. Also see MiniBus.

Usage: no commands

Settings:

name: "element-zero"
host: "127.0.0.1"
port: 4040

ChatAPI

Usage: no commands

Settings: database: chat.db

CommandSupport

Usage: no commands

Settings: none

CrashHandler

Usage: no commands

Settings: none

CustomScoreboard

Usage: no commands

Settings: none

DebugTool

Usage: no commands

Settings:

command:
  log-register: false
  enable-all: false

DynamicMotd

Have a changing Moto of the Day! With customisable intervals.

Usage: no commands

Settings:

list:
  - example
  - example 2
interval: 5 # refresh interval

Economy

Adds a complete money system to the game. This is designed for other plugins to make use of, and be able to interact with. Very similar to EconomyAPI for PocketmineMP.

Usage:

/balance - Get your balance
/update-balance <target> <amount> <reason> - Change a player's balance by a value
/get-balance <target> - Get a player's balance

Settings:

database: economy.db
command: true

Essentials

A simple port of Bukkit's essentials plugin. Includes nicknames, teleportation, warps, and more.

Usage:

/custom-name set <key> <target> <str>
/custom-name clear <target>
/home
/spawn
/tpa <selector>
/tpaccept
/tpdeny
/transferserver <target> <hostname> [port]
/warp to <name>
/warp list
/warp set <name>
/warp del <name>
/global-warp set|del <name>

Settings:

commands:
  transferserver: true
  custom-name: true
  tpa:
    enabled: true
    timeout: 30
  home: true
  warp: true
database: essentials.db
world-database: essentials.db

Experimental

Use experimental gameplay features. This would usually be disabled in BDS.

Usage: no commands

Settings:

force-experimental-gameplay: false
education-feature: false
debug-packs: true

FlatWorld

A flat world plugin, which allows you to customise the world you play on. Similar to the custom superflat world type, found in Java Edition.

Usage: no commands

Settings: none

NetworkStatus

Usage: no commands

Settings: none

NoEncryption

Disables encryption. May give a small performance boost.

Usage: no commands

Settings: none

NullPlayerData

Usage: no commands

Settings: bypass_op: false

PacketDumper

Dumps packet info. Useful for debugging.

Usage: no commands

Settings: database: packet.db

ScriptingSupport

Usage: no commands

Settings: none

SignCommand

Usage: no commands

Settings: none

SpawnProtection

Protect a certain world area around spawn. Players cannot destroy / place blocks in this region.

Usage: /spawn-protection <mode>

Settings:

start:
  x:0
  y:0
end:
  x:0
  y:0
allow-operator: false