GSP/Panel

copilot-swe-agent[bot] c56343cbc5 Add comprehensive documentation and project analysis

Co-authored-by: iaretechnician <2749183+iaretechnician@users.noreply.github.com>

2025-09-05 12:00:35 +00:00

6.6 KiB

Raw Blame History

Open Game Panel Development Guide

Understanding the Codebase

This guide helps developers understand and work with the Open Game Panel codebase effectively.

Component Integration

How the Web Panel and Agents Work Together

Agent Registration
- Agents are registered through the web panel's administration interface
- Each agent requires: IP address, port, encryption key, connection timeout
- Agent connectivity is tested during registration

Command Flow

User Action (Web UI) → Web Panel → Encrypted Command → Agent → Game Server
                               ← Encrypted Response ←       ←

Data Synchronization
- Web panel maintains server state in MySQL database
- Agents report status updates to panel
- File changes are synchronized between panel and agents

Key Integration Points

Game Server Management:

modules/server/server.php - Server control interface
includes/lib_remote.php - Agent communication
Database tables: ogp_servers, ogp_games, ogp_user_games

File Management:

modules/ftp/ - Web-based file manager
modules/litefm/ - Alternative file manager
Agents handle actual file operations on remote systems

Configuration Management:

modules/editconfigfiles/ - Config file editor
modules/gamemanager/ - Game templates and settings
Agents apply configurations to game servers

Database Schema Overview

Core Tables

ogp_servers - Game server instances

- server_id (Primary Key)
- agent_id (Foreign Key to ogp_agents)
- user_id (Foreign Key to ogp_users)
- game_id (Foreign Key to ogp_games)
- server_name, ip, port, home_path, etc.

ogp_agents - Remote agent machines

- agent_id (Primary Key)
- agent_name, agent_ip, agent_port
- encryption_key, timeout
- os_type (linux/windows)

ogp_games - Game definitions

- game_id (Primary Key)
- game_name, installer_name
- cfg_template, startup_cmd
- platform (linux/windows/both)

ogp_users - Panel users

- user_id (Primary Key)
- username, password_hash
- user_email, access_rights

Agent Communication Deep Dive

Encryption Protocol

// lib_remote.php - Example encryption
$enc = new Crypt_XXTEA();
$enc->setKey($encryption_key);
$encrypted_data = $enc->encrypt($command_json);

Command Structure

{
  "action": "server_action",
  "parameters": {
    "home_id": "123",
    "action": "start"
  }
}

Response Format

{
  "status": "success|error",
  "message": "Operation completed",
  "data": {...}
}

Module Development

Creating a New Module

Directory Structure

modules/mymodule/
├── mymodule.php        # Main module file
├── install.xml         # Installation metadata
└── lang/              # Language files
    └── English/
        └── modules/
            └── mymodule.php

Module Template

<?php
// modules/mymodule/mymodule.php

// Security check
if (!defined('OGP_LANG')) {
    exit('Direct access not allowed');
}

// Module initialization
function exec_ogp_module() {
    global $db, $view;

    // Module logic here
}
?>

Language File

<?php
// lang/English/modules/mymodule.php
define('OGP_LANG_mymodule_title', 'My Module');
define('OGP_LANG_mymodule_description', 'Module description');
?>

Module Registration

Modules are auto-discovered from the modules/ directory and registered in the database.

Common Development Tasks

Adding a New Game

Create game definition in modules/gamemanager/
Add server configuration templates
Test installation and startup procedures
Add game-specific configuration files

Extending the API

Add new endpoints to ogp_api.php
Implement authentication checks
Add request validation
Document API changes

Creating Custom Themes

Copy existing theme from themes/
Modify CSS and template files
Test responsive design
Add theme metadata

Debugging Guide

Web Panel Debugging

Enable Debug Mode:

// index.php - Change error reporting
error_reporting(E_ALL);
ini_set('display_errors', 1);

Database Queries:

// Add to functions.php for query debugging
$db->debug = true;

Agent Communication:

// lib_remote.php - Add debugging
echo "Sending command: " . $command . "\n";
echo "Response: " . $response . "\n";

Common Issues

Agent Connection Failures:

Check firewall settings on agent machine
Verify encryption key matches
Test network connectivity
Check agent process is running

Game Server Won't Start:

Verify game files are installed correctly
Check server configuration files
Review agent logs for errors
Validate file permissions

Database Errors:

Check database credentials in config.inc.php
Verify table structure is up to date
Review MySQL error logs
Test database connectivity

Testing Procedures

Manual Testing Checklist

Panel Functionality:

User login/logout
Server creation/deletion
Agent management
File operations
Game installation