firecatmusic / CSGO---Discord-RichPresence

Display CSGO information as rich presence in discord.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CS:GO - Discord Rich Presence

Display CSGO information as rich presence in discord.

Preview album

Features

Installation

  1. Install NodeJS
  2. Clone this repository into a folder
  3. Open a command prompt inside the folder and enter npm install
  4. Rename config.json.example to config.json and adjust it - Read More
  5. Move gamestate_integration_discord.cfg into your <Steam>\steamapps\common\Counter-Strike Global Offensive\csgo\cfg folder and restart csgo, if opened
  6. Go back to the command prompt we opened earlier and enter node index to start the process (You will always need to repeat this last step unless you use PM2 for Auto-Starting)

Start the process and leave it running! When you close it the rich presence will disappear.

Config

  • clientId: A string representing the client ID of your Discord Application (Use the default value to use mine, I will try to keep it up-to-date. It is the easiest option)
  • steamWebAPIKey: A string with your Steam Web API Key from here
  • serverPort: A number with the port the local server is running on - Needs to match the port in gamestate_integration_discord.cfg (You can just leave this default)
  • authToken: A string with your auth token from gamestate_integration_discord.cfg (You can just leave this default)
  • processCheckDelay: A number representing the interval in milliseconds between checking if CSGO is running or not (You can just leave this default)
  • teamSmallImage: A boolean value whether or not you want to display a team image or a gamemode image (You can just leave this default)

PM2 - Autostart

  1. Open a command prompt inside the folder from the installation
  2. Install pm2 with npm install pm2@latest -g
  3. Install pm2-windows-startup with npm install pm2-windows-startup -g
  4. Enter pm2-startup install to set up the autostart
  5. Enter pm2 start index.js --name "CSGO RichPresence"
  6. Enter pm2 save
  7. Everytime your OS starts up the process will run in the background and automatically display when needed.

Lobby Info

The API Key in the config is required for us to request the current lobby you are in. (This only works if the API Key is your own API key or your profile and game-details are both public. The lobby also needs to be set to Friends Can Join.)

If you are in a lobby others can join you via Discord. This is heavily restricted because of Discord and CSGO (Because this isn't the real CSGO process). Others can only join you if they already have CSGO open and running with the same application (This one) otherwise it will just show that Discord did not detect the game.

UPDATE: With the new Looking to Play lobby update that CSGO has implemented, anyone wanting to join you also now has to be friends with the account you are currently playing on otherwise lobby joining will fail due to the way the update works.

Custom Discord application

You do not have to do this unless you want your own images

  1. Create an application on Discord
  2. Go to Rich Presence > Art Assets and upload all images you want.
  3. Replace the client ID from the config.json with the one you have in General Information on the website

Notes:

  • Maps are called exactly what they are called ingame. cs_office ingame is cs_office in the assets list. Workshop maps are workshop_<ID>_<mapname>, replace every character which is not A-Z or 0-9 with an underscore and you will be good to go. You can us this website to see how you have to name your file.
  • Gamemodes use their game-internal name such as competitive, scrimpcomp2v2, survival, etc.
  • Main Menu uses the menu asset
  • Unknown Maps and Modes use the random asset
  • The default asset is used when the client is in the main menu and when we are in a unknown gamemode
  • The assets folder are the images I use in my application. They are directly taken from the game files.
  • Changing assets will require you to reboot the script (If you are using pm2 just run pm2 restart "CSGO RichPresence")

About

Display CSGO information as rich presence in discord.

License:GNU Affero General Public License v3.0


Languages

Language:JavaScript 100.0%