-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
53 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2022 Retr0-01 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# CS:GO Discord Rich Presence | ||
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Retr0-01/CSGO-Discord-RP?sort=semver) | ||
![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/Retr0-01/CSGO-Discord-RP/latest/total?sort=semver) | ||
A Rich Presence application for showing custom status of your active Counter-Strike:Global Offensive game. | ||
|
||
- [CS:GO Discord Rich Presence](#csgo-discord-rich-presence) | ||
- [How It Works](#how-it-works) | ||
- [Install](#install) | ||
- [Credits](#credits) | ||
- [Licensing](#licensing) | ||
|
||
## How It Works | ||
This application uses the [Counter-Strike: Global Offensive Game State Integration](https://developer.valvesoftware.com/wiki/Counter-Strike:_Global_Offensive_Game_State_Integration) to fetch the data of your active game. It creates a local server (port 3000) which listens for the data and then applies it to your Discord client. | ||
|
||
## Install | ||
Go to the [latest release](https://github.com/Retr0-01/CSGO-Discord-RP/releases), download the ``CSGO-Discord-RP.zip`` file from the Assets section and then extract it to the location of your choosing. Now you should have the folder containing the application and a file called ``gamestate_integration_discord-rp.cfg``. | ||
Cut the cfg file and paste it inside the "cfg" folder of your CS:GO installation. | ||
For example ``C:\Program Files (x86)\Steam\steamapps\common\Counter-Strike Global Offensive\csgo\cfg`` is where I will have to put it. | ||
Once you have done that just open the folder containing the application and run the exe file. | ||
|
||
## Credits | ||
Huge thanks to the following devs/teams for creating some of the packages/tools used. | ||
- [Newtonsoft](https://www.newtonsoft.com/json) for Json.NET | ||
- [Lachee](https://github.com/Lachee/discord-rpc-csharp) for the C# implementation of the Discord RPC | ||
- [quicktype](https://quicktype.io/csharp) for instantly generating the needed C# models in order to use the JSON data | ||
|
||
## Licensing | ||
This repository is licensed under the MIT Licence. [Learn more.](https://github.com/Retr0-01/CSGO-Discord-RP/blob/main/LICENCE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters