https://github.com/gloryofnight/unrealrcon
Unreal Engine plugin implementing Source RCON protocol
https://github.com/gloryofnight/unrealrcon
cxx20 rcon-client rcon-protocol rcon-server source-rcon ue5 ue5-plugin unreal-engine-5
Last synced: about 2 months ago
JSON representation
Unreal Engine plugin implementing Source RCON protocol
- Host: GitHub
- URL: https://github.com/gloryofnight/unrealrcon
- Owner: GloryOfNight
- License: apache-2.0
- Created: 2025-06-19T18:06:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-23T11:42:13.000Z (8 months ago)
- Last Synced: 2025-12-25T00:30:34.665Z (8 months ago)
- Topics: cxx20, rcon-client, rcon-protocol, rcon-server, source-rcon, ue5, ue5-plugin, unreal-engine-5
- Language: C++
- Homepage:
- Size: 65.4 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# UnrealRCON
UnrealRCON is a **RCON (Remote Console)** plugin for **Unreal Engine**, designed for servers to remotely receive and handle commands.
## 🔧 Features
- ✅ RCON server protocol implementation
- 🎮 Built to integrate directly into Unreal Engine project as a plugin
- 🔁 Easy integration and use
- 🧪 Simple enought to tailor for your specific needs
## 🚀 Getting Started
### Installation
1. Download source from latest [releases](https://github.com/GloryOfNight/UnrealRCON/releases)
2. Unpack source code to Plugins/UnrealRCON folder
3. Regenerate and launch project, make sure UnrealRCON enabled in Plugins
> [!WARNING]
> DO NOT download source code from main branch since it could be unstable at times. Only do that from tags or releases page!
## RCON client
### Usage
You can use any external Source RCON compatible client, for example [ARRCON](https://github.com/radj307/ARRCON) or [rcon-cli](https://github.com/gorcon/rcon-cli)
This plugin also provides build-in RCON client, using console and API
```
rcon.client.connect # if argument not provided, it takes default argument from settings
rcon.client.exec # send execute command to connected server
rcon.client.disconnect # disconnects from server
```
for the API calls, look into:
```
URConClientSubsystem::Get(this)->Connect(HostAddr,Port, Password);
URConClientSubsystem::Get(this)->IsConnected();
URConClientSubsystem::Get(this)->Disconnect();
int32 RequestId = URConClientSubsystem::Get(this)->SendCommand(InCommand);
AddRequestCallback(RequestId, Callback);
```
## RCON server
### Usage
for testing purposes, server supports console commands:
```
rcon.server.start # allows you locally start rcon server to test functionality
rcon.server.stop # stop rcon server
```
for the API calls, look into:
```
URConServerSubsystem::Get(this)->StartServer();
URConServerSubsystem::Get(this)->IsStarted();
URConServerSubsystem::Get(this)->SendCommandResponse(RequestId, Response);
URConServerSubsystem::Get(this)->StopServer();
URConServerSubsystem::Get(this)->AddCommand(InCommand, InCallback, InTooltip, InProperties);
URConServerSubsystem::Get(this)->AddCommand(InCommandHandle);
URConServerSubsystem::Get(this)->FindCommandHandle(Command);
```
### Startup options
`-RConEnable` auto-start rcon server on startup (if subsystem created)
`-RConPort=27015` set rcon server port. In case of forked server, port + fork id would be used for that fork
`-RConPassoword=1111` set rcon server password
`-RConMaxActiveConnections=5` set maximum amount of active connections
### Config
`DefaultGame.ini`
```
[/Script/RConServer.RConSettings]
Port=27015 # Note: Commandline argument has a priority over config
Password=1111 # Note: Commandline argument has a priority over config
MaxActiveConnections=5 # Note: Commandline argument has a priority over config
bAllowInEditorBuild=True # Allow launching rcon server in editor
bAllowInGameBuild=False # Allow launching rcon server in game (non-shipping) build
bAllowInServerBuild=True
bAllowInServerShippingBuild=True
bAutoStart=False # Note: if true, -RConEnable not required to auto-start rcon server
```
### Default commands
`help` List all available commands
`exec` Execute unreal engine console command
### Adding custom commands
(C++ only)
> [!TIP]
> Create new [Game Instance Subsystem](https://dev.epicgames.com/documentation/en-us/unreal-engine/programming-subsystems-in-unreal-engine) class to handle custom rcon commands code.
1. Open your project .build.cs file
and apply `RConServer` to module dependecies list, just like that:
```
PublicDependencyModuleNames.AddRange(new string[] { "RConServer" });
```
2. In your codebase, add include
```
#include "RConServerSubsystem.h"
```
3. Start implementing
```
URConServerSubsystem* RConServerSubsystem = URConServerSubsystem::Get(this);
if (RConServerSubsystem)
{
// Preferably you want bind calls to UObjects not lambda's (FDelegate::CreateUObject)
const auto CommandCallbackLam = [this](int32 RequestId, const FString& Command, FString& Response, bool& bDelayResponse)
{
Reponse.Append(TEXT("Listing players:"));
for (const auto& Player : PlayerList}
Reponse.Append(FString::Printf(TEXT(\n%s (%s)), *Player->Nickname, *Player->Id));
};
// Adding commands handles is easy
RConServerSubsystem->AddCommand(TEXT("list players"), FRConServerCommandCallback::CreateWeakLambda(this, CommandCallbackLam), TEXT("List current players"));
}
```