Deploy on Windows

This tutorial will have you deploying discordgsm on Windows OS.

This guide is only for users who insist on self-hosting the discordgsm bot. Don't even try if you do not have any IT skills because it is time wasting and may make yourself unhappy. Use the public bot instead: Add to Server

Requirements

Before deployment, you need to prepare the following items.

Python 3.8+
Git (https://gitforwindows.org/)

Get Started

This tutorial will have you deploying discordgsm on Windows OS.

1. Create a new directory

The following commands will change directory to Documents and creates a folder call DiscordGSM.

cd %USERPROFILE%/Documents
mkdir DiscordGSM & cd DiscordGSM

2. Clone the repository

Clone GameServerMonitor repository by the following command.

git clone https://github.com/DiscordGSM/GameServerMonitor
cd GameServerMonitor
git checkout tags/$(git describe --tags)

or download manually: Here

3. Create a Virtual Python Environment

The following commands will create a new virtual environment.

python -m venv venv

4. Activate the Environment

Now that we have a virtual environment, we need to activate it.

venv\Scripts\activate.bat

After you activate the environment, your command prompt will be modified to reflect the change.

5. Install Python dependencies and packages

The following commands will download the necessary dependencies and packages.

python -m pip install -r requirements.txt

6. Configure the environment variables

Copy .env.example to .env

copy .env.example .env

Edit .env with your favourite editor. Learn more: Guide: Environment Variables

notepad .env

7. Add the bot to your server

The following commands will start the discord bot.

python main.py

View the console output and click the bot invite link to add the bot to your server.

8. Congratulations! 🎉

DiscordGSM has deployed. If you wish to install discordgsm as Windows Service, please continue.

Create a Windows Service

This tutorial will have you deploying discordgsm on Windows OS.

1. Run the cmd.exe as an Administrator

Run the cmd.exe as an Administrator, and change to the GameServerMonitor directory.

cd %USERPROFILE%/Documents/DiscordGSM/GameServerMonitor

2. Activate the Environment

The following commands will activate the virtual environment.

venv\Scripts\activate.bat

3. Install the service

The following commands will install the service.

python service.py --startup auto install

4. Start the service

The following commands will start the service.

python service.py start

5. Congratulations! 🎉

DiscordGSM has deployed as Windows Service.

Update

This tutorial will update the application to the latest release version.

1. Activate the Environment

The following commands will change the directory to GameServerMonitor and activate the environment.

cd %USERPROFILE%/Documents/DiscordGSM/GameServerMonitor
venv\Scripts\activate.bat

2. Pull the repository

The following commands will pull the latest version.

git checkout tags/$(git describe --tags)

3. Install Python dependencies and packages

The following commands will download and update the necessary dependencies and packages.

python -m pip install -r requirements.txt

4. Restart the service (Optional)

The following commands will restart the service. Run this if you had created as Windows Service.

python service.py restart

5. Congratulations! 🎉

DiscordGSM has updated.

Deploy on Windows

Got any questions or feedback? Join our Discord Server.