multiplayer 1.0.0

Library that allows you to manage multiple players, locally, on a network, or on the Internet.

English | Español | Français

Multiplayer Game Manager

A Note on this Project's Origin

This project is primarily the result of a series of experiments using Gemini Code Assist for code generation and error handling. Rather than using it on academic examples, it seemed more interesting to apply it to a project that could meet a real practical need.

This, therefore, is the reason for multiplayer's existence: you can dissect the code to see how Gemini (with my guidance) went about building it, or you can ignore all that and just use this library for your own needs!

This Python module provides a simple and flexible framework for managing multiplayer games, both locally and over a network.

For a detailed technical description of all classes and functions, see the API Reference.

Features

• Local & Networked: Use in a single process or in a client-server architecture.
• Combined Game State: A flexible system for synchronizing both the core game status (e.g., in_progress) and any custom game data.
• Observer Support: Ability to add observers who can view the game state without participating as players.
• Administrator Role: New ServerAdmin class to manage the server, kick players/observers, and monitor server status.
• Game Grouping: Organize several game sessions within the same server using the GameGroup class.
• Multi-Layered Security: Supports server passwords, admin passwords, and per-game passwords, with optional TLS v1.3 encryption. Passwords can be updated dynamically by administrators.
• Automatic Server Discovery: Clients can automatically find running servers on the local network.
• Extensible Name Suggestions: Includes a utility function to suggest creative names for games and players.
• Multiple Games: The server can manage multiple game sessions simultaneously. By default, the game list for standard clients is filtered to hide finished games, but administrators can access all sessions via specialized methods like list_all_server_games() or list_all_group_games().
• Robust Error Handling: A clear set of custom exceptions for both game logic and network issues.
• Persistent Player Accounts: Ability for players to create an account with a password for repeated use across the server.

Installation

You can install it in two ways:

1. From PyPI

pip install multiplayer

2. From a Wheel file (GitHub)

Download the .whl file from the Releases page and run:

pip install multiplayer-1.0.0-py3-none-any.whl

Replace multiplayer-1.0.0-py3-none-any.whl with the actual name of the downloaded file.

Usage

Game State Management

A key feature is the ability to manage your own game state alongside the core game status.

# On one client, set a custom state
game.set_state({
    "board": [["X", "O", ""], ["", "X", ""], ["O", "", ""]],
    "turn": "player2"
})

# On another client, retrieve the combined state
full_state = game.state
print(f"Game status: {full_state['status']}")
# > Game status: in_progress

print(f"Current turn: {full_state['custom']['turn']}")
# > Current turn: player2

Game Grouping

You can group games together for better organization.

from multiplayer import Game, GameGroup

# Create a group
group = GameGroup("Tournament A", priority="high")

# Add games to the group
game1 = Game("Match 1")
game2 = Game("Match 2")
group.add_game(game1)
group.add_game(game2)

print(f"Game 1 ID: {game1.ID}")
# > Game 1 ID: 550e8400-e29b-41d4-a716-446655440000

print(f"Group '{group.name}' has {len(group.games)} games.")
# > Group 'Tournament A' has 2 games.

Full Test Environment

A script is available to launch a complete test environment with:

• An IPC log server (IPClogging) in a separate window.
• A game server.
• Multiple separate client instances (default is 2) simulating a game, each in its own terminal window.

To run it:

uv run python scripts/full_test_env.py

To specify the number of players:

uv run python scripts/full_test_env.py --players 3

This will open several Windows Terminal windows: one for the log server and one for each client instance, allowing you to see the real-time interactions and logs.

Local Usage

You can use the Game class directly, including with a password for local validation.

from multiplayer import Game, Player, suggest_game_name

game = Game(name="My Awesome Game", password="local_game_pass")
game.add_player(Player("Alice"), password="local_game_pass")
game.start()

Networked Usage (Client-Server)

Server Setup

from multiplayer import GameServer

# Start a secure server with a custom domain and self-signed certificate
server = GameServer(
    host='0.0.0.0',
    port=12345,
    name="My Production Server",
    password="my_server_password",
    admin_password="my_admin_password",
    use_tls=True,
    tls_domain="example.com",
    tls_self_signed=True
)
server.start()

# Or use existing certificate files
server = GameServer(
    use_tls=True,
    tls_cert="path/to/cert.pem",
    tls_key="path/to/key.pem",
    tls_self_signed=False
)

Running with Docker

You can run the game server using Docker. To use your own TLS certificates, map a local directory containing cert.pem and privkey.pem to /app/certs in the container.

docker run -d \
  -p 65432:65432 \
  -v /path/to/your/certs:/app/certs \
  ghcr.io/yourusername/multiplayer-server:latest \
  --name "My Docker Server" \
  --use-tls --no-self-signed

The server will automatically look for cert.pem, RSA-cert.pem, or ECC-cert.pem (and their corresponding keys) in the /app/certs directory.

Administrator Usage

from multiplayer import ServerAdmin

# Connect as administrator
admin = ServerAdmin(
    host='localhost',
    port=12345,
    admin_password="my_admin_password",
    use_tls=True
)

# Manage the server
info = admin.get_server_info()
print(f"Uptime: {info['uptime']} seconds")

# Kick a player if necessary
# admin.kick_player(game_id, player_id)

# Stop the server remotely
# admin.stop_server()

Client Usage

from multiplayer import GameClient, Player, suggest_game_name

# 1. Discover and connect to the server
servers = GameClient.discover_servers()
if not servers:
    print("No servers found.")
else:
    host, port, name = servers[0]
    client = GameClient(
        host=host,
        port=port,
        password="my_server_password",
        use_tls=True
    )

    # 2. Create a private game
    private_game = client.create_game(
        name=suggest_game_name(),
        password="my_game_password"
    )
    print(f"Created game with ID: {private_game.game_id}")

    # 3. Create and use a Game Group
    remote_group = client.create_group("Tournament A")
    game_in_group = remote_group.create_game(name="Final Match")
    # To get the group ID or name, we use the properties
    print(f"Game in group '{remote_group.name}' has ID: {game_in_group.game_id}")

    # 4. A player joins and sets the initial state
    private_game.add_player(Player("Charlie"), password="my_game_password")
    private_game.set_state({"score": 0})
    private_game.start()

Name Suggestions

The multiplayer package includes a powerful name suggestion utility to help you create creative names for games and players.

from multiplayer import suggest_game_name, suggest_player_name

# Get a random name
print(suggest_game_name())    # e.g., "Pacific Ocean"
print(suggest_player_name())  # e.g., "Zeus"

# Specify a category
print(suggest_game_name(category="planets_moons")) # e.g., "Europa"
print(suggest_player_name(category="european_queens")) # e.g., "Elizabeth I"

Built-in Categories

• For Games: cities, countries, rivers, seas_oceans, planets_moons.
• For Players: roman_gods, greek_gods, egyptian_gods, european_kings, european_queens.

Custom Categories

You can also register your own categories using a list of names or a file:

from multiplayer import register_name_category

# Register from a list
register_name_category("monsters", ["Godzilla", "King Kong"], category_type="player")

# Register from a text/CSV file
register_name_category("races", "path/to/races.txt", category_type="player")

Error Handling

The module provides a set of custom exceptions, including AuthenticationError for both server and game passwords.

from multiplayer import GameClient
from multiplayer.exceptions import ConnectionError, AuthenticationError

try:
    # ... connect to client ...

    # Try to join a game with the wrong password
    game.add_player(Player("Eve"), password="wrong_game_password")

except AuthenticationError as e:
    print(f"Authentication failed as expected: {e}")
except ConnectionError as e:
    print(f"A connection or discovery error occurred: {e}")

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details on how to get started.

Running Tests

To run the unit tests, you will need to have pytest installed.

pip install pytest

Then, you can run the tests from the root of the project:

pytest

License

This project is licensed under the MIT License - see the LICENSE.md file for details.