Configuration

config.yml

The config.yml is the main saikban configuration file. Most settings are described in the default config.

Templates

Almost all of the in-game messages and the website are configurable through templates. They are stored in the template directory on startup and are loaded from there as well. All templates are stored as <name>.<extension>.orig and these .orig files will be overwritten on each startup. To edit a template, remove the .orig suffix, add your changes and save it in the same directory as the old file. On plugin reload, restart or web interface restart this template will be reloaded and your changes will be used.

Config Permission Adapter

The config permission adapter provides an easily configurable permission adapter that can, for example, be used if your permission system is not supported by saikban.

Example:

# default permissions
"": 
- saikban.comment.own
- saikban.view.own.ban
- saikban.view.own.mute
- saikban.view.own.warn
- saikban.view.own.kick
- saikban.notification.own.ban
- saikban.notification.own.mute
- saikban.notification.own.warn
- saikban.notification.own.kick

# moderator group
moderator:
  # inherit from default permissions
  inherit: ""
  # moderator permissions
  permissions: 
  - saikban.ban.default
  - saikban.mute.default
  - saikban.warn.default
  - saikban.kick.default
  - saikban.pardon.ban
  - saikban.pardon.mute
  - saikban.pardon.warn
  - saikban.pardon.kick
  - saikban.view.ban
  - saikban.view.mute
  - saikban.view.warn
  - saikban.view.kick
  - saikban.lock

# admin group
admins:
  # inherit from moderator
  inherit: moderator
  # admin permissions
  permissions: 
  - saikban.ban.admin
  - saikban.mute.admin
  - saikban.ban.default.exempt
  - saikban.mute.default.exempt

# define users
c72e6dc5-3860-4f8e-97d2-a60a2de7a4cd: admin
ad48dc86-1c3b-47be-8993-eb48aeb47705: moderator

# give the console user some special permission
00000000-0000-0000-0000-000000000000:
- saikban.view.console