From a47978d1bbe77e97a445e1abc97da38dcfbf0e88 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 7 Jun 2021 20:32:22 -0400 Subject: [PATCH] Add a note about launching the server console --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a4e638173c..215ec3a83f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ If you wish to install the TGS as a service, run `Tgstation.Server.Host.Service. Should you want a clean start, be sure to first uninstall the service by running `Tgstation.Server.Host.Service.exe -u` from the command line. +If using the console version, run ./tgs.bat in the root of the installation directory. + #### Linux (Native) We recommend using Docker for Linux installations, see below. The content of this parent section may be skipped if you choose to do so. @@ -44,6 +46,8 @@ The following dependencies are required to run tgstation-server on Linux alongsi - gdb (for using gcore to create core dumps) - gcc-multilib (Only on 64-bit systems) +To launch the server, run ./tgs.sh in the root of the installation directory. The process will run in a blocking fashion. SIQQUIT will close the server, terminating all live game instances. + Note that tgstation-server has only ever been tested on Linux via it's [docker environment](build/Dockerfile#L22). If you are having trouble with something in a native installation, or figure out a required workaround, please contact project maintainers so this documentation may be better updated. #### Docker (Linux)