README.md

Progor-Chat

Progor-Chat is a custom discord and SWGEMU client that links the two platforms together. Like Core3 is an SWG Server emulator, Progor-Chat acts as an SWG Client emulator. It sends the same packets the client would to login and select a character, then ignores all the packets the server sends about the world around the character, and only listens for packets related to Chat. When it receives chats in the channel specified, it forwards the content of those messages to the Discord client to post in it's specified channel. It also does the reverse - listens for discord messages and posts them in the in-game chat channel.

Since it's constantly in communication with the game server, it knows quickly when the server goes down. It will then post a message to a separate channel (can be the same or different) and mention a discord role - usually your staff / admin role - to quickly notify someone who can get the server back up.

Getting Started

First, create a discord bot. Go to https://discordapp.com/developers, fill out the name of your bot/app, make it public, give it a profile photo if you want, and save it. You don't need OAuth2 or Redirect URIs. This will give you the name and token you need later.

Then, invite the bot to your server. Use this link: https://discordapp.com/oauth2/authorize?client_id=CLIENT_ID&scope=bot but replace the Client_ID with the Client ID from the bot you just created.

Then, create a new game account (or use an existing non-admin account with a free character slot), with a character whose name will be present on every message that comes from discord. Relics of Corbantis named ours Discord. Log into this character, and leave them at the end of the tutorial in the instanced room where you select a planet. This is the quietest place in the galaxy (fewer stray packets to deal with), and a great place for aspiring bots to hide out. Finally, have this bot join the chat room you wish for it to speak in, and log out of your game client. For now, any time the server is rebooted, you'll need to stop the bot, log back into the character long enough for the client to join the channel, log back out, and restart the bot. This issue should be fixed in an upcoming release. One further note about the bot: it should NOT be an admin. Admin characters have additional text added to their chats, so the bot can't pick out it's own messages and ends up reposting them to discord. If a feature is added which requires an admin, additional config will be put in place to solve this issue.

Download this repository to a folder. cd to that folder and run

npm install

to install the necessary dependencies (like the discord client).

Create a file named config.json with these values populated with your server, account, character, and chat room / channel specifics. You can copy config.example.json to get you started. For instance:

{
    "SWG": {
        "LoginAddress": "my.server.com",
        "LoginPort": 44453,
        "Username": "SWGAccount",
        "Password": "SWGPassword",
    },
    "Params": {
        "Character": "Discord",
        "ChatRooms": [
		"GalaxyChat",
		"Chat.RP"
	]
    },
    "Discord": {
	"BotNickname": "RoC Chat"
        "BotName": "RoC-Bot",
        "BotToken": "<Bot-token-from-discordapp.com/developers>",
        "ServerName": "SWG Awesomeness",
        "ChatChannel": "general",
        "NotificationChannel": "admin-lounge",
        "NotificationMentionRole": "Staff"
    }
}

Field	Explanation
SWG.LoginAddress	The Address of the SWGEmu login server. This is what you point your launcher at.
SWG.LoginPort	The Port of the SWGEmu login server. This is usually 44453
SWG.Username	The Username you type in the SWG splash screen.
SWG.Password	The Password you type in the SWG splash screen.
Params.Character	The Character you choose on the character select screen. First name only. Case matters.
Params.ChatRooms	The name(s) of the ChatRoom(s) it should replicate to/from. If nested in the tree, use dots, i.e. Chat.General.Main
Discord.BotNickname	The bot's nickname (minus the active channel)
Discord.BotName	The App Name of the Bot you created in discordapp.com/developers
Discord.BotToken	The App Bot User Token from the discordapp Bot page
Discord.ServerName	The name of the discord server the Bot is monitoring
Discord.ChatChannel	The name of the discord channel the Bot should replicate to/from
Discord.NotificationChannel	The name of the discord channel that server up/down events should be posted to
Discord.NotificationMentionRole	The name of the role that should be mentioned in up/down notifications

Finally run the bot with

node discordbot.js

Better yet, to handle any unexpected errors get forever

npm install -g forever

and run it with

forever start discordbot.js

Any issues? Add an Issue in github and I'll take a look as soon as I can.