Puck

games
Report Issue

Hop on your skates and jump into a physics based hockey game. No rules, no timeouts, just get the puck in the goal. May the best team win!

Contributors:
rai68 Red-Banana-Official danielb@purpleflaghosting.com
README

Puck

Game Description

Hop on your skates and jump into a physics based hockey game. No rules, no timeouts, just get the puck in the goal. May the best team win!

Usefull links

Author & Contributers

Name Github Profile Buy me a Coffee
Red-Banana-Official https://github.com/Red-Banana-Official /
Rai68 https://github.com/rai68 https://ko-fi.com/rai68

Server Ports

By default Puck requires 2 ports.

Port default
Game 7777
Query 7778

Configuration

Where is the Server Configuration Stored?

The Puck dedicated server configuration is stored in server_configuration.json.

Instead of manually editing this file, you can set most key values directly in the Pterodactyl Panel using environment variables.

Name, game phases, mods and admin lists must be edited manually.

Default Configuration File (server_configuration.json)

On first startup, the server will generate the following structure:

{
  "port": 7777,
  "pingPort": 7778,
  "name": "Pterodactyl Puck Server",
  "maxPlayers": 10,
  "password": "",
  "voip": false,
  "isPublic": true,
  "adminSteamIds": [],
  "reloadBannedSteamIds": false,
  "usePuckBannedSteamIds": true,
  "printMetrics": true,
  "kickTimeout": 300,
  "sleepTimeout": 60,
  "joinMidMatchDelay": 10,
  "targetFrameRate": 120,
  "serverTickRate": 100,
  "clientTickRate": 200,
  "startPaused": false,
  "allowVoting": true,
  "phaseDurationMap": {
    "Warmup": 600,
    "FaceOff": 3,
    "Playing": 300,
    "BlueScore": 5,
    "RedScore": 5,
    "Replay": 10,
    "PeriodOver": 15,
    "GameOver": 15
  },
  "mods": [
    {
      "id": 3493628417,
      "enabled": false,
      "clientRequired": false
    }
  ]
}

Installation/System Requirements

Recommended Extra info
Processor Recent x86/64 (AMD/Intel) processor. You need min 1 Core for the Server.
RAM 512 MB
Storage 1 GB
Docker Images (1)
Name Image
ghcr.io/ptero-eggs/steamcmd:debian ghcr.io/ptero-eggs/steamcmd:debian
Startup Command 
./Puck.x86_64
Variables (9)

Max Players

The maximum number of players allowed on the server.

Environment:
MAX_PLAYERS
Default:
10
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|max:32

Query Port

Query Port of the server, Additional Allocation required.

Environment:
QUERY_PORT
Default:
7778
User Viewable:
❌
User Editable:
❌
Rules:
required|integer|between:1025,65535

[STEAM] Steam App ID

Steam App ID

Environment:
SRCDS_APPID
Default:
3481440
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:3481440

[SYSTEM] Auto Update

Auto Update

Environment:
AUTO_UPDATE
Default:
0
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Password

The password required to join the server.

Environment:
SRV_PASSWORD
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string|max:64

Kick Timeout

Time before player is kicked for AFK

Environment:
KICK_TIMEOUT
Default:
300
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|

Target Framerate

Framerate of server, Should be 10-20 Above Tick Rate!

Environment:
FRAME_RATE
Default:
120
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|max:380

Target Tick rate

Tick rate of Server

Environment:
SERVER_TICK_RATE
Default:
100
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|max:360

Client Tick Rate

This value should be at least double the servers tick rate, but too high may cause instabilities in some clients. Do not go above 360 even if double the Server Tick is above. Unless you understand what you are doing.

Environment:
CLIENT_TICK_RATE
Default:
360
User Viewable:
❌
User Editable:
❌
Rules:
required|numeric|max:720
Installation Script
Container: ghcr.io/ptero-eggs/installers:debian
Entrypoint: bash
#!/bin/bash
# steamcmd Base Installation Script
#
# Server Files: /mnt/server
# Image to install with is 'ghcr.io/ptero-eggs/installers:debian'

