From fc0c9ce94451db5f85ac528c5a80567be07ddbdd Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 8 Sep 2025 21:41:11 +0000 Subject: [PATCH 1/3] Initial plan From c55cc3eec1459525e478408b3fc493d5fa5518bf Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 8 Sep 2025 21:50:48 +0000 Subject: [PATCH 2/3] Implement HTML-based FAQ structure with comprehensive panel documentation Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com> --- faq_demo.html | 143 ++++++++++++++++ modules/faq/faq.php | 118 +++----------- modules/faq/faq_data.php | 341 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 502 insertions(+), 100 deletions(-) create mode 100644 faq_demo.html create mode 100644 modules/faq/faq_data.php diff --git a/faq_demo.html b/faq_demo.html new file mode 100644 index 00000000..f5c7a157 --- /dev/null +++ b/faq_demo.html @@ -0,0 +1,143 @@ + + + + Enhanced Open Game Panel FAQ + + + + +

F.A.Q.

+
+ 📋 Categories + +
+
+ + + +
+ +
📋 Panel Overview
+
What is the Open Game Panel?
+
+
The Open Game Panel (OGP) is a web-based control panel for managing game servers. It provides an easy-to-use interface for starting, stopping, configuring, and monitoring your game servers without needing command-line access.
+
+
How do I navigate the panel?
+
+
The panel is organized into several main sections accessible from the navigation menu:
+ • Dashboard - Overview of your servers and system status
+ • Game Servers - Manage your game server instances
+ • File Manager - Browse and edit server files
+ • User Management - Control user access and permissions
+ • Administration - System settings and configuration
+
+ +
🎮 Server Management
+
How do I start my game server?
+
+
Navigate to Game Manager → Server Monitor, then click the Start button. Wait for the status to change to "Online" before attempting to connect.
+
+
What if my server won't start?
+
+
Check the server logs for error messages by clicking View Log. Common issues include:
+ • Misconfigured settings
+ • Missing or corrupted files
+ • Port conflicts
+ • Insufficient system resources
+ If the problem persists, check the troubleshooting section or contact support.
+
+ +
📁 File Management
+
How do I access server files?
+
+
Use the File Manager (LiteFM) to browse, edit, upload, and download server files through your web browser. You can also use the FTP module for bulk file transfers.
+
+ +
🔧 Troubleshooting
+
My server won't start - "Failed to start remote server" error
+
+
This error usually means:
+ • The server crashed during startup
+ • Configuration files have syntax errors
+ • Required files are missing or corrupted
+ Solution: Check the server logs for specific error messages, verify your configuration files, and ensure all required game files are present.
+
+ +
+ +
+
+ Open Game Panel - Enhanced HTML FAQ System
+ Comprehensive documentation for all panel modules and features +
+
+ + + \ No newline at end of file diff --git a/modules/faq/faq.php b/modules/faq/faq.php index 9fffda50..8f9af58b 100755 --- a/modules/faq/faq.php +++ b/modules/faq/faq.php @@ -34,116 +34,34 @@ function exec_ogp_module() echo '
Categories
'. '

