(ENG) Configuration - Ddedinya/kakashi GitHub Wiki

After you`re done with kakashi installation, you can setup server. The main configuration file is located in config/config.ini.

Also, you can setup webhooks in config/discord.ini.

Parameters, which are should be changed before start a server are marked with ⭐.

Options

  • max_players
    • Defines the maximum number of players, which can be kept at the same time on server.
  • port
    • Port of your server, through which the connection with the client will go. The port itself must be forwarded.
  • ⭐ server_description
    • Description of your server. To make cyrillic characters work you must convert text, so that the Cyrillic alphabet is converted as follows: \x414\x43e\x431\.
  • ⭐ server_name
    • Name of your server, which is shown to players in servers list and server messages.
  • ⭐ motd
    • MOTD of your server. It`s shown on connection to server and with using /motd command.
  • webao_enable
    • Defines, if players, which are using webAO, can connect to the server.
  • webao_port
    • Port of your server, through which the connection with the webAO will go. The port itself must be forwarded.
  • auth
    • The level of authentication on server. Values of this parameter - simple and advanced. It`s not recommended to change value of this parameter in config, better change it with /changeauth command.
  • ⭐ modpass
    • Password, which is used to authorize as moderator, when the lever of auth - simple.
  • logbuffer
    • Number of messages from logs, which will be kept constantly in buffer. Buffer is not cleared when the limit is reached. Instead, old messages are being deleted when there`re the new ones.
  • logging
    • Type of logging on server. Values of this parameter - modcall, full and fullarea. With the value "modcall" logs are written only after using the modcall, with the value "full" logs are written constantly to one file, and with the value "fullarea" logs are written constantly to different files and distributed across the area in which the action occurred.
  • maximum_statements
    • Maximum amount of messages, which can contain recorded testimony.
  • multiclient_limit
    • Maximum amount of connections from one IP-address.
  • maximum_characters
    • Maximum amount of characters, which can be used in one IC/OOC message in chat.
  • maximum_characters_chillmod
    • Maximum amount of characters, which can be used in one IC/OOC message in chat while Chill Mod is acrive in area.
  • message_floodguard
    • Time in miliseconds, needed to send the next message in IC chat in area, if floodguard is active.
  • global_message_floodguard
    • Time in miliseconds, needed to send the next message in IC chat in area. It works on all players no matter what.
  • asset_url
    • Web-server address with with the assets of your client. It is necessary to specify if clients can be connected to the server from webAO or for streaming server music to the client.
  • automodtrig
    • Time in miliseconds, which is considered the minimum normal time difference between messages in IC chat. If player sends messages more often than the specified minimum, the Auto Mod will start its dirty job.
  • automodooctrig
    • Time in miliseconds, which is considered the minimum normal time difference between messages in IC chat. If player sends messages more often than the specified minimum, the Auto Mod will start its dirty job.
  • automodbanduration
    • Ban time, received from Auto Mod.
  • automodwarnterm
    • Warn time, received from Auto Mod.
  • wuso
    • Defines, whether WUSO is enabled on the server or not.
  • ytdlp
    • Defines, whether yt-dlp is used on the server for YT links or not.

Advertiser

  • advertise
    • Defines, will be server shown in servers list or not.
  • debug
    • Defines, will server show debugging messages related to the master server in the console.
  • ms_ip
    • Master-server address - the server, which is responsible for servers list and some other things. This one is not recommended to change.
  • hostname
    • Host name for your server. Defined by IP-address on DNS name.

Dice

  • max_value
    • The maximum number of faces a dice can have.
  • max_dice
    • The maximum amount of dice that can be rolled at once.

Password

  • password_requirements
    • Defines, will be there any requirements for password be followed or not.
  • pass_min_length
    • Minimum password length.
  • pass_max_length
    • Maximum password length.
  • pass_required_mix_case
    • Defines, must be the password should be written in uppercase and lowercase or not.
  • pass_required_numbers
    • Defines, must be the password contain numbers or not.
  • pass_required_special
    • Defines, must be the password have special characters or not.
  • pass_can_contain_username
    • Defines, must be the password have username or not.

Discord

  • webhook_enabled
    • Enable webhook integration in Discord.
  • webhook_modcall_enabled
    • Enable modcall webhook, which is delivered, if player writes in modcall.
  • webhook_modcall_url
    • Modcall webhook adress.
  • webhook_modcall_content
    • Optional text, which is delivered with modcall weebhook. To ping any role use format <@&[ID role]>.
  • webhook_modcall_sendfile
    • Defines, must logs be sent with modcall webhook or not.
  • webhook_ban_enabled
    • Enable webhook ban.
  • webhook_ban_url
    • Webhook ban adress.
  • webhook_uptime_enabled
    • Enable uptime webhook, with the help of which you can find out from the Discord whether the server is running and how long it is running.
  • webhook_uptime_time
    • Time in minutes, which defines, once in how many minutes to send an uptime webhook.
  • webhook_uptime_url
    • Uptime webhook adress.

Roles configuration

