rbreslow / zs

Fork of JetBoom's Zombie Survival for the "Hot Dad" Garry's Mod community.

Zombie Survival

This repository contains a fork of JetBoom's Zombie Survival gamemode for the "Hot Dad" Garry's Mod community.

Licensing Note:

With written permission from JetBoom, this repository is licensed under the JBGM License WITH the Sharing Exception.

Our exception requires that, if you use any of our source code, you will make the source code of your version accessible to your players.

If you want to use the improvements we share with the community, you will have to give back as well.

• Requirements
• Getting Started
  • Maps
  • Fast Download
• Scripts

Requirements

• Docker Engine 19.03+
• Docker Compose 1.26+

Getting Started

First, define a Steam Game Server Login Token (GSLT) within the .env file at the root of the repository.

$ cat .env
STEAM_GSLT=YOURLOGINTOKENHERE

Next, create a server.cfg file under src/garrysmod/cfg.

$ cd src/garrysmod/cfg
$ cat server.cfg
hostname "Zombie Survival"

The following script will provision the rest of the development environment.

$ ./scripts/update

And, volia ✨.

$ ./scripts/server
. . .
garrysmod_1  | Connection to Steam servers successful.
garrysmod_1  |    Public IP is [redacted].
garrysmod_1  | Assigned anonymous gameserver Steam ID [A-1:3346233348(15470)].
garrysmod_1  | VAC secure mode is activated.

Other features of the development environment require additional credentials to be configured within the .env file in the root of the repository.

Map Files

Some of the map files are larger than 100 MB which is over GitHub's individual file size limit. As a result, map files are stored in an S3 bucket, not in this repository.

scripts/update will attempt to connect to an S3 bucket to sync map files with your workspace.

Fast Download

Fast Download (FastDL) allows Garry's Mod clients to download custom server content from a web server. Without FastDL, downloads are limited to 30 KB/s.

scripts/update will sync content within src/garrysmod/gamemodes/zombiesurvival/content to an S3 bucket configured to serve as the FastDL endpoint.

Scripts

Name	Description
console	Attach to the SRCDS console. Detach with ctrl-d.
manage	Run a Lapis command line tool.
server	Start SRCDS.
sync-fastdl	Push FastDL artifacts to S3.
sync-maps	Pull map files from from S3.
update	Build container images and update dependencies.