DiscordLink 2.0.1

The software has been successfully migrated, find more info here. Registrations are available again but parts of the migration are still ongoing.

Links Discord Channels to Eco channels, for near-seamless two-way communication, plus commands!

Notice: The original mod release can be found here. It has been updated and re-released due to issues with the migration from Eco-mods.com.

Introduction

This Eco Global Survival plugin connects Discord servers to the game server.

Features

  • Seamless Communication
    Connect your Eco chat to one or multiple Discord servers and channels for seamless and automated communication between Eco and Discord.
  • Live Eco Server Status Display
    Display live updates of online players, remaining time, your server logo and more in a Discord channel.
  • Chat logging
    Record the combined Discord and Eco chat in a chat log that persists between server restarts.
  • Assisted Configuration
    DiscordLink will run verification passes on your configuration upon startup and configuration changes and output the result in the server log, helping you diagnose configuration errors.
  • Helpful Commands
    DiscordLink features a number of helpful commands both from within the game and from Discord. /DiscordInvite will help you invite players ingame to your Discord server, while ?Trade will help you figure out who has the best deal on those yummy huckleberry muffins!

Usage

Eco <--> Discord Chat Synchronization

In order to synchronize the ingame chat with a Discord channel, you will need to set up a Discord bot and connect it to your Eco server via the DiscordLink config. See installation guide for information on how to do this.

Commands

From Discord:
  • ?Help - Lists available commands.
  • ?EcoStatus - Prints the status of the Eco Server.
  • ?Players - Displays the currently online players.
  • ?Trades [player or item name] - Lists all of the items sold by a player, or all of the shops that sell an item.
  • ?NextPage - Continues onto the next page of a trade listing.
  • ?DiscordInvite - Posts a message with the Discord invite code into the Eco chat.
  • ?Ping - Checks if the bot is online.
  • ?Echo [message] - Sends the provided message to Eco and back to Discord again.
From Eco:
  • /VerifyDiscord - Confirms the plugin is loaded.
  • /DiscordGuilds - Lists all servers that this bot is connected to.
  • /DiscordChannels [guildname] - Lists all channels in a specific server.
  • /DiscordDefaultChannel [guildname], [channelname] - Sets the channel that /discordmessage sends to for you and only you.
  • /DiscordMessage [message] - Sends a message to the default server and channel.
  • /DiscordSendToChannel [guildname], [channelname], [message] - Sends a message to a specific server and channel.
  • /DiscordInvite - Displays Discord invite message.

Notes:

  1. Emojis

    When sending Emojis from Discord to Eco, bear in mind that these may either be removed or show up ingame as a ? character. This means that some sentences may appear to be questions when read from within Eco if they end with an emoji. As an example; "We have trucks :D" may become "We have trucks ?" which may cause some confusion.

  2. Discord Mentions

    Make sure that @ or # is not the first character in your message when writing Discord mentions. Eco will consider them ingame mentions of players or channels and your message will open a chat channel ingame instead of being sent to the chat you intended and will therefore never get sent to Discord.

Installation

See the installation guide

Configuration

Server GUI

configuration guide for self hosted servers with access to the server GUI.

Config file

configuration guide for servers hosted by third parties, where you lack access to the server GUI.

Discord

Do you have suggestions, questions or maybe a problem you need help with? Join the Eco Community Discord server here! https://discord.gg/pCkWfzQ

DiscordLink has its own corner there where you can talk to other users and the developers!

Images

  • Version 2.0.1

    2.0.1

    Patch notes:

    --- Bugfixes & Improvements ---

    • Fixed a rare crash that could occur if the Eco Status display was enabled and the Eco server stalled for an extended period of time.


    2.0.0


    NOTE: This plugin version is not compatible with any Eco server version below 0.9.0.

    Patch notes:

    --- Additions ---

    • Support for Eco 9.0
      • WOHO!
    • Configuration Verification

      Upon startup and configuration changes, DiscordLink will now process your configuration to look for errors.

      The verification runs in two steps, one at the server start and one after all information from Discord has been received.

      Any detected errors will be sent to the server log and errors that can be fixed automatically will be resolved.

      The status of each channel link will be displayed at the end of the full verification pass.

      Configuration verification is also triggered by configuration changes made while the server is running.
    • DiscordInvite Command

      A new command for both Eco and Discord that displays a cofigurable message containing the invite link to the Discord server.

      Note that this command requires the Discord Address parameter from the Eco Network config to be set.
    • Discord mention/tagging support

      Use @NameOrRole or #ChannelName in Eco to tag users, roles or channels in Discord.

      Usage of the various types of mentions can be allowed or disallowed per channel link.
    • Live Eco Server Status Display

      A live updated and configurable display of the ?EcoStatus output can now be housed in a Discord channel.
    • Chatlog

      A chatlog that stores all messages sent in the linked channels.

      This feature is off by default and the path of the chatlog is configurable.

    --- Bugfixes & improvements ---

    • Fixed messages from Eco sometimes not being sent to Discord.
    • Discord guild(server) and channel names are no longer case sensitive.

    --- Notes ---

    • Changed Config Name

      The config name has changed to "DiscordLink.eco".

      This means that your current config file will no longer be recognized.

      As the content of the config file has changed to some extent, we recommend that you do not simply rename your existing configuration file, but rather fill out the new one.
    • Multiple DLLs

      DiscordLink has previously been distributed as a single .dll file.

      Due to underlying changes, we will now also distrubute the .dll files of our dependencies. DSharpPlus.dll and DSharplus.CommandsNext.dll should simply be left in the same folder as DiscordLink.dll

    --- Known Issues ---

    • The Live Server Status feature may cause crashes if other messages already exist in the Discord channel when the plugin starts

      #68
    • The description of EcoStatus in the server GUI claims that messages will get deleted. This is outdated information. DiscordLink never deletes any messages.
    • Chatlog will sometimes fail to write.

      #58