https://github.com/gesslar/mud-discord-chat
https://github.com/gesslar/mud-discord-chat
chat discord lpc mud nodejs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/gesslar/mud-discord-chat
- Owner: gesslar
- License: unlicense
- Created: 2021-05-18T14:17:26.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T06:33:09.000Z (over 1 year ago)
- Last Synced: 2025-03-24T22:43:17.355Z (about 1 year ago)
- Topics: chat, discord, lpc, mud, nodejs
- Language: JavaScript
- Homepage:
- Size: 118 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# mud-discord-chat
This application connects to a socket on a MUD to send/receive data between, allowing for channels to communicate from the MUD to Discord and back.
## Setup
### Step 1
1. Visit the [Developer's portal](https://discordapp.com/developers/applications/) and create a new application. Record the Client ID, you will need it for the next bit
2. Click Bot on the left
3. Click Reset Token and record the Token for later use
4. Under Privileged Gateway Intents, enable `Server Members Intent` and `Mesage Content Intent`
5. Visit https://discordapp.com/oauth2/authorize?client_id=XXXXXXXXXXXXXXXXXX&scope=bot where XXXXXXXXXXXXXXXXXX is your Client ID from #1 above
6. Authorize and add your bot to your server
### Step 2
Get the ID for the channel you wish to post to by right-clicking on the channel and clicking Copy ID
### Step 3
Create a `.env` file in the root of the Node.js directory to house the following variables
```
DISCORD_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
If you opt into bit.ly integration, you will need to add your token to your `.env` file as well.
```
BITLY_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
### Step 4
Copy `config.json.example` to `config.json` and modify the values to suit your Discord/MUD.
#### Example
```json
{
"mud_name" : "ThresholdRPG",
"mud_ip" : "127.0.0.1",
"mud_port": 8181,
"channels" : [
{ "discord" : "783942759576371200", "mud" : "trivia" },
{ "discord" : "844254742989373450", "mud" : "heritage" },
{ "discord" : "844254814518247444", "mud" : "question" }
],
"strip_emoji" : true,
"enable_bitly" : false
}
```
`channels` is an array of objects with the Discord channel ID and the mud channel name.
`mud-discord-chat` sends and receives a JSON object in the form of:
```json
{
"channel" : "String",
"name" : "String",
"message" : "String"
}
```
Where `channel` is the mud channel name, `name` is the name of the user/player, and `message` is the chat message.