Skip to content

Configuration

Jump to bottom
Rebecca edited this page Jun 3, 2021 · 13 revisions

Once you have Akashi installed, you should take a moment to configure your settings. Your server configuration can be found in config/config.ini.

Options that should generally always be changed prior to running the server are marked with a ⭐.

Options

  • advertise
    • Toggles whether your server will list itself on the masterserver. Set it to false to disable advertising.
  • max_players
    • The maximum amount of clients that can occupy your server at the same time.
  • ms_ip
    • The IP of the master server. You shouldn't change this.
  • ms_port
    • The port of the master server. You shouldn't change this.
  • port
    • The port that your server will listen for incoming connections on. This port should be free, open to your firewall, and forwarded on your router.
  • ⭐ server_description
    • The description of your server that will be displayed on its master server listing. You can use this to tell users about your server, and provide a link to your server files or discord.
  • ⭐ server_name
    • The name of your server. This will be displayed on its master server listing, and will display in server messages. This should be something unique and easy to identify.
  • motd
    • The "Message of the Day" for your server. This will be displayed when users first join, and can be displayed by running /motd.
  • webao_enable
    • Toggles whether your server will accept webAO connections.
  • webao_port
    • The port your server will listen for incoming webAO connections on. This port should be free, open to your firewall, and forwarded on your router. This cannot be the same as your regular server port.
  • auth
    • The level of authorization on your server. Permitted values are "simple" and "advanced" This should only be changed by running /changeauth from within the server.
  • ⭐ modpass
    • The modpass used to login as a moderator under simple authorization. This should be set to something secure.
  • logbuffer
    • The amount of logged messages the server will store. If the log is not flushed before this limit is reached, the server will start deleting the oldest messages in the buffer to make room for new ones.
  • logging
    • The type of logging the server will use. Permitted values are "modcall" and "full". Modcall logging will flush the server log whenever a client calls a moderator. Full logging will flush the logger every time a message is sent, logging everything in the server.
  • maximum_statements
    • The maximum amount of statements a recorded testimony can have.
  • multiclient_limit
    • The maximum amount of simultaneous connections a remote IP can make.
  • maximum_characters
    • The maximum amount of characters that can be sent in an IC or OOC message.
  • message_floodguard
    • The minimum time in milliseconds after an IC message is sent, before a new IC message can be sent.
  • asset_url
    • The URL of your server's remote asset repository.

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.

Discord

  • webhook_enabled
    • Toggles whether the Discord modcall webhook is enabled.
  • webhook_url
    • The URL of the Discord webhook to post to.
  • webhook_sendfile
    • Whether the Discord modcall webhook will also attach a file containing the last IC messages logged in the area.
  • webhook_content
    • Additional text to be sent along with the Discord webhook.
Clone this wiki locally