100 lines
1.9 KiB
Markdown
100 lines
1.9 KiB
Markdown
# What is Garry's Mod?
|
|
|
|
Garry's Mod is a physics sandbox. There aren't any predefined aims or goals. We give you the tools and leave you to play.
|
|
|
|
# Quick Start
|
|
|
|
## Basic
|
|
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
hackebein/garrysmod
|
|
```
|
|
|
|
## Enable API
|
|
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
-e "AUTHKEY=..." \
|
|
hackebein/garrysmod
|
|
```
|
|
Get your [AUTHKEY](http://steamcommunity.com/dev/apikey)
|
|
|
|
## Public
|
|
If you have activated the API, this step happens automatically.
|
|
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
-e "GLST=..." \
|
|
hackebein/garrysmod
|
|
```
|
|
|
|
Get your [GLST](http://steamcommunity.com/dev/managegameservers) (`APPID: 4000`)
|
|
|
|
## Workshop Collection
|
|
Workshop access requires the API.
|
|
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
-e "AUTHKEY=..." \
|
|
-e "WORKSHOPCOLLECTIONID=..." \
|
|
hackebein/garrysmod
|
|
```
|
|
|
|
## Config
|
|
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
-v ./server.cfg:/opt/garrysmod/garrysmod/cfg/server.cfg \
|
|
hackebein/garrysmod
|
|
```
|
|
|
|
## Example for TTT
|
|
```
|
|
docker run \
|
|
--expose 27015 \
|
|
-e "AUTHKEY=..." \
|
|
-e "GAMEMODE=terrortown" \
|
|
-e "MAP=ttt_minecraft_b5" \
|
|
-e "WORKSHOPCOLLECTIONID=843519054" \
|
|
-v ./server.cfg:/opt/garrysmod/garrysmod/cfg/server.cfg \
|
|
hackebein/garrysmod
|
|
```
|
|
|
|
Go to [Workshopp Collection](https://steamcommunity.com/sharedfiles/filedetails/?id=843519054)
|
|
|
|
## Additional Environment
|
|
|
|
PORT: Connection Port
|
|
(`Default: 27015`)
|
|
|
|
TICKRATE: Tickrate of server, **Attention:** Change not recommended
|
|
(`Default: 66`)
|
|
|
|
CLIENTPORT:
|
|
(`Default: 27005`)
|
|
|
|
GAMEMODE:
|
|
(`Default: sandbox`)
|
|
|
|
MAP: Map on Server start
|
|
(`Default: gm_flatgrass`)
|
|
|
|
CONFIG: Server config, **Attention:** Change not recommended
|
|
(`Default: server.cfg`)
|
|
|
|
MAXPLAYERS: Max players
|
|
(`Default: 16`)
|
|
|
|
CUSTOMPARAMETERS: additional parameters
|
|
(`Default: `)
|
|
|
|
## More Options
|
|
|
|
You can found more configuration options on the parent image page [hackebein/srcds](https://hub.docker.com/r/hackebein/srcds)
|