Skip to content

Commit

Permalink
Updated documentation for Map and Layer displays
Browse files Browse the repository at this point in the history
  • Loading branch information
MonzUn committed Sep 13, 2024
1 parent 6eff548 commit e5e5765
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 1 deletion.
2 changes: 2 additions & 0 deletions ConfigTemplate/DiscordLink.eco.template
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
"WorkPartyDisplayChannels": [],
"ElectionDisplayChannels": [],
"CurrencyDisplayChannels": [],
"MapDisplayChannels": [],
"LayerDisplayChannels": [],
"SnippetInputChannels": [],
"UseLinkedAccountRole": true,
"UseDemographicRoles": true,
Expand Down
10 changes: 10 additions & 0 deletions ConfigurationNoGUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ The config data needs to match your Eco server, Discord server and Discord bot.
"DiscordChannelId": 980963363205025815
}
],
"MapDisplayChannels": [
{
"DiscordChannelId": 980963363205025815
}
],
"LayerDisplayChannels": [
{
"DiscordChannelId": 980963363205025815
}
],
"CurrencyDisplayChannels": [
{
"UseMintedCurrency": "MintedExists",
Expand Down
10 changes: 9 additions & 1 deletion Modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,20 @@

## Displays
A Discord Display makes persistent information in Eco visible in Discord.
It does this by regularly (once every ~60 seconds) 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.
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](images/features/displays/serverInfo.png)

### Map
Displays a link to the map preview image.
![Map Display](images/features/displays/map.png)

### Layer
Displays a link to a layer preview image.
![Map Display](images/features/displays/layer.png)

### Work Parties
Displays one message per work party, containing information about the status of that work party.
![Work Party Display](images/features/displays/workParty.png)
Expand Down
Binary file added images/features/displays/layer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/features/displays/map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e5e5765

Please sign in to comment.