DotA 2 RPC (dota2-rpc-client)

Allows you to observe the status of your DotA 2 (Defense of the Ancients 2) match within the Discord, through the Rich Presence service.

You can access the project website by clicking here.

What is?

This is a service that allows you to show your Discord friends information about the matches you play and watch within DotA 2.

Share real-time information about what happens in your game with everyone.

Features

Feature	Preview
Check what your friends are watching.
Show off your heroes with your favorite skins.
Show your skills of accumulating money in the game
Show your items and your buffs.
Modified map support.
See your instructors.
Multiple language support.

Instructions

Windows

Installation

Follow the step-by-step below to install your version of DotA 2 RPC

• Download the latest software version on the Releases page;
• Unzip the file in a folder of your preference. (There are many files, then be careful!🙃);
• Open the file install-windows.bat and everything will be ready!

Uninstallation

• Open the uninstall-windows.bat file to remove the installation of your computer;
• If you want, you can delete all the files.

Additional Commands

This software is registered as Windows service. If you are looking for other options, here are other ways to use the application.

dota2-rpc-client.exe <flag>

Flag	Description
-i	Install the DotA 2 RPC as a service.
-r	Uninstall the service, if installed.
-s	If installed, start the service.
-e	If installed, stop the service.
-f	Execute the DotA 2 RPC like a Console Application.

Linux

Installation

Follow the step-by-step below to install DotA 2 RPC as a systemd user service:

• Download the latest software version on the Releases page;
• Unzip the file in a folder of your preference. (There are many files, then be careful!🙃);
• Navigate to the extracted folder in terminal and execute:

chmod +x install-service.sh
./install-service.sh

Uninstallation

• To remove the service:

./uninstall-service.sh

• You will be prompted whether to keep or remove the application data.

Additional Commands

Once installed, you can manage the service with these commands:

# View service status
systemctl --user status dota2-rpc-client.service

# View logs in real-time
journalctl --user -u dota2-rpc-client.service -f

# Stop the service
systemctl --user stop dota2-rpc-client.service

# Start the service
systemctl --user start dota2-rpc-client.service

# Restart the service
systemctl --user restart dota2-rpc-client.service

Settings

You can choose what can be displayed and other application settings.

Just modify the config.json file.

{
    "HOST": "127.0.0.1",
    "PORT" : 52424,
    "LOCALE" : "System",
    "DISPLAY_OPTIONS":
    {
        "AEGIS" : true,
        "AGHANIM" : true,
        "GOLD_AND_LAST_HIT": true,
        "KILL_DEATH_ASSIST" : true,
        "SMOKE": true
    },
    "STEAM_FOLDER": ""
}

Below is a brief description of each property.

Property	Description
HOST	The url the application will use. (Default: 127.0.0.1)
PORT	The port the application will listen on. (Default: 52424)
LOCALE	Language used. (Default: System, Avaiable options : LocaleString, System and Discord )
DISPLAY_OPTIONS	Discord display options.
DISPLAY_OPTIONS:AEGIS	Whether or not to display the Aegis effect (Default: true)
DISPLAY_OPTIONS:AGHANIM	Whether or not to display the Aghanim effect (Default: true)
DISPLAY_OPTIONS:GOLD_AND_LAST_HIT	Whether or not to display the Gold, last hits and denies (Default: true)
DISPLAY_OPTIONS:KILL_DEATH_ASSIST	Whether or not to display the K/D/A (Default: true)
DISPLAY_OPTIONS:SMOKE	Whether or not to display the smoke effect (Default: true)
STEAM_FOLDER	Steam folder location (Optional, default: Default folder commonly used by steam)

If you installed the cfg file manually, when changing the host and port you will need to change them also in the gamestate_integration_rpc.cfg file. See this issue #1.

Compilation Instructions

Want to improve the project or compile a version outside the official channel?

See the Contribution Section to read more instructions or clone this repository.

This project mainly uses 4 libraries to work. Are they:

• Discord SDK - A Library for Integration with the Discord application;
• Drogon C++ - A web framework written with C++;
• SrvLib - A library for creating services in Windows and Linux created by @tomenz.
• NFD - A small C library with that portably invokes native file open, folder select and file save dialogs. Created by @btzy and @mlabbe.

This is a project made with CMake. Some libraries are managed as Git submodules in the third_party folder, while others are downloaded via Conan package manager.

Building the project

After cloning the repository, initialize and update the Git submodules:

git submodule update --init --recursive

Then, configure the project:

cmake -S . -B ./build -DCMAKE_BUILD_TYPE=Debug

Then build it:

 cmake --build {folder} --config Debug --target dota2-rpc-client -j {threads}

This project uses Conan Package Manager to download some dependencies. The Conan provider is automatically downloaded via CMake on the first build.

If you prefer to use a different package manager like vcpkg or manage libs and dlls externally, feel free to modify CMakeLists.txt.

Web Page Compilation Instructions

Would you like to change the project webpage? You can access the files from the web directory.

The following frameworks and templates were used:

• Angular 13 - A component-based framework for building scalable web applications;
• Paradigm Shift - A open-source web template created by @ajlkn

Instead of using static pages, a framework was used to create the site. So to compile, follow the instructions available here.

With everything configured, use the command below to run:

 ng serve

Language Contribution

Would you like to translate the app into your language? Create a translation file based on the en-us.json file. Then create an issue or a pull request to submit your modification.

Issues

Feel free to submit issues and enhancement requests.

Contribution

1. Fork the project
2. Create a branch for your modification (git checkout -b my-new-resource)
3. Do the commit (git commit -am 'Adding a new resource...')
4. Push (git push origin my-new-resource)
5. Create a new Pull Request

Notes

Images, names, and any entities related to DotA 2 are copyrighted by Valve Corporation. This software only uses the data shared by the game, but it is not related to the original game.