Skip to content

Latest commit

 

History

History
125 lines (98 loc) · 5.18 KB

Modules.md

File metadata and controls

125 lines (98 loc) · 5.18 KB

Modules

Sections

Displays

A Discord Display makes persistent information in Eco visible in Discord.
It does this by regularly fetching information from the Eco server and sending/editing a message in Discord to keep the Display up to date. Some events in Eco will also update displays related to those events.

Server info

Displays a single message that contains customizable information about the server such as name, connection info, online players, settlements, ongoing elections and more.
Server Info Display

Map

Displays a link to the map preview image. Updates once an hour (same rate as the server updates the images)
Map Display

Layer

Displays a link to a layer preview image. Updates once an hour (same rate as the server updates the images)
Layer Display

Work Parties

Displays one message per work party, containing information about the status of that work party.
Work Party Display

Elections

Displays one message per election, containing information about the status of that election.
Note that in the case of a non-boolean election, only the highest ranked option will be listed for each player in the votes.
Election Display

Currencies

Displays one message per existing currency up to a configurable limit and ordered by the amount of trades made in the currency during the current cycle. For each currency, a configurable amount of users holding the highest amounts of the currency will be shown. Can be configured to only show minted or credit currencies based on the existance of a minted currency. Currency Display

Feeds

A Feed will output information from Eco into Discord (or vice versa) as it becomes available.

Chat

Sends Discord messages to Eco and vice versa. Can be configured to only feed messages one way.
Chat Feed

Player Status

Sends notifications when a player logs in/out or joins the server.
Chat Feed

Trade

Displays trade events in Discord as they occur in Eco.
Trade Feed

Server Log

Forwards Eco server log messages to Discord.
Server Log Feed

Server Status

Sends notifications when the server comes online or goes offline.
Server Status Feed

Crafting

Displays crafting events in Discord as they occur in Eco.
Crafting Feed

Watchers

A watcher is a personal feed or display that linked users can configure to display information in DMs with the bot.

Trade Feed

Works like the Trade Feed but the notifications are sent to the bot DM channel and the player can customize what should be shown. A Trade Feed Watcher is set up using the WatchTradeFeed command and can be customized to filter entries by Player, Tag, Item or Store.
Trade Watcher Feed

Trade Display

Works like a display for a DL-Trade command. A trade display is set up using the WatchTradeDisplay command and can be customized to filter entries by Player, Tag, Item or Store.

Roles

Roles can be set for linked users based on game data.

Account Link

Gives linked users a role in Discord to show that they have linked theur account.
Account Link Role

Demographics

Gives linked users roles matching their ingame demographics.
Demographic Role

Specializations

Gives linked users roles matching their ingame specializations.
Specialization Role

Elected Titles

Gives linked users roles matching their ingame elected titles.
Specialization Role

Inputs

An Input is a source of information in Eco or Discord that can be utilized in commands or other features.
Note: The range for how far in the Discord message history Input messages can be found is limited.

Snippets

Snippets are messages posted in Discord that can be reposted in Eco using the /Snippet command.

Syntax for Snippets in Discord:

[Snippet] [<SnippetName>]
<Snippet text>

Snippet input Discord
Snippet input Eco