'; - require 'modules/faq/rss_php.php'; - $url = 'https://opengamepanel.org/faq/rss.php'; - $local_copy = 'modules/faq/faq.rss'; ## Relative path - $save_as = realpath('modules' . DIRECTORY_SEPARATOR . 'faq') . DIRECTORY_SEPARATOR . 'faq.rss'; - ## Full path (adding the filename to realpath would fail if the file does not exists yet) - $online = false; - $local = true; - $updated = false; - $s = (isset($_SERVER['HTTPS'])) ? "s" : ""; - $p = (isset($_SERVER['SERVER_PORT']) and $_SERVER['SERVER_PORT'] != "80") ? ":".$_SERVER['SERVER_PORT'] : ""; - $localServerURL = $_SERVER['SERVER_NAME']; - if($localServerURL == "_"){ - $localServerURL = "localhost"; - } - $local_url = 'http'.$s.'://'.$localServerURL.$p.$_SERVER['SCRIPT_NAME']; - $local_url = str_replace('home.php', $local_copy, $local_url); - if(file_exists($save_as)) - { - $rss = new rss_php; - $rss->load($local_url); - $items = $rss->getItems(); #returns all rss items - $local = true; - } - /* - echo ""; - if( ($local AND ( strtotime("+1 day", filemtime($save_as)) <= strtotime("now") )) OR !$local) # Check the file is older than 1 day to avoid spamming the server - { - stream_context_set_default(array('ssl' => array( - 'verify_peer' => false, - 'verify_peer_name' => false - ) - )); - - $headers = get_headers( $url, 1 ); - touch( $save_as ); # Connection done, so we reset the file modification time even if the server is down (avoid server spamming) - echo ""; - if( $headers[0] == 'HTTP/1.1 200 OK') - { - $online = false; - $rss_online = new rss_php; - $rss_online->load($url); # SERVER USAGE WARNING : using 32kb of server bandwidth each time each person loads this function - $items_online = $rss_online->getItems(); - echo ""; - if(($local and $items_online != $items ) OR !$local) - { - $contents = file_get_contents($url); - if(preg_match('#^<\?xml version="1.0" encoding="utf-8" \?>#', $contents, $match)) - { - if( file_put_contents($save_as, $contents) === false ) - { - print_failure("Imposible write " . $save_as); - return; - } - touch( $save_as ); - echo ""; - $updated = true; - } - else - { - print_failure("Imposible fetch " . $url); - return; - } - } - else - { - echo ""; - } - } - } - + // Load FAQ data from new HTML structure + require_once 'modules/faq/faq_data.php'; + $entries = getFaqData(); - if($updated) - { - $rss = new rss_php; - $rss->load($local_url); - $items = $rss->getItems(); #returns all rss items - } - */ - - if(!file_exists($save_as)) - { - print_failure('Unable to load entries.'); - return; # Stop loading page - } - - - $entries = array(); - foreach($items as $index => $item) - { - $category = $item['category'][0]; - $entries[$category][$index]['title'] = $item['title'][0]; - $entries[$category][$index]['content'] = $item['content:encoded'][0]; - } $categories = ""; $accordion_entries = "
\n"; + foreach($entries as $category_name => $category_entries) { - $categories .= "
  • $category_name
    • "; - $accordion_entries .= "
    $category_name
    "; - foreach($category_entries as $index => $item) + // Create category navigation link with clean ID + $category_id = preg_replace('/[^a-z0-9_]/', '_', strtolower($category_name)); + $categories .= "
  • $category_name
    • "; + + // Create category section + $accordion_entries .= "
    $category_name
    "; + + // Add items for this category + foreach($category_entries as $item) { - $accordion_entries .= "\t
    ". - "$item[title]
    \n". - "\t
    \n\t\t
    $item[content]
    \n\t
    \n"; + $accordion_entries .= "\t
    ". + htmlspecialchars($item['title']) . "
    \n". + "\t
    \n\t\t
    " . $item['content'] . "
    \n\t
    \n"; } } $categories .= ""; $accordion_entries .= "
    "; - echo $categories.$accordion_entries; + echo $categories . $accordion_entries; echo "
    ". "
    ". @@ -151,7 +69,7 @@ function exec_ogp_module() "
    ". "
    ". "Credits:
    ". - "

    ". + "
    Open Game Panel - Enhanced HTML FAQ System
    ". "
    ". "
    "; } diff --git a/modules/faq/faq_data.php b/modules/faq/faq_data.php new file mode 100644 index 00000000..b72ca5e2 --- /dev/null +++ b/modules/faq/faq_data.php @@ -0,0 +1,341 @@ + array( + array( + 'title' => 'What is the Open Game Panel?', + 'content' => 'The Open Game Panel (OGP) is a web-based control panel for managing game servers. It provides an easy-to-use interface for starting, stopping, configuring, and monitoring your game servers without needing command-line access.' + ), + array( + 'title' => 'How do I navigate the panel?', + 'content' => 'The panel is organized into several main sections accessible from the navigation menu:
    + • Dashboard - Overview of your servers and system status
    + • Game Servers - Manage your game server instances
    + • File Manager - Browse and edit server files
    + • User Management - Control user access and permissions
    + • Administration - System settings and configuration' + ), + array( + 'title' => 'What browsers are supported?', + 'content' => 'The panel works best with modern browsers including Chrome, Firefox, Safari, and Edge. JavaScript must be enabled for full functionality.' + ) + ), + + 'Dashboard' => array( + array( + 'title' => 'What information is shown on the Dashboard?', + 'content' => 'The Dashboard provides:
    + • Server Status - Quick view of which servers are online/offline
    + • System Resources - CPU, memory, and disk usage
    + • Recent Activity - Latest server actions and events
    + • Quick Actions - Fast access to common server management tasks' + ), + array( + 'title' => 'How do I refresh the dashboard data?', + 'content' => 'Dashboard widgets automatically refresh every few minutes. You can also manually refresh by clicking the refresh button on individual widgets or refreshing your browser page.' + ) + ), + + 'Server Management' => array( + array( + 'title' => 'How do I start my game server?', + 'content' => 'Navigate to Game Manager → Server Monitor, then click the Start button. Wait for the status to change to "Online" before attempting to connect.' + ), + array( + 'title' => 'How do I stop my game server?', + 'content' => 'In the Server Monitor, click the Stop button. The server will shut down gracefully, saving any necessary data before stopping.' + ), + array( + 'title' => 'How do I restart my game server?', + 'content' => 'Use the Restart button in Server Monitor for a clean restart, or use Stop followed by Start if you need more control over the process.' + ), + array( + 'title' => 'What if my server won\'t start?', + 'content' => 'Check the server logs for error messages by clicking View Log. Common issues include:
    + • Misconfigured settings
    + • Missing or corrupted files
    + • Port conflicts
    + • Insufficient system resources
    + If the problem persists, check the troubleshooting section or contact support.' + ), + array( + 'title' => 'How do I update my game server?', + 'content' => 'Use the Install/Update button in Server Monitor. For Steam games, this will validate and download any updates automatically. Make sure to stop the server before updating.' + ) + ), + + 'File Management' => array( + array( + 'title' => 'How do I access server files?', + 'content' => 'Use the File Manager (LiteFM) to browse, edit, upload, and download server files through your web browser. You can also use the FTP module for bulk file transfers.' + ), + array( + 'title' => 'How do I edit configuration files?', + 'content' => 'Navigate to Edit Config Files for game-specific configuration editing, or use the File Manager to edit any text file directly in your browser.' + ), + array( + 'title' => 'Can I upload files to my server?', + 'content' => 'Yes! You can upload files using:
    + • File Manager - For individual files through web interface
    + • FTP - For bulk uploads using an FTP client
    + • Fast Download - For maps and custom content' + ), + array( + 'title' => 'Why can\'t I delete some files?', + 'content' => 'Some files are protected to prevent accidental server breakage:
    + • Server executables
    + • Startup scripts
    + • Critical system files
    + If you need to modify these files, contact your administrator.' + ), + array( + 'title' => 'How do I backup my server files?', + 'content' => 'Use the Backup & Restore module to create automated or manual backups of your server data. You can also download individual files through the File Manager.' + ) + ), + + 'User Management' => array( + array( + 'title' => 'What are subusers and how do I add them?', + 'content' => 'Subusers are additional users who can access specific servers with limited permissions. To add subusers:
    + 1. Go to Subusers
    + 2. Click Add Subuser
    + 3. Set their username, password, and permissions
    + 4. Assign them to specific servers
    + Subusers can only access servers you explicitly assign to them.' + ), + array( + 'title' => 'What are user groups?', + 'content' => 'User groups allow you to manage permissions for multiple users at once. Instead of setting permissions for each user individually, you can create groups with specific access levels and add users to those groups.' + ), + array( + 'title' => 'How do I change my password?', + 'content' => 'Go to Settings → User Settings to change your password, email, and other account preferences.' + ), + array( + 'title' => 'What permissions can I assign to subusers?', + 'content' => 'You can control subuser access to:
    + • Server start/stop/restart
    + • File management
    + • Configuration editing
    + • Log viewing
    + • RCON console access
    + • Backup creation' + ) + ), + + 'Administration' => array( + array( + 'title' => 'How do I access admin functions?', + 'content' => 'Admin functions are available in the Administration menu for users with admin privileges. This includes server management, user administration, and system settings.' + ), + array( + 'title' => 'How do I install new game modules?', + 'content' => 'Use the Module Manager to install, update, or remove panel modules. Only administrators can manage modules.' + ), + array( + 'title' => 'How do I configure system settings?', + 'content' => 'Access Settings from the administration menu to configure global panel settings, security options, and system preferences.' + ), + array( + 'title' => 'How do I add new game servers?', + 'content' => 'Administrators can add new servers through Administration → Add Server. This includes configuring the game type, ports, and initial settings.' + ) + ), + + 'Monitoring & Status' => array( + array( + 'title' => 'How do I check server status?', + 'content' => 'The Status module provides real-time information about server status, player counts, and system resources. You can also view individual server status in the Server Monitor.' + ), + array( + 'title' => 'What is LGSL and how does it work?', + 'content' => 'LGSL (Live Game Server List) queries game servers to display real-time status including player count, map, and server information. It supports most major game server types.' + ), + array( + 'title' => 'How do I view server logs?', + 'content' => 'Access server logs through Game Manager → View Log to see server output, error messages, and player activity. Logs help diagnose server issues.' + ), + array( + 'title' => 'What monitoring tools are available?', + 'content' => 'The panel includes:
    + • Real-time server status monitoring
    + • Resource usage tracking
    + • Player activity logs
    + • System performance metrics
    + • Alert notifications for critical issues' + ) + ), + + 'Communication & Support' => array( + array( + 'title' => 'How do I get support?', + 'content' => 'Support is available through:
    + • Tickets - Create support tickets for technical issues
    + • Support module - Access knowledge base and documentation
    + • Community forums and Discord channels
    + • This FAQ section for common questions' + ), + array( + 'title' => 'How do I create a support ticket?', + 'content' => 'Go to Tickets → New Ticket, describe your issue in detail, and include relevant server information. Support staff will respond as soon as possible.' + ), + array( + 'title' => 'What is TeamSpeak integration?', + 'content' => 'The TeamSpeak3 module allows you to manage TeamSpeak servers alongside your game servers, including user permissions, channel management, and server settings.' + ) + ), + + 'Game-Specific Features' => array( + array( + 'title' => 'How do I use Steam Workshop integration?', + 'content' => 'The Steam Workshop module allows you to easily install and manage Steam Workshop items for supported games. Simply browse or search for content and click install.' + ), + array( + 'title' => 'What is the Mods system?', + 'content' => 'The Mods module helps you install and manage game modifications. Different games support different mod systems, and the panel provides tools for the most common mod frameworks.' + ), + array( + 'title' => 'How do I use RCON?', + 'content' => 'The RCON module provides remote console access to your game servers. You can execute server commands, kick/ban players, change maps, and perform administrative tasks without joining the game.' + ), + array( + 'title' => 'What is TShock integration?', + 'content' => 'The TShock module provides enhanced Terraria server management with features like player permissions, world protection, and advanced administrative commands.' + ) + ), + + 'Troubleshooting' => array( + array( + 'title' => 'My server won\'t start - "Failed to start remote server" error', + 'content' => 'This error usually means:
    + • The server crashed during startup
    + • Configuration files have syntax errors
    + • Required files are missing or corrupted
    + • Port conflicts with other services
    + Solution: Check the server logs for specific error messages, verify your configuration files, and ensure all required game files are present.' + ), + array( + 'title' => 'Players can\'t connect to my server', + 'content' => 'Common connection issues:
    + • Server not actually running (check status)
    + • Firewall blocking the port
    + • Incorrect IP address or port
    + • Game version mismatch
    + Solution: Verify the server is online, check firewall settings, and confirm players are using the correct connection information.' + ), + array( + 'title' => 'File upload fails or times out', + 'content' => 'Large file upload issues can be caused by:
    + • File size limits in PHP configuration
    + • Network timeouts
    + • Browser limitations
    + Solution: Use FTP for large files, check file size limits, or break large uploads into smaller chunks.' + ), + array( + 'title' => 'I forgot my password', + 'content' => 'Use the Lost Password link on the login page to reset your password. You\'ll need access to the email address associated with your account.' + ), + array( + 'title' => 'The panel is slow or unresponsive', + 'content' => 'Performance issues may be due to:
    + • High server load
    + • Network connectivity problems
    + • Browser cache issues
    + Solution: Try refreshing the page, clearing browser cache, or waiting for server load to decrease. Contact support if problems persist.' + ) + ), + + 'Game-Specific Information' => array( + array( + 'title' => 'Ark - Query and RCON Ports', + 'content' => 'For ARK: Survival Evolved servers:
    + • Query Port: Server Port + 2
    + • RCON Port: Usually Server Port + 1
    + Example: If server port is 7777, query port is 7779' + ), + array( + 'title' => 'Arma - Query Port', + 'content' => 'For ARMA servers:
    + • Query Port: Server Port + 1
    + Example: If server port is 2302, query port is 2303' + ), + array( + 'title' => 'Conan Exiles - Ports Configuration', + 'content' => 'For Conan Exiles servers:
    + • Query Port: Server Port + 2
    + • RCON Port: Server Port + 3
    + Example: If server port is 7777, query port is 7779, RCON port is 7780' + ), + array( + 'title' => 'DayZ - Query Ports', + 'content' => 'DayZ port configuration depends on the version:
    + • DayZ Mod: Query Port = Server Port + 1
    + • DayZ Standalone: Query Port = Server Port + 3
    + Check which version you\'re running to use the correct ports.' + ), + array( + 'title' => 'Killing Floor - Query Port', + 'content' => 'For Killing Floor servers:
    + • Query Port: Server Port + 1
    + Example: If server port is 7707, query port is 7708' + ) + ), + + 'Database & Backups' => array( + array( + 'title' => 'How do I backup my game server database?', + 'content' => 'To backup your game server database:
    + 1. Go to Game Manager → MySQL
    + 2. Click on phpMyAdmin to access the database
    + 3. Select your database and click Export
    + 4. Save the file to your local computer
    + Tip: Regular backups prevent data loss from server issues.' + ), + array( + 'title' => 'How do I restore a database backup?', + 'content' => 'To restore a database backup:
    + 1. Access phpMyAdmin through the MySQL module
    + 2. Select your database
    + 3. Important: Delete all existing tables first
    + 4. Click Import and select your backup file
    + 5. Click Go to restore the data' + ), + array( + 'title' => 'How do I validate Steam files?', + 'content' => 'To validate/verify Steam game files:
    + 1. Stop your server
    + 2. Go to Server Monitor
    + 3. Click Install/Update
    + This will check and download any missing or corrupted files.
    + For complete reinstall: Delete all files in File Manager, then run Install/Update.' + ) + ), + + 'FTP & File Transfer' => array( + array( + 'title' => 'I get TLS/SSL errors when connecting to FTP', + 'content' => 'If your FTP client shows TLS or secure connection errors:
    + • Try disabling TLS/SSL encryption in your FTP client
    + • Use "Plain FTP" or "No encryption" settings
    + • Our FTP servers typically don\'t require TLS encryption
    + FTP Clients: FileZilla, WinSCP, or the built-in File Manager work well.' + ), + array( + 'title' => 'What are the FTP connection details?', + 'content' => 'FTP connection information is available in the FTP module:
    + • Server: Your panel\'s IP address
    + • Username: Your panel username
    + • Password: Your panel password
    + • Port: Usually 21 (standard FTP)
    + • Encryption: None/Plain FTP' + ) + ) + ); +} +?> \ No newline at end of file From 1558488c281cf852585f427a248220dfa8cf3250 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 8 Sep 2025 21:52:12 +0000 Subject: [PATCH 3/3] Clean up demo files and finalize FAQ HTML structure implementation Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com> --- faq_demo.html | 143 -------------------------------------------------- 1 file changed, 143 deletions(-) delete mode 100644 faq_demo.html diff --git a/faq_demo.html b/faq_demo.html deleted file mode 100644 index f5c7a157..00000000 --- a/faq_demo.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - Enhanced Open Game Panel FAQ - - - - -

    F.A.Q.

    -
    - 📋 Categories - -
    -
    - - - -
    - -
    📋 Panel Overview
    -
    What is the Open Game Panel?
    -
    -
    The Open Game Panel (OGP) is a web-based control panel for managing game servers. It provides an easy-to-use interface for starting, stopping, configuring, and monitoring your game servers without needing command-line access.
    -
    -
    How do I navigate the panel?
    -
    -
    The panel is organized into several main sections accessible from the navigation menu:
    - • Dashboard - Overview of your servers and system status
    - • Game Servers - Manage your game server instances
    - • File Manager - Browse and edit server files
    - • User Management - Control user access and permissions
    - • Administration - System settings and configuration
    -
    - -
    🎮 Server Management
    -
    How do I start my game server?
    -
    -
    Navigate to Game Manager → Server Monitor, then click the Start button. Wait for the status to change to "Online" before attempting to connect.
    -
    -
    What if my server won't start?
    -
    -
    Check the server logs for error messages by clicking View Log. Common issues include:
    - • Misconfigured settings
    - • Missing or corrupted files
    - • Port conflicts
    - • Insufficient system resources
    - If the problem persists, check the troubleshooting section or contact support.
    -
    - -
    📁 File Management
    -
    How do I access server files?
    -
    -
    Use the File Manager (LiteFM) to browse, edit, upload, and download server files through your web browser. You can also use the FTP module for bulk file transfers.
    -
    - -
    🔧 Troubleshooting
    -
    My server won't start - "Failed to start remote server" error
    -
    -
    This error usually means:
    - • The server crashed during startup
    - • Configuration files have syntax errors
    - • Required files are missing or corrupted
    - Solution: Check the server logs for specific error messages, verify your configuration files, and ensure all required game files are present.
    -
    - -
    - -
    -
    - Open Game Panel - Enhanced HTML FAQ System
    - Comprehensive documentation for all panel modules and features -
    -
    - - - \ No newline at end of file