Dishorde - 7 Days to Die Discord Integration

Dishorde is a Discord bridge bot for 7 Days to Die. It integrates a dedicated game server's chat with Discord, granting players access to the server's chat through Discord.

Dishorde runs as a completely separate application, so no mods are required to run it.

See below for download links instructions on how to install the bot. Dedicated servers on PC only.

How it Works

Dishorde works by connecting to your server's console and monitoring it for chat messages. Messages are relayed to and from the server using Discord, allowing for communication between in-game players and Discord users.

Development and Support

For support, questions, and comments, you can join the Discord server, or submit an issue for bugs and support.

For developers: If you are interested in helping out, GitHub pull requests are welcome and greatly appreciated.

For business inquiries, contact: [email protected]

Commands

Commands can be sent via DM or in the specified chat channel.

7d!info 7d!time 7d!version 7d!players

Terminal Commands

exit

Configuration

The bot can be configured by editing config.json. Here's a list of the preferences:

• allow-exec-command - Enables a command called 7d!exec. This allows anybody with the 'manage server' permission to execute commands on the server. The command works in any channel. WARNING: Enabling this may pose a security risk for your server.

• allow-multiple-instances - By default, the bot will not start if there is another copy of it already running. Enabling this will allow multiple instances of the bot to run on one system.

• allow-links-from-game - Allows players in-game to post links into Discord. When set to false, links will still show up, but will not be clickable. When enabled, links may include embeds in Discord unless you configure the bot's permissions otherwise.

• disable-commands - Disable Discord commands such as 7d!time. Does not disable 7d!info.

• disable-chatmsgs - Disable chat messages to and from the server. Does not disable other in-game messages such as join/leave and deaths.

• disable-join-leave-gmsgs - Disables player join/leave messages.

• disable-misc-gmsgs - Disables all other global messages (player deaths, etc.)

• disable-non-player-chatmsgs - Disables chat messages sent by non-players. (Including the "say" console command and mods)

• disable-status-updates - Disable the bot's presence and online status display.

• hide-prefix - Hides all chat messages that start with a forward slash. This may be useful if your server uses commands.

• log-console - Enables logging of the bot's console to a file, console.log.

• log-messages - Chat messages will show up in the terminal.

• log-telnet - All output from the connection will show up in the terminal.

• prefix - The prefix for bot commands. ('7d!' by default)

• skip-discord-auth - The bot will not log in to Discord.

How to Install - Windows

Creating the bot account

1. Log in to the Discord Developer Portal in a browser and click "Create an application". Name the bot anything you'd like. Write down the application ID as you'll need it for later.
2. On the left hand side, click "Bot". Now click the "Add Bot" button to create your bot. Once created, you can set an avatar for your bot if desired.
3. Under "Privileged Gateway Intents", locate the "Message Content Intent" switch and turn this on. Important! If you do not turn this on, the bot will not be able to see your messages or commands.
4. Under "Authorization Flow", locate the "Public Bot" switch and turn this off. Important! If you do not turn this off, anyone can create a link to invite your server's bot to their own server.
5. Click "Save Changes" to confirm.
6. Back towards the top, click the "Reset Token" button and reset the token. When done, the button will be replaced by a long set of letters and numbers. This is your bot's 'token'--like a password for your bot's account. You'll need both this and the Client ID number later. Copy them both somewhere safe or keep the tab open. Note! Once you close the page, you will not be able to retrieve your bot's token without resetting it.
7. Copy the URL below into your browser and replace "APP_ID" with your application ID number. Hit enter and select the desired Discord server. Once this is done, the bot will show up in your server!

https://discord.com/oauth2/authorize?client_id=APP_ID&scope=bot

Setting up the bot

1. Download this repository and extract it somewhere on your server's system.
2. Install Node.js LTS from this website.
3. Once Node.js is finished installing, run install.bat in the bot's folder. This will automatically install the required modules for the bot.
4. Now you'll need to edit your server's config xml file. If you're using the Steam dedicated server, it should be located in C:\Program Files (x86)\Steam\steamapps\common\7 Days to Die Dedicated Server.
5. Open serverconfig.xml in a text editor (Right click and select 'Edit' to open it in Nodepad) and find "TelnetEnabled". Set it to true. Make sure TelnetPort is 8081 (or use the "port" argument in config.json). Set a telnet password.
6. Rename the config.json.example file to config.json. Right click this file and click "Edit".
7. Find "changeme" and replace it with your server's Telnet password. Replace "your_token_here" with the Discord token from earlier. If running the bot on a different network from the server, add --ip=[your server's external ip] (May require port forwarding if using an external IP. Make sure your Telnet password is secure.)

