Skip to main content

Modules

The features of the network are modules: each one can be switched on and off, and keeps its settings and texts in its own folder. The modules shipped with GrayCore are inside graycore-paper.jar; other plugins can add their own (the RPG sample does).

ModuleIdOn by default
KitskitsNo: set enabled: true in its config.yml
WarpswarpsNo: set enabled: true in its config.yml
RPG samplerpg-sampleYes, when its plugin is installed

A module's folder​

plugins/GrayCorePaper/modules/<id>/
config.yml enabled: true, plus the module's own settings
locale/en.yml the module's own texts
  • enabled decides whether the module runs. The file is written on the first start and then belongs to you: GrayCore never overwrites it. A value that is not true or false keeps the module off and is logged.
  • Texts you remove from locale/en.yml fall back to the defaults shipped with the module.
  • What a module stores (cooldowns, items...) stays where it is when the module is switched off, and is used again when it comes back.

Managing them​

  • /gcadmin modules lists the modules and their state.
  • /gcadmin modules enable <id> and disable <id> start or stop one until the next restart, without touching its file.
  • /gcadmin reload reads every module's config.yml and texts again, and starts or stops the modules switched in their file. A file that is broken at that moment keeps the previous settings.

A module that fails to start does not take the others down: it is marked failed, and the modules that depend on it are blocked.