Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/looterz/wrangler

Unreal Engine 4 Dedicated Server manager built around Amazon Web Services.
https://github.com/looterz/wrangler

Last synced: about 1 month ago
JSON representation

Unreal Engine 4 Dedicated Server manager built around Amazon Web Services.

Awesome Lists containing this project

README

        

# wrangler
Unreal Engine 4 Dedicated Server manager built around Amazon Web Services.

## features
* Supports both steampipe and S3 for updating the server
* Automatic updates triggered from SNS notifications
* Automatic process monitoring and crash recovery
* Automatic server configuration via EC2 instance meta-data and tags

## config
The configuration file lives next to `wrangler.exe` and should be named `wrangler.toml`.

```toml
# The path to steamcmd
steamcmd = ""

# The absolute path to the servers root directory
server = ""

# The process name to monitor
process = ""

# Use Amazon S3 instead of steamcmd, requires that the instance have an assigned IAM role
UseS3Bucket = false

# The bucket name
S3Bucket = ""

# The bucket prefix (not working)
S3BucketPrefix = ""

# The absolute path of the folder to download the server to
S3Folder = ""

# Game folder name
GameFolder = ""

# Game Steam AppID
AppID = ""

# Default game server configuration file URL if none is provided, likely on an S3 Bucket
ServerConfig = ""
```

## tags
Wrangler reads and uses these tags when configuring itself and the server process.

* `Server_Branch` - The steampipe branch to pull updates from, if `live` it is ommitted and uses the default branch
* `Server_Name` - Game needs to be configured to parse this in `GameSession::RegisterServer`
* `Server_Map` - The map argument passed to the server during launch
* `Server_MaxPlayers` - The maximum amount of players argument passed to the server during launch
* `Server_Game` - The gamemode alias argument passed to the server during launch
* `SNS_TOPIC` - The SNS topic to subscribe to and listen for updates on

When the server process is launched, this is how the tags are used

```bat
Process.exe Server_Map?ServerName=Server_Name?MaxPlayers=Server_MaxPlayers?Game=Server_Game
```