Run the bot!

Once you complete all of this, you will be able to run the bot by opening run.bat. If you've done all of this correctly, you will see the following in the terminal: Connected to game. Connected to 1 Discord Servers.

To set the channel for your server's chat, open Discord and type 7d!setchannel #yourchannel in your server. If the setchannel command doesn't work, try setting it manually. Once complete, the bot should be all set!

Note that if you close this terminal the bot will be disconnected. The bot can be run in the background with no terminal by opening run_silent.vbs.

You may want to create a shortcut to run.bat or run_silent.vbs in your Startup folder:

C:\Users\[YOURNAME]\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup

How to Install - Linux

Setting up the bot

1. Open a terminal on your system.
2. Install Node.js and NPM. Install build tools if instructed. [How to install via package manager]. Skip this step if installing to a Raspberry Pi device.
3. Type curl -L https://github.com/LakeYS/Dishorde/releases/download/v2.2.0/Dishorde.tar.gz > 7dtdbot.tar.gz to download the bot's files to an archive named 7dtdbot.tar.gz.
4. Type tar -xzf 7dtdbot.tar.gz to extract the archive. This will create a directory named "7DTD-Discord-master". Navigate to the directory with cd 7DTD-Discord-master.
5. Type sudo chmod +x run.sh. This gives you permission to execute run.sh. (If this does not work, try chmod +x run.sh)
6. Type npm install to install the required packages for the bot to run.

Creating the bot account

1. Log in to the Discord Developer Portal in a browser and click "Create an application". Name the bot anything you'd like. Write down the application ID as you'll need it for later.
2. On the left hand side, click "Bot". Now click the "Add Bot" button to create your bot. Once created, you can set an avatar for your bot if desired.
3. Under "Privileged Gateway Intents", locate the "Message Content Intent" switch and turn this on. Important! If you do not turn this on, the bot will not be able to see your messages or commands.
4. Under "Authorization Flow", locate the "Public Bot" switch and turn this off. Important! If you do not turn this off, anyone can create a link to invite your server's bot to their own server.
5. Click "Save Changes" to confirm.
6. Back towards the top, click the "Reset Token" button and reset the token. When done, the button will be replaced by a long set of letters and numbers. This is your bot's 'token'--like a password for your bot's account. You'll need both this and the Client ID number later. Copy them both somewhere safe or keep the tab open. Note! Once you close the page, you will not be able to retrieve your bot's token without resetting it.
7. Copy the URL below into your browser and replace "APP_ID" with your application ID number. Hit enter and select the desired Discord server. Once this is done, the bot will show up in your server!

https://discord.com/oauth2/authorize?client_id=APP_ID&scope=bot

Configuring the bot

1. On your server's system, navigate to the game's directory and edit your the config xml file.
2. Find "TelnetEnabled" and make sure it is set to "true". Set a telnet password and save the file. Make sure your telnet password is secure , especially if the telnet port is open or the server is running on a VPS.
3. Now navigate back to the bot's folder. Rename config.example.json to config.json and open this file in a text editor.
4. Find the line containing "password": "changeme", and replace "changeme" with your server's telnet password.
5. If running the bot on a different network from the server, change "localhost" to your server's external IP. (If using an external IP to connect the bot, forwarding the telnet port may be required)
6. Replace "your_token_here" with the Discord bot token from earlier. Keep the file open for the next section.

Run the bot!

Once you complete all of this, you will be able to run the bot by executing run.sh (Navigate to the bot's directory and enter ./run.sh). If you've done all of this correctly, you will see the following: Connected to game. Connected to 1 Discord Servers.

To set the channel for your server's chat, open Discord and type 7d!setchannel #yourchannel in your server. If the setchannel command doesn't work, try setting it manually. Once complete, the bot should be all set!