##
#
# Variables
# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.
# WINDOWS_INSTALL - if it's a windows server you want to install set to 1
# SRCDS_APPID - steam app id found here - https://developer.valvesoftware.com/wiki/Dedicated_Servers_List
# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch
# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.
# INSTALL_FLAGS - Any additional SteamCMD  flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.
# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.
#
 ##

# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.
#apt -y update
#apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates

## just in case someone removed the defaults.
if [[ "${STEAM_USER}" == "" ]] || [[ "${STEAM_PASS}" == "" ]]; then
    echo -e "steam user is not set.\n"
    echo -e "Using anonymous user.\n"
    STEAM_USER=anonymous
    STEAM_PASS=""
    STEAM_AUTH=""
else
    echo -e "user set to ${STEAM_USER}"
fi

## download and install steamcmd
cd /tmp
mkdir -p /mnt/server/steamcmd
curl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
tar -xzvf steamcmd.tar.gz -C /mnt/server/steamcmd
mkdir -p /mnt/server/steamapps # Fix steamcmd disk write error when this folder is missing
cd /mnt/server/steamcmd

# SteamCMD fails otherwise for some reason, even running as root.
# This is changed at the end of the install process anyways.
chown -R root:root /mnt
export HOME=/mnt/server

## install game using steamcmd
./steamcmd.sh +force_install_dir /mnt/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ "${WINDOWS_INSTALL}" == "1" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} $( [[ -z ${SRCDS_BETAID} ]] || printf %s "-beta ${SRCDS_BETAID}" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s "-betapassword ${SRCDS_BETAPASS}" ) ${INSTALL_FLAGS} validate +quit 

## set up 32 bit libraries
mkdir -p /mnt/server/.steam/sdk32
cp -v linux32/steamclient.so ../.steam/sdk32/steamclient.so

## set up 64 bit libraries
mkdir -p /mnt/server/.steam/sdk64
cp -v linux64/steamclient.so ../.steam/sdk64/steamclient.so

## CUSTOM
## Create default config
printf "{\r\n  \"port\": 7777,\r\n  \"pingPort\": 7778,\r\n  \"name\": \"Pterodactyl Puck Server\",\r\n  \"maxPlayers\": 10,\r\n  \"password\": \"\",\r\n  \"voip\": false,\r\n  \"isPublic\": true,\r\n  \"adminSteamIds\": [],\r\n  \"reloadBannedSteamIds\": false,\r\n  \"usePuckBannedSteamIds\": true,\r\n  \"printMetrics\": true,\r\n  \"kickTimeout\": 300,\r\n  \"sleepTimeout\": 60,\r\n  \"joinMidMatchDelay\": 10,\r\n  \"targetFrameRate\": 120,\r\n  \"serverTickRate\": 100,\r\n  \"clientTickRate\": 200,\r\n  \"startPaused\": false,\r\n  \"allowVoting\": true,\r\n  \"phaseDurationMap\": {\r\n    \"Warmup\": 600,\r\n    \"FaceOff\": 3,\r\n    \"Playing\": 300,\r\n    \"BlueScore\": 5,\r\n    \"RedScore\": 5,\r\n    \"Replay\": 10,\r\n    \"PeriodOver\": 15,\r\n    \"GameOver\": 15\r\n  },\r\n  \"mods\": [\r\n    {\r\n      \"id\": 3493628417,\r\n      \"enabled\": false,\r\n      \"clientRequired\": false\r\n    }\r\n  ]\r\n}\r\n" > /mnt/server/server_configuration.json

## End of installation
echo -e "${BLUE}-------------------------------------------------${NC}"
echo -e "${GREEN}Installation completed...${NC}"
echo -e "${BLUE}-------------------------------------------------${NC}"