Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 3.56 KB

ConfigurationNoGUI.md

File metadata and controls

57 lines (46 loc) · 3.56 KB
Raw

DiscordLink Configuration

As we don't have access to the eco server GUI, we will need to do the configuration via the DiscordLink config file. The config file is named "DiscordLink.eco" is generated inside the "Config" directory of the Eco Server after having started the server once with the mod loaded.

Sections

Sample Config

See this page for a text version of the sample config Sample Config

Bot Token

See the installation guide for instructions on how to get a bot token.
Once you have a bot token, copy the "BotToken" field in the sample config and paste your generated bot token.

Linking Channels

  1. Copy the "ChatChannelLinks" section of the sample config into your config file.
  2. Set "DiscordGuild" field to the name or ID of your Discord Server.
  3. Set the "DiscordChannel" field to the name or ID of the Discord channel you wish to synchronize with a channel in Eco.
  4. Set the "EcoChannel" field to the name of the Eco channel you wish to synchronize with the Discord channel in the previous step.
  5. Optional: Configure the three flags for Discord mention tag permissions according to your preference of allowing role, user and Channel mentions to be used from Eco.

Eco Status

  1. Copy the "EcoStatusDiscordChannels" section of the sample config into your config file.
  2. Set "DiscordGuild" field to the name or ID of your Discord Server.
  3. Set the "DiscordChannel" field to the name or ID of the Discord channel you want the status message to be posted in.
  4. Optional: Configure the usage flags according to your preferences.

Note: Only one message will be posted and that message will then be kept up to date by DiscordLink through frequent automatic edits.

Chat Log

To enable/disable logging of the chat, set the "Log Chat" option to true/false.
Optional: Select where the log should be stored by entering an absolute file path.
Keeping it in the mod directory is recommended in order to make sure the mod has permissions to write to files at the location and to keep it excluded from actions taken by the Eco server.

Command Settings

Discord Command Prefix
The prefix to put before commands in order for the Discord bot to recognize them as such.
In all command examples ? is used as Discord command prefix as this is the default prefix.
Eco commands always use / as command prexis as this is hard coded into the game client.

Eco Command Channel
The Eco chat channel to use for commands that outputs public messages, excluding the initial # character.

Invite Message
The message to use for the /DiscordInvite command. The invite link is fetched from the Network configuration (the Discord Address field in Network.eco) and will replace the [LINK] token. The message needs to include at least one [LINK] token in order to function and the Network configuration needs to have the Discord Address field filled out.

Server Details

All fields here are for display purposes only and will not impact the functionality of DiscordLink. The name, IP address and other fields here will be used for example in the Eco Status feature to show the users on Discord what the name and IP of the server is. Where possible, information from the Eco server configuration will be used here for fields that are not filled.