Panel/modules/billing/docs
copilot-swe-agent[bot] 41ffa53e5d Update documentation with specific ports and configuration files
- Replace generic "Varies (see configuration)" with actual default ports
- Add specific port numbers for 41 game servers (Arma series: 2302, Source games: 27015, etc.)
- Update configuration file paths from XML definitions
- Properly escape backslashes in Windows paths for HTML display

Games updated include: Arma2/3, TF2, CS:GO, ETS2, Rust, Minecraft, and many more

Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>
2025-11-22 22:08:51 +00:00
..
7daystodie Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
aliensvspredator Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
amxmodx Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
aoc Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
arkse Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
arma-reforger Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
arma2co Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
arma2oa Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
arma3 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
assettocorsa Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
atlas Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
avorion Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
b3 Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
bec Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
bf2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
bfbc2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
bloodfrontier Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
brainbread2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
callofduty Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
callofduty2 Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
callofduty4mw Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
callofdutymw2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
callofdutymw3 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
callofdutyuo Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
callofdutywaw Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
citadelfwf Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
cod_blackops Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
colonysurvival Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
common-issues Generate comprehensive documentation for 98 game servers previously in TODO category 2025-11-22 16:00:18 +00:00
conanexiles Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
cs2d Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
csgo Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
cspromod Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
css Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
cstrike Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
czero Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
dayz Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
dayzmod Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
dmc Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
dod Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
dods Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
doi Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
dontstarvetogether Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
dystopia Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
eco Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
empyriongs Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
enemyterritory Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
epochmod Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
esmod Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
ets2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
factorio Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
feedthebeast Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
fgms Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
fivem Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
fof Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
freecol Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
garrysmod Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
gearbox Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
getting-started added 10 games docs 2025-11-11 14:59:42 -05:00
halo_ce Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
harsh Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
hidden_source Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
hl2d Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
hldm Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
hltv Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
homefront Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
hurtworld Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
il2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ins Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
insurgencymic Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
insurgencysandstorm Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ivmp Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
jcmp Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
jediknight2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
jediknightja Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
killingfloor Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
killingfloor2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
left4dead Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
left4dead2 Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
lifeisfeudal Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mab_warband Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mafia2online Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
metamodsource Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
minecraft Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
miscreated Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mohaa Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mohbr Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mohsp Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mohspdemo Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mordhau Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
multitheftauto Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
mumble Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
nexuiz Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
nmrih_steam Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ns2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
nucleardawn Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ootow Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
openttd Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
oxide Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
pixark Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
pvkii Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
quake3 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
quake4 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
redorchestra2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
reignofkings Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ricochet Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
risingstorm2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
roadkill Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
rorserver Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
rust Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
sanandreasmp Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
serioussamhdfe Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
serioussamhdse Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
shoutcast Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
shoutcast_bot Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
sinusbot Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
smashball Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
smokinguns Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
sms Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
sniperelitev2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
soldatserver Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
space_engineers Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
spigotmc Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
spunkybot Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
squad Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
starbound Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
stationeers Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
synergy Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
teamspeak2 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
teamspeak3 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
terraria Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
tf2 Enhanced game documentation with comprehensive installation and configuration details 2025-11-22 21:36:59 +00:00
tfc Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
theforest Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
trackmanianations Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
trackmanianf Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
unturned Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
urt Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ut3 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ut99 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ut2004 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
valheim Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
vbox Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
ventrilo Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
vicecitymp Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
warsow Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
wolfrtcw_1-4 Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
wreckfest Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
wurmu Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
xonotic Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
zps Update documentation with specific ports and configuration files 2025-11-22 22:08:51 +00:00
COMPREHENSIVE_DOCUMENTATION_UPDATE.md Add icon checker script and comprehensive documentation update summary 2025-11-22 21:38:48 +00:00
DOCUMENTATION_ENHANCEMENT_SUMMARY.md site changes by codex 2025-11-20 08:10:31 -05:00
DOCUMENTATION_EXPANSION_PLAN.md mvoed docs folder back 2025-11-10 13:06:39 -05:00
Game Server Hosting Reference (Multiplayer PC Games).pdf mvoed docs folder back 2025-11-10 13:06:39 -05:00
GAME_SERVER_LIST.md more games 2025-11-10 20:54:02 -05:00
gameserver_catalog_all_sources.yaml mvoed docs folder back 2025-11-10 13:06:39 -05:00
gameserver_catalog_lgsm_full.yaml mvoed docs folder back 2025-11-10 13:06:39 -05:00
gameserver_knowledgepack_v2.yaml mvoed docs folder back 2025-11-10 13:06:39 -05:00
GENERATION_README.md Add documentation generator tool and README for game server docs 2025-11-22 16:01:36 +00:00
IMPLEMENTATION_SUMMARY.md Add implementation summary for game documentation generation 2025-11-22 16:03:52 +00:00
README.md mvoed docs folder back 2025-11-10 13:06:39 -05:00
XML-Notes.md site changes by codex 2025-11-20 08:10:31 -05:00
xml_notes.php site changes by codex 2025-11-20 08:10:31 -05:00

Documentation System

Overview

The billing module now includes a flexible documentation browser that organizes documentation into categories with an easy-to-navigate interface.

Structure

Documentation is organized in the /modules/billing/docs/ folder with the following structure:

docs/
├── category-name-1/
│   ├── index.php          (Required: Documentation content)
│   ├── metadata.json      (Required: Category and ordering info)
│   └── icon.png or icon.jpg (Required: Category icon)
├── category-name-2/
│   ├── index.php
│   ├── metadata.json
│   └── icon.png
└── ...

Creating New Documentation

1. Create a Folder

Create a new folder in /modules/billing/docs/ with a descriptive name (lowercase, hyphens for spaces):

mkdir /modules/billing/docs/my-new-doc

2. Create metadata.json

This file defines how the documentation appears in the list:

{
    "name": "My Documentation Title",
    "description": "A brief description of this documentation",
    "category": "game",
    "order": 10
}

Fields:

  • name: Display name shown in the documentation list
  • description: Brief description shown on the card
  • category: One of: game, panel, mods, troubleshooting, other
  • order: Sort order within the category (lower numbers appear first)

3. Create index.php

This file contains the actual documentation content. Use PHP and HTML:

<?php
/**
 * My Documentation
 */
?>
<h1>My Documentation Title</h1>

<h2>Section 1</h2>
<p>Your content here...</p>

<h3>Subsection</h3>
<ul>
    <li>Item 1</li>
    <li>Item 2</li>
</ul>

<h2>Code Examples</h2>
<pre><code>
# Your code here
command --option value
</code></pre>

The documentation system automatically styles:

  • Headings (h1-h4)
  • Links (styled with accent color)
  • Code blocks (with dark background)
  • Lists and other HTML elements

4. Add an Icon

Add either icon.png or icon.jpg to the folder. Recommended size: 60x60 pixels or larger (will be scaled down).

If no icon is provided, a default document emoji (📄) will be shown.

Categories

Documentation is organized into these categories:

  • game - Game-specific server guides
  • panel - Panel usage and features
  • mods - Mods and addon documentation
  • troubleshooting - Problem-solving guides
  • other - Miscellaneous documentation

Categories are sorted and labeled automatically on the documentation page.

Example Documentation

See the included examples:

  1. minecraft - Game server documentation example
  2. getting-started - Panel documentation example
  3. common-issues - Troubleshooting documentation example

Accessing Documentation

Users can access documentation at:

  • /modules/billing/docs.php - Main documentation list
  • /modules/billing/docs.php?action=view&doc=folder-name - Specific doc

A "Documentation" link is added to the main navigation menu.

Best Practices

  1. Keep it Organized: Use clear, descriptive folder names
  2. Consistent Naming: Use lowercase and hyphens (e.g., my-game-guide)
  3. Good Descriptions: Write helpful metadata descriptions
  4. Visual Icons: Use recognizable icons for each category
  5. Test Content: Preview documentation after creating it
  6. Regular Updates: Keep documentation current with panel changes

Migration from Old System

The old docs folder with game markdown files has been moved to /modules/billing/docs_old/ for reference. The new system provides:

  • Better organization by category
  • Consistent styling
  • Easier navigation
  • Extensible structure for any type of documentation

To migrate old documentation:

  1. Create a new folder for each document
  2. Convert markdown to HTML in index.php
  3. Add appropriate metadata.json
  4. Add an icon image

Troubleshooting

Documentation not appearing

  • Check that folder has all three required files (index.php, metadata.json, icon)
  • Verify metadata.json is valid JSON
  • Ensure file permissions allow reading

Styling issues

  • The system uses inline styles from docs.php
  • Custom styles in index.php may conflict
  • Keep content semantic (use proper HTML tags)

Icons not showing

  • Check file exists and is named exactly icon.png or icon.jpg
  • Verify image file is not corrupted
  • Try a smaller image size if very large