If you want to use advanced authentication, you need to configure roles for users, else you will not be able to assign the necessary rights to them. The roles are prescribed in config/acl_roles with such method:

[role_name]
permission=true (or false, but where is the point of that)

As for example:

[moderator]
ban = true
kick = true
mute = true
chat_moderator = true

Here`s the list of all permissions:

kick
ban
moify_users
casemaster
global_timer
motd
chat_moderator
mute
remove_casemaster
save_testimony
force_charselect
bypass_locks
ignore_background_list
send_notice
wuso
sneak
taketaked
ipidinfo
gm
savearea
reload
super

Permissions are needed for accessing comands. In this wiki there all comands and their permissions, so it will not be difficult to decide what rights to grant roles.

Areas

You can add various areas in config/areas.ini

  • [id:hub id:name]
    • Area ID, ID of the hub to which the room belongs, and area name. Areas are ordered basing on their ID number. List starts from 0, and zero area - area, that only connected players will enter.
  • background
    • Area background. The name must match the one you need in the client, otherwise there will be a void instead of the background.
    • Standard value: gs4
  • protected_area
    • Defines, will it be possible to take the CM hub in the area or not.
    • Standard value: false
  • iniswap_allowed
    • Defines, will it be possible to use iniswaps in area or not.
    • Standard value: true
  • bg_locked
    • Defines, can everyone can change the background in the area or only CMs can do it.
    • Standard value: false
  • evidence_mod
    • Evidence mode in area. There are several modes:
      • ffa: Every player can change evidence.
      • mod: Only moderator can change evidence.
      • cm: Only CM can change evidence.
      • hidden_cm: Same as CM, but CM can adjust the evidence so that they are visible only to people in certain positions or are hidden from everyone until it is shown.
    • Standard value: ffa
  • lock_status
    • Defines, will be the area locked or not. Set FREE to let it open, or set LOCKED so that it was initially closed.
    • Standard value: FREE
  • blankposting_allowed
    • Defines, can players send blank messages in IC chat or not.
    • Standard value: true
  • area_message
    • Indicates messages, which is automaticly send to player, if he enters the area.
    • Defines, must be the player, entered the area, recieve message, set the parameter above.
    • Standard value: false
  • wtce_enabled
    • Defines, can players use WTCE buttons in area or not.
    • Standard value: true
  • shouts_enabled
    • Defines, can players use shotouts in area or not.
    • Standard value: true
  • force_immediate
    • Defines, will be the messages of players sent "forcibly" despite the unfinished pre-animation or the message of another player who still "speaks" his character.
    • Standard value: false
  • toggle_music
    • Defines, can all players change music or only CMs.
    • Standard value: true
  • shownames_allowed
    • Defines, can players use shownames.
    • Standard value: true
  • chillmod
    • Defines, enabled in area Chill Mod or not.
    • Standard value: false
  • automod
    • Defines, enabled in area Automod or not.
    • Standard value: false
  • floodguard_active
    • Defines, enabled in area floodguard or not.
    • Standard value: false
  • change_status
    • Defines, can players change status in area or not.
    • Standard value: false

Hubs

You can add hubs in config/hubs.ini.

  • [id:name]
    • Hub ID and it`s name. Hubs are ordered basing on their ID number. List starts from 0.
  • protected_hub
    • Defines, will it be possible to take the GM role in the hub or not.
    • Standard value: false
  • hide_playercount
    • Defines, whether the players count in the hub will be hidden or not.
    • Standard value: false
  • lock_status
    • Defines, whether the hub will be opened, muted or closed.
    • Standard value: FREE

Adding custom content

Initially, kakashi was configured to work with vanilla client. If you need to configure server with custom content you need to redact relevant configuration files. CAUTION! In this files you can`t add comments! And a randomly left space somewhere in the middle of the list will be considered part of this list!

Adding music

For adding music write file name or a direct Internet link to it(which is not recommended to do) in config/music.txt

The music is prescribed in this way

Category
music.format

As for example, if you want to music list look like that:

Then the music.txt is needed to be written like this:

Announce the Truth
Announce The Truth (AA).opus
Announce The Truth (AJ).opus
Announce The Truth (JFA).opus
Announce The Truth (Miles).opus
Announce The Truth (T&T).opus
Objection!
OBJECTION (AA).opus
Objection (AJ).opus
OBJECTION (JFA).opus
Objection (Miles).opus
OBJECTION (T&T).opus
Pursuit
Pursuit (AA) - variation.opus
Pursuit (AA).opus
Pursuit (AJ).opus
Pursuit (DS).opus
Pursuit (JFA) - variation.opus
Pursuit (JFA).opus
Pursuit (Miles).opus
Pursuit (T&T) - variation.opus
Pursuit (T&T).opus
Pursuit ~ I Want to Find the Truth (Orchestra).opus

Adding background

List of background is located in config/backgrounds.txt. To add background it`s enough just to write its name from a new line.

Adding characters

List of characters is located in characters.txt. To add character it`s enough just write his name (not to be confused with showname. If confused - add the name of the character folder) from a new line.