# Introduction

Welcome to WindowsGSM Documentation - Powered by GitBook

![](/files/-Lw_OGN9UOA5RufVPvz-)

**WindowsGSM** - The best game server manager works on Windows platform, developed by <img src="/files/-Lw_WjgAH9EtZAooLIM_" alt="" data-size="line">[TatLead](https://github.com/BattlefieldDuck). WindowsGSM is inspired by another similar project by the name of [LinuxGSM](https://linuxgsm.com/), which is a command-line tool for quick and simple deployment and management of Linux dedicated game servers.

{% content-ref url="/pages/-LwKMuSfvgUMKfMdnZFY" %}
[Installation](/getting-started/installation)
{% endcontent-ref %}

{% content-ref url="/pages/-LwKpl\_pBvOxjS\_NGqEM" %}
[Supported Game Servers](/getting-started/supported-game-servers)
{% endcontent-ref %}

{% content-ref url="/pages/-M-HXoNN-T7h25Zpxyf4" %}
[Features](/getting-started/features)
{% endcontent-ref %}

## Why should I use this software?

As a gamer or developer, you can create your very own dedicated game server with our one-click install. All that is left to do is to enjoy your private server and start config for your game server, which are all easily accessible with our user-friendly GUI.

![WindowsGSM v1.19.0](/files/-M9o5FtzWMHTs31eB1r1)

## Discord

Join our Discord server - <https://discord.gg/bGc7t2R>


# Installation

Instruction of installation

## 1. Dependencies

1. **.NET Framework 4.7.2** (<https://dotnet.microsoft.com/download/dotnet-framework/net472>)

{% hint style="danger" %}
WindowsGSM may not be fully functional if .NET Framework 4.7.2 is not installed.
{% endhint %}

## 2. Installation

&#x20;  1\. Download the latest version here: (<https://windowsgsm.com/download/>)

&#x20;  2\. Drag and drop **WindowsGSM.exe** to a new directory

&#x20;  3\. Run **WindowsGSM.exe** 👍

{% hint style="success" %}
The game server files, log and installer will be auto-generated in the new directory.
{% endhint %}


# Supported Game Servers

| 🎮 Game Server                                                                            | Supported | Docs                                                                                              |
| ----------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------- |
| 7 Days to Die Dedicated Server                                                            | ✅         |                                                                                                   |
| ARK: Survival Evolved Dedicated Server                                                    | ✅         |                                                                                                   |
| Avorion Dedicated Server                                                                  | ✅         |                                                                                                   |
| Barotrauma Dedicated Server                                                               | ✅         |                                                                                                   |
| BlackWake Dedicated Server                                                                | ✅         |                                                                                                   |
| Conan Exiles Dedicated Server                                                             | ✅         |                                                                                                   |
| Counter-Strike: 1.6 Dedicated Server                                                      | ✅         |                                                                                                   |
| Counter-Strike: Condition Zero Dedicated Server                                           | ✅         |                                                                                                   |
| Counter-Strike: Global Offensive Dedicated Server                                         | ✅         |                                                                                                   |
| Counter-Strike: Source Dedicated Server                                                   | ✅         |                                                                                                   |
| Day of Defeat Dedicated Server                                                            | ✅         |                                                                                                   |
| Day of Defeat: Source Dedicated Server                                                    | ✅         |                                                                                                   |
| DayZ Dedicated Server                                                                     | ✅         |                                                                                                   |
| Deathmatch Classic Dedicated Server                                                       | ✅         |                                                                                                   |
| Eco Dedicated Server                                                                      | ✅         |                                                                                                   |
| Empyrion - Galactic Survival Dedicated Server                                             | ✅         |                                                                                                   |
| Garry's Mod Dedicated Server                                                              | ✅         |                                                                                                   |
| Grand Theft Auto V Dedicated Server ([FiveM](https://github.com/citizenfx/fivem))         | ✅         |                                                                                                   |
| Half-Life 2: Deathmatch Dedicated Server                                                  | ✅         |                                                                                                   |
| Half-Life: Opposing Force Dedicated Server                                                | ✅         |                                                                                                   |
| Heat Dedicated Server                                                                     | ✅         |                                                                                                   |
| Insurgency Dedicated Server                                                               | ✅         |                                                                                                   |
| Insurgency: Sandstorm Dedicated Server                                                    | ✅         |                                                                                                   |
| Left 4 Dead 2 Dedicated Server                                                            | ✅         |                                                                                                   |
| Minecraft: Bedrock Edition Server                                                         | ✅         |                                                                                                   |
| Minecraft: Java Edition Server                                                            | ✅         | [Link](https://docs.windowsgsm.com/getting-started/supported-game-servers/minecraft-java-edition) |
| Minecraft: Pocket Edition Server ([PocketMine-MP](https://github.com/pmmp/PocketMine-MP)) | ✅         |                                                                                                   |
| Mordhau Dedicated Server                                                                  | ✅         |                                                                                                   |
| No More Room in Hell Dedicated Server                                                     | ✅         |                                                                                                   |
| Onset Dedicated Server                                                                    | ✅         |                                                                                                   |
| Outlaws of the Old West Dedicated Server                                                  | ✅         |                                                                                                   |
| Post Scriptum Dedicated Server                                                            | ✅         |                                                                                                   |
| Reign Of Kings Dedicated Server                                                           | ✅         |                                                                                                   |
| Ricochet Dedicated Server                                                                 | ✅         |                                                                                                   |
| Risk of Rain 2 Dedicated Server                                                           | ✅         |                                                                                                   |
| Rust Dedicated Server                                                                     | ✅         |                                                                                                   |
| Space Engineers Dedicated Server                                                          | ✅         |                                                                                                   |
| Squad Dedicated Server                                                                    | ✅         |                                                                                                   |
| Stormworks Dedicated Server                                                               | ✅         |                                                                                                   |
| Team Fortress 2 Dedicated Server                                                          | ✅         | [Link](https://docs.windowsgsm.com/getting-started/supported-game-servers/team-fortress-2)        |
| Team Fortress Classic Dedicated Server                                                    | ✅         |                                                                                                   |
| The Forest Dedicated Server                                                               | ✅         |                                                                                                   |
| Unturned Dedicated Server                                                                 | ✅         |                                                                                                   |
| Zombie Panic Source Dedicated Server                                                      | ✅         |                                                                                                   |


# Minecraft: Java Edition

Estimated install time: 1 second

## How to make a Minecraft: Java Edition server?

{% hint style="warning" %}
You are required to indicate your agreement to EULA. (<https://account.mojang.com/documents/minecraft\\_eula>)
{% endhint %}

1. Run **WindowsGSM.exe**
2. Go to **Server** => **Install GameServer**
3. Select <img src="/files/-Lw_I1L1N-lZMCxN5ecB" alt="" data-size="line">**Minecraft: Java Edition server** in Game Server field
4. Click **INSTALL**
5. Click **Yes** to continue (Agreement to EULA)
6. Click **Yes** if you have not installed Java in your computer.
7. Wait and Done! :star\_struck:&#x20;

## Ready to start your server now!

1. Select your server
2. Click **START**
3. Done! :partying\_face:

{% hint style="info" %}
You are required to port forward to allow the server accessible on the internet.
{% endhint %}

## Need support?

Join our discord server (<https://discord.gg/bGc7t2R>)


# Team Fortress 2

Estimated install time: 8 minutes

## How to make a Team Fortress 2 Dedicated Server?

1. Run **WindowsGSM.exe**
2. Go to **Server** => **Install GameServer**
3. Select <img src="/files/-Lw_I1L4rz_yhYB4My0m" alt="" data-size="line">**Team Fortress 2 Dedicated Server** in Game Server field
4. Click **INSTALL**
5. Wait and Done! :star\_struck:&#x20;

## Ready to start your server now!

1. Select your server
2. Click **START**
3. Done! :partying\_face:


# WindowsGSM.cfg

A global server config file for WindowsGSM

WindowsGSM.cfg will be auto-created after the game server installed successfully. This config file stores the most common parameters like *IP*, *port*, *map*, *maxplayer,* etc. These values will be loaded as server start parameters. If you would like to add custom start parameters, see #additional-parameters below.&#x20;

## Basic server settings

| Key             | Notes                                                                                                                                                                             |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| servergame      | Do **NOT** edit this field                                                                                                                                                        |
| servername      | <p>Game server name - Set the hostname of the game server here. </p><p><strong><code>⚠️ Some servers use their own server config to set the hostname</code></strong></p>          |
| serverip        | <p>Game server IP - Set the start IP of the game server here.</p><p><strong><code>⚠️ Some servers use their own server config to set the IP</code></strong></p>                   |
| serverport      | <p>Game server Port - Set the start port of the game server here.</p><p><strong><code>⚠️ Some servers use their own server config to set the Port</code></strong></p>             |
| serverqueryport | <p>Game server Query Port - Set the query port of the game server here.</p><p><strong><code>⚠️ Some servers use their own server config to set the Query Port</code></strong></p> |
| servermap       | Game server map - Set the startup map of the game server here.                                                                                                                    |
| servermaxplayer | Game server maxplayer - Set the max player of the game server here.                                                                                                               |
| servergslt      | Game server GSLT token - Set the GSLT token of the game server                                                                                                                    |
| serverparam     | Additional parameters - Set the addition start param here                                                                                                                         |

## CPU Priority and Affinity

| Key         | Notes                                                    |
| ----------- | -------------------------------------------------------- |
| cpupriority | CPU Priority - Set the default priority for game process |
| cpuaffinity | CPU Affinity - Set the default affinity for game process |

## Automation

| Key            | Notes |
| -------------- | ----- |
| autorestart    |       |
| autostart      |       |
| autoupdate     |       |
| updateonstart  |       |
| backuponstart  |       |
| restartcrontab |       |
| crontabformat  |       |

## Discord Webhook Alert

| Key                 | Notes |
| ------------------- | ----- |
| discordalert        |       |
| discordmessage      |       |
| discordwebhook      |       |
| autostartalert      |       |
| autorestartalert    |       |
| autoupdatealert     |       |
| restartcrontabalert |       |
| crashalert          |       |

## Miscellaneous

| Key          | Notes |
| ------------ | ----- |
| embedconsole |       |

## Default WindowsGSM.cfg format

Sample of [Minecraft: Java Edition Server](/getting-started/supported-game-servers/minecraft-java-edition)'s WindowsGSM.cfg

```csharp
servergame="Minecraft: Java Edition Server"
servername="WindowsGSM - Server #1"
serverip="10.0.0.2"
serverport="25565"
serverqueryport="25565"
servermap="world"
servermaxplayer="20"
servergslt=""
serverparam="-Xmx1024M -Xms1024M"

cpupriority="2"
cpuaffinity="11111111"

autorestart="0"
autostart="0"
autoupdate="0"
updateonstart="0"
backuponstart="0"

discordalert="0"
discordmessage=""
discordwebhook=""

restartcrontab="0"
crontabformat="0 6 * * *"

embedconsole="0"

autostartalert="1"
autorestartalert="1"
autoupdatealert="1"
restartcrontabalert="1"
crashalert="1"

```


# Features


# SteamCMD