28015Varies (see configuration)The following ports are used by this game server:
-| Port | -Protocol | -Purpose | -
|---|---|---|
28015 |
- UDP | -Game port | -
28016 |
- TCP | -RCON | -
28082 |
- TCP | -Web panel (if enabled) | -
The Rust server typically uses a configurable port. Check your server configuration files for the specific port settings.
Allow server ports through your firewall:
@@ -194,68 +168,116 @@ setadminpassword [password]# Generic startup command structure
-./server_executable [parameters]
-The server uses the following command line template:
+-batchmode -nographics +server.ip %IP% %PORT% %QUERY_PORT% %PLAYERS% %HOSTNAME% %IDENTITY% %DESCRIPTION% %WORLDSIZE% %SEED% %SALT% %TICKRATE% %MAP% %BCK% %SAVEINTERNAL% %SECURE% %RCONWEB% %CONTROL_PASSWORD% -logfile output.txt-port [number] - Set the server port-maxplayers [number] - Maximum player slots-map [name] - Starting map/level-console - Enable console output-nographics - Run without graphics (headless mode)The following parameters can be configured when starting the server:
-Linux (start.sh):
-#!/bin/bash
-cd /path/to/server
-./server_executable [parameters] 2>&1 | tee server.log
-chmod +x start.sh
-./start.sh
-+server.identity
+ - +server.identity
+ Changes path to your server data (e.g. rust/server/my_server_identity).
+Default: server_identity
Windows (start.bat):
-@echo off
-cd /d "%~dp0"
-server_executable.exe [parameters]
-pause
-+server.description
+ - +server.description
+ Server Description shown on server browser
+Default: Plain old Rust Server
+server.worldsize
+ - +server.worldsize
+ Defines the size of the map generated (min 1000, max 8000).
+Default: 1000
Linux (systemd):
-# Create service file: /etc/systemd/system/gameserver.service
-[Unit]
-Description=Rust Server
-After=network.target
+
+
+ +server.seed
+ - +server.seed
+
+ Defines the map generation seed.
+ Default: 0
+
-[Service]
-Type=simple
-User=gameserver
-WorkingDirectory=/home/gameserver/server
-ExecStart=/home/gameserver/server/start.sh
-Restart=on-failure
-RestartSec=10
+
+
+ +server.salt
+ - +server.salt
+
+ Defines the randomization to mining resources.
+ Default: 0
+
-[Install]
-WantedBy=multi-user.target
-+server.tickrate
+ - +server.tickrate
+ Defines the server tickrate (going higher than 30 is not recommended).
+Default: 30
# Enable and start service
-sudo systemctl daemon-reload
-sudo systemctl enable gameserver
-sudo systemctl start gameserver
-sudo systemctl status gameserver
-+server.level
+ - +server.level
+ Defines the map of the server.
+Options:
+Barren - BarrenCraggyIsland - Craggy IslandHapisIsland - Hapis IslandProcedural Map - Procedural MapSavasIsland - Savas IslandSavasIsland_koth - Savas Island KoTH+backup
+ - +backup
+ Enable automatic backups.
++server.saveinterval
+ - +server.saveinterval
+ Interval between the server saves the map.
+Default: 600
+rcon.web
+ - +rcon.web
+ If set to enabled, use websocket RCON. If set to disabled, use legacy source engine RCON.
+Options:
+0 - Disabled1 - Enabled# View recent log entries
diff --git a/push_to_github.sh b/push_to_github.sh
index d454165b..fc8e8bc0 100644
--- a/push_to_github.sh
+++ b/push_to_github.sh
@@ -1,26 +1,82 @@
#!/usr/bin/env bash
+#
+# GSP GitHub Push Script
+# ======================
+# This script commits local changes in your GSP panel directory and pushes
+# them to GitHub via a Pull Request.
+#
+# HOW IT WORKS:
+# 1. Initializes git in the panel directory (if needed)
+# 2. Commits all changes (excluding sensitive files like config.inc.php)
+# 3. Creates a timestamped branch
+# 4. Attempts to push to upstream repo (requires write access)
+# 5. If no write access, creates/uses a fork and submits PR from there
+#
+# CONFIGURATION:
+# Configure settings via environment variables or by editing the defaults below.
+#
+# ENVIRONMENT VARIABLES:
+# - PANEL_DIR: Path to your GSP panel installation (default: /var/www/html/panel)
+# - TOKEN_FILE: File containing GitHub Personal Access Token (default: ~/.github-token)
+# - GITHUB_TOKEN: GitHub token directly (used if TOKEN_FILE doesn't exist)
+# - UPSTREAM_REPO: Target repository in "owner/repo" format (default: GameServerPanel/GSP)
+# - BR_PREFIX: Branch name prefix for PRs (default: panel-sync)
+# - GIT_USER_NAME: Git commit author name (default: Server Sync Bot)
+# - GIT_USER_EMAIL: Git commit author email (default: server-sync@local)
+#
+# GITHUB TOKEN SETUP:
+# You need a GitHub Personal Access Token with 'repo' scope.
+# Create one at: https://github.com/settings/tokens
+#
+# Option 1: Store in file (recommended):
+# echo "your_token_here" > ~/.github-token
+# chmod 600 ~/.github-token
+#
+# Option 2: Use environment variable:
+# export GITHUB_TOKEN="your_token_here"
+#
+# EXAMPLE USAGE:
+# # Use defaults:
+# ./push_to_github.sh
+#
+# # Custom panel directory:
+# PANEL_DIR=/home/panel/public_html ./push_to_github.sh
+#
+# # Using environment token:
+# GITHUB_TOKEN="ghp_xxxx" ./push_to_github.sh
+#
set -Eeuo pipefail
umask 022
-# ---------- HARD-CODED PROJECT SETTINGS ----------
-PANEL_DIR="/var/www/html/panel"
-TOKEN_FILE="/home/gameserver/git.token"
+# ---------- CONFIGURABLE SETTINGS ----------
+PANEL_DIR="${PANEL_DIR:-/var/www/html/panel}"
+TOKEN_FILE="${TOKEN_FILE:-$HOME/.github-token}"
-UPSTREAM_REPO="GameServerPanel/GSP" # owner/repo
+UPSTREAM_REPO="${UPSTREAM_REPO:-GameServerPanel/GSP}" # owner/repo
UPSTREAM_URL="https://github.com/${UPSTREAM_REPO}.git"
-BR_PREFIX="panel-sync" # branch prefix for PRs
-GIT_USER_NAME="Server Sync Bot"
-GIT_USER_EMAIL="server-sync@local"
+BR_PREFIX="${BR_PREFIX:-panel-sync}" # branch prefix for PRs
+GIT_USER_NAME="${GIT_USER_NAME:-Server Sync Bot}"
+GIT_USER_EMAIL="${GIT_USER_EMAIL:-server-sync@local}"
log(){ printf '[%s] %s\n' "$(date +'%F %T')" "$*"; }
die(){ echo "ERROR: $*" >&2; exit 1; }
# ---------- PRECHECKS ----------
[[ -d "$PANEL_DIR" ]] || die "Panel dir not found: $PANEL_DIR"
-[[ -s "$TOKEN_FILE" ]] || die "Token file missing/empty: $TOKEN_FILE"
-TOKEN="$(<"$TOKEN_FILE")"
-[[ ${#TOKEN} -ge 10 ]] || die "Token in $TOKEN_FILE looks invalid"
+
+# Try to get token from file or environment
+TOKEN=""
+if [[ -s "$TOKEN_FILE" ]]; then
+ TOKEN="$(<"$TOKEN_FILE")"
+elif [[ -n "${GITHUB_TOKEN:-}" ]]; then
+ TOKEN="$GITHUB_TOKEN"
+else
+ die "GitHub token not found. Set GITHUB_TOKEN env var or create $TOKEN_FILE with your token.
+ Get a token at: https://github.com/settings/tokens (requires 'repo' scope)"
+fi
+
+[[ ${#TOKEN} -ge 10 ]] || die "Token looks invalid (too short)"
cd "$PANEL_DIR"
if [[ ! -d ".git" ]]; then
diff --git a/tools/generate_game_docs.py b/tools/generate_game_docs.py
index 8a0aa4b1..67513991 100755
--- a/tools/generate_game_docs.py
+++ b/tools/generate_game_docs.py
@@ -1,8 +1,42 @@
#!/usr/bin/env python3
"""
Comprehensive Game Server Documentation Generator for GSP
-Generates PHP documentation files for all games in the "todo" category
-Based on the Minecraft template structure
+
+This script generates PHP documentation files for game servers in the GSP billing module.
+
+USAGE:
+ # Generate docs for all incomplete games:
+ python3 generate_game_docs.py
+
+ # Generate docs for specific game(s):
+ python3 generate_game_docs.py --games minecraft csgo rust
+
+ # Regenerate docs (overwrite existing):
+ python3 generate_game_docs.py --games minecraft --force
+
+ # Process all "todo" category games:
+ python3 generate_game_docs.py --todo-only
+
+OPTIONS:
+ --games GAME1 GAME2 ... Generate docs for specific game folder names
+ --force Overwrite existing documentation files
+ --todo-only Only process games with category="todo"
+ --help Show this help message
+
+The generator extracts information from:
+- XML configurations (modules/config_games/server_configs/*.xml)
+- YAML knowledgepack (modules/billing/docs/gameserver_knowledgepack_v2.yaml)
+- Existing metadata.json files
+
+Generated documentation includes:
+- Quick info (ports, RAM, Steam App ID)
+- Network ports and firewall configuration
+- Installation steps with SteamCMD commands
+- Server configuration files and settings
+- Detailed startup parameters from XML
+- Comprehensive troubleshooting guide
+- Performance optimization tips
+- Security best practices
"""
import os
@@ -10,6 +44,7 @@ import sys
import json
import yaml
import re
+import argparse
from pathlib import Path
from datetime import datetime
import xml.etree.ElementTree as ET
@@ -115,6 +150,68 @@ class GameDocGenerator:
return ports
+ def extract_startup_parameters_from_xml(self, xml_root):
+ """Extract detailed startup parameters from XML server_params section"""
+ startup_params = []
+
+ # Get CLI template and params
+ cli_template = xml_root.find('cli_template')
+ cli_template_text = cli_template.text if cli_template is not None else ""
+
+ cli_params_elem = xml_root.find('cli_params')
+ cli_params_info = {}
+ if cli_params_elem is not None:
+ for param in cli_params_elem.findall('cli_param'):
+ param_id = param.get('id', '')
+ cli_string = param.get('cli_string', '')
+ options = param.get('options', '')
+ if param_id:
+ cli_params_info[param_id] = {
+ 'cli_string': cli_string,
+ 'options': options
+ }
+
+ # Extract server_params - these are the configurable startup parameters
+ server_params = xml_root.find('server_params')
+ if server_params is not None:
+ for param in server_params.findall('param'):
+ param_key = param.get('key', '')
+ param_id = param.get('id', '')
+ param_type = param.get('type', 'text')
+
+ # Get caption and description
+ caption_elem = param.find('caption')
+ desc_elem = param.find('desc')
+ default_elem = param.find('default')
+
+ caption = caption_elem.text if caption_elem is not None else param_key
+ description = desc_elem.text if desc_elem is not None else "No description available"
+ default_value = default_elem.text if default_elem is not None else None
+
+ # For select type, get options
+ options = []
+ if param_type == 'select':
+ for option in param.findall('option'):
+ opt_value = option.get('value', '')
+ opt_text = option.text if option.text else opt_value
+ options.append({'value': opt_value, 'text': opt_text})
+
+ startup_params.append({
+ 'key': param_key,
+ 'id': param_id,
+ 'type': param_type,
+ 'caption': caption,
+ 'description': description,
+ 'default': default_value,
+ 'options': options
+ })
+
+ return {
+ 'cli_template': cli_template_text,
+ 'cli_params': cli_params_info,
+ 'server_params': startup_params
+ }
+
def extract_config_files_from_xml(self, xml_root):
"""Extract configuration file paths from XML"""
config_files = []
@@ -139,15 +236,17 @@ class GameDocGenerator:
kb_info = self.get_game_info_from_knowledgepack(game_name)
xml_config = self.get_xml_config(folder_name)
- # Extract ports and configs
+ # Extract ports, configs, and startup parameters
ports_info = []
config_files = []
+ startup_params_data = {}
if xml_config is not None:
ports_info = self.extract_ports_from_xml(xml_config)
config_files = self.extract_config_files_from_xml(xml_config)
+ startup_params_data = self.extract_startup_parameters_from_xml(xml_config)
# Build the PHP document
- php_content = self.build_php_content(game_name, folder_name, kb_info, xml_config, ports_info, config_files)
+ php_content = self.build_php_content(game_name, folder_name, kb_info, xml_config, ports_info, config_files, startup_params_data)
return php_content
@@ -180,7 +279,7 @@ class GameDocGenerator:
return 'N/A'
- def build_php_content(self, game_name, folder_name, kb_info, xml_config, ports_info, config_files):
+ def build_php_content(self, game_name, folder_name, kb_info, xml_config, ports_info, config_files, startup_params_data):
"""Build the complete PHP documentation content"""
# Extract data from various sources
@@ -495,21 +594,81 @@ setadminpassword [password]
The server uses the following command line template:
+{cli_template}The following parameters can be configured when starting the server:
+ +{param_key}
+ - {caption}
+ {description_clean}
+''' + + if param_type == 'select' and options: + php_doc += '''Options:
+{opt['value']} - {opt['text']}Default: {default}
{startup_cmd}
+ if startup_cmd:
+ php_doc += f'''{startup_cmd}
'''
- else:
- php_doc += '''# Generic startup command structure
+ else:
+ php_doc += '''# Generic startup command structure
./server_executable [parameters]
'''
- php_doc += '''
+ php_doc += '''
Common Parameters
-port [number] - Set the server port