GameBridge

GameBridge is a flexible and easy to use application designed to manage game servers, like Minecraft, Project Zomboid or Valheim remotely. It provides a seamless interface to interact with game server executables from a socket connection, featuring basic authentication, real-time input/output management, and multi-executable support.

Features

• Multi-Executable Management: Run and manage multiple game server executables simultaneously.
• Real-Time Communication: Send commands and receive output from game servers in real-time.
• Basic Authentication: Secure access to your game servers with username and password.
• Start-on-Demand or Immediately: Start executables automatically or wait for client connections.
• Cross-Platform Support: Compatible with Windows, macOS, and Linux.

Use Cases

GameBridge is ideal for:

• Managing Minecraft servers or other game servers.
• Providing a centralized interface for server monitoring and control.
• Offering secure, authenticated access to server admins.

---

Installation

Run as script

1. Clone the Repository:

   git clone https://github.com/SRCthird/GameBridge.git
   cd GameBridge

2. Install Dependencies: Ensure you have Python 3.12+ installed. This was created entirely with the standard library, so no pip installation required

3. Run the Application:

   # Update gamebridge.py
   python gamebridge.py

Build as package

1. Clone the Repository:

   git clone https://github.com/SRCthird/GameBridge.git
   cd GameBridge

2. Install Dependencies: Ensure you have Python 3.12+ installed.

   pip install build
   

3. Run the Application:

   pip -m build

4. Install the package:

   pip install dist/GameBridge-0.1.0-py3-none-any.whl

---

Usage

Adding Game Servers

To add game servers (executables), modify the gamebridge.py file or use the template in the Example section below.

gb=GameBridge(port=12345)
gb.set_credentials("admin", "password")
gb.add_server(
name="Minecraft Vanilla",
exe_path="/usr/bin/java",
args=["-Xmx2G", "-Xms2G", "-jar", "server.jar"],
working_dir="/path/to/server1/",
start_immediately=True
)
gb.add_server(
name="Minecraft Creative",
exe_path="/usr/bin/java",
args=["-Xmx2G", "-Xms2G", "-jar", "server.jar"],
working_dir="/path/to/server2/",
start_immediately=False
)
gb.start()

Authentication

GameBridge requires basic authentication. Set usernames and passwords using the set_credentials method. Credentials are stored securely using SHA-256 hashing.

---

Communication

Connecting to GameBridge

Use a terminal or a custom client to connect to GameBridge:

1. Connect via Socket:

   ncat <host><port>

2. Authenticate: Enter your username and password.

3. Select a Server: Choose an available executable to interact with.

4. Send Commands: Type commands to send to the game server (e.g., say Hello Players! for Minecraft).

---

Example Workflow

1. Client Connects:

   $ nc 127.0.0.1 12345
   

2. Authentication:

   Username: admin
   Password: ********
   Authentication successful.
   

3. Select a Server:

   Available executables:
   - Minecraft Vanilla - Minecraft Creative
   Enter the name of the executable to attach:
   Minecraft Vanilla 

4. Interact with the Server:

   say Hello Players
   [Minecraft Vanilla] [Server] Hello Players
   

---

Contributing

We welcome contributions! To get started:

1. Fork the repository.
2. Create a new branch for your feature/bugfix.
3. Submit a pull request.

---

License

GameBridge is licensed under the MIT License.

---

Future Plans

• Add support for advanced server analytics/logging.
• Enhance authentication.
• Web-based UI for easier management - probably dango or something.