multiplayer 0.12.0__tar.gz → 1.1.0__tar.gz

{multiplayer-0.12.0 → multiplayer-1.1.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: multiplayer
-Version: 0.12.0
+Version: 1.1.0
 Summary: Library that allows you to manage multiple players, locally, on a network, or on the Internet.
 License-Expression: MIT
 License-File: LICENSE.md
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Games/Entertainment
 Requires-Dist: colorlog
 Requires-Dist: cryptography
+Requires-Dist: bcrypt
 Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: requests ; extra == 'dev'
 Requires-Dist: ruff ; extra == 'dev'
@@ -20,7 +21,7 @@ Requires-Python: >=3.12
 Provides-Extra: dev
 Description-Content-Type: text/markdown
 
-**English** | [Español](translation/README.es.md) | [Français](translation/README.fr.md)
+**English** | [Español](translation/README.es.md) | [Français](translation/README.fr.md)
 
 # Multiplayer Game Manager
 
@@ -41,12 +42,13 @@ For a detailed technical description of all classes and functions, see the [API
 *   **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.
+*   **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 and are securely stored using `bcrypt` hashing.
 *   **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, and the game list is now filtered to hide finished games.
+*   **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.
+*   **Persistent Player Accounts:** Ability for players to create an account with a password for repeated use across the server. All persistent passwords (players, groups, and server) are protected with `bcrypt`.
+*   **Data Persistence:** Optional support for persisting server configuration, player accounts, and game sessions to disk (e.g., in JSON format). Hash-based password storage ensures security even if the data file is compromised.
 
 ## Installation
 
@@ -60,9 +62,9 @@ pip install multiplayer
 ### 2. From a Wheel file (GitHub)
 Download the `.whl` file from the [Releases](https://github.com/devfred78/multiplayer/releases) page and run:
 ```sh
-pip install multiplayer-0.12.0-py3-none-any.whl
+pip install multiplayer-1.1.0-py3-none-any.whl
 ```
-*Replace `multiplayer-0.12.0-py3-none-any.whl` with the actual name of the downloaded file.*
+*Replace `multiplayer-1.1.0-py3-none-any.whl` with the actual name of the downloaded file.*
 
 ## Usage
 
@@ -103,7 +105,7 @@ game2 = Game("Match 2")
 group.add_game(game1)
 group.add_game(game2)
 
-print(f"Game 1 ID: {game1.ID}")
+print(f"Game 1 ID: {game1.game_id}")
 # > Game 1 ID: 550e8400-e29b-41d4-a716-446655440000
 
 print(f"Group '{group.name}' has {len(group.games)} games.")
@@ -199,11 +201,7 @@ admin = ServerAdmin(
 
 # Manage the server
 info = admin.get_server_info()
-print(f"Active games: {info['games_count']}")
-
-# Check certificate expiration
-expiration = admin.get_cert_expiration()
-print(f"Certificate expires on: {expiration}")
+print(f"Uptime: {info['uptime']} seconds")
 
 # Kick a player if necessary
 # admin.kick_player(game_id, player_id)
@@ -221,7 +219,7 @@ servers = GameClient.discover_servers()
 if not servers:
     print("No servers found.")
 else:
-    host, port = servers[0]
+    host, port, name = servers[0]
     client = GameClient(
         host=host,
         port=port,
@@ -234,12 +232,13 @@ else:
         name=suggest_game_name(),
         password="my_game_password"
     )
-    print(f"Created game with ID: {private_game.ID}")
+    print(f"Created game with ID: {private_game.game_id}")
 
     # 3. Create and use a Game Group
-    group = client.create_group("Tournament A")
-    game_in_group = group.create_game(name="Final Match")
-    print(f"Game in group '{group.name}' has ID: {game_in_group.ID}")
+    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")
@@ -247,6 +246,39 @@ else:
     private_game.start()
 ```
 
+### Name Suggestions
+
+The `multiplayer` package includes a powerful name suggestion utility to help you create creative names for games and players.
+
+```python
+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:
+
+```python
+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.
@@ -282,4 +314,9 @@ pip install pytest
 Then, you can run the tests from the root of the project:
 
 ```sh
-pytest
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

{multiplayer-0.12.0 → multiplayer-1.1.0}/README.md

@@ -1,4 +1,4 @@
-**English** | [Español](translation/README.es.md) | [Français](translation/README.fr.md)
+**English** | [Español](translation/README.es.md) | [Français](translation/README.fr.md)
 
 # Multiplayer Game Manager
 
@@ -19,12 +19,13 @@ For a detailed technical description of all classes and functions, see the [API
 *   **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.
+*   **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 and are securely stored using `bcrypt` hashing.
 *   **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, and the game list is now filtered to hide finished games.
+*   **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.
+*   **Persistent Player Accounts:** Ability for players to create an account with a password for repeated use across the server. All persistent passwords (players, groups, and server) are protected with `bcrypt`.
+*   **Data Persistence:** Optional support for persisting server configuration, player accounts, and game sessions to disk (e.g., in JSON format). Hash-based password storage ensures security even if the data file is compromised.
 
 ## Installation
 
@@ -38,9 +39,9 @@ pip install multiplayer
 ### 2. From a Wheel file (GitHub)
 Download the `.whl` file from the [Releases](https://github.com/devfred78/multiplayer/releases) page and run:
 ```sh
-pip install multiplayer-0.12.0-py3-none-any.whl
+pip install multiplayer-1.1.0-py3-none-any.whl
 ```
-*Replace `multiplayer-0.12.0-py3-none-any.whl` with the actual name of the downloaded file.*
+*Replace `multiplayer-1.1.0-py3-none-any.whl` with the actual name of the downloaded file.*
 
 ## Usage
 
@@ -81,7 +82,7 @@ game2 = Game("Match 2")
 group.add_game(game1)
 group.add_game(game2)
 
-print(f"Game 1 ID: {game1.ID}")
+print(f"Game 1 ID: {game1.game_id}")
 # > Game 1 ID: 550e8400-e29b-41d4-a716-446655440000
 
 print(f"Group '{group.name}' has {len(group.games)} games.")
@@ -177,11 +178,7 @@ admin = ServerAdmin(
 
 # Manage the server
 info = admin.get_server_info()
-print(f"Active games: {info['games_count']}")
-
-# Check certificate expiration
-expiration = admin.get_cert_expiration()
-print(f"Certificate expires on: {expiration}")
+print(f"Uptime: {info['uptime']} seconds")
 
 # Kick a player if necessary
 # admin.kick_player(game_id, player_id)
@@ -199,7 +196,7 @@ servers = GameClient.discover_servers()
 if not servers:
     print("No servers found.")
 else:
-    host, port = servers[0]
+    host, port, name = servers[0]
     client = GameClient(
         host=host,
         port=port,
@@ -212,12 +209,13 @@ else:
         name=suggest_game_name(),
         password="my_game_password"
     )
-    print(f"Created game with ID: {private_game.ID}")
+    print(f"Created game with ID: {private_game.game_id}")
 
     # 3. Create and use a Game Group
-    group = client.create_group("Tournament A")
-    game_in_group = group.create_game(name="Final Match")
-    print(f"Game in group '{group.name}' has ID: {game_in_group.ID}")
+    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")
@@ -225,6 +223,39 @@ else:
     private_game.start()
 ```
 
+### Name Suggestions
+
+The `multiplayer` package includes a powerful name suggestion utility to help you create creative names for games and players.
+
+```python
+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:
+
+```python
+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.
@@ -260,4 +291,9 @@ pip install pytest
 Then, you can run the tests from the root of the project:
 
 ```sh
-pytest
+pytest
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

{multiplayer-0.12.0 → multiplayer-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "multiplayer"
-version = "0.12.0"
+version = "1.1.0"
 description = "Library that allows you to manage multiple players, locally, on a network, or on the Internet."
 license = "MIT"
 license-files = ["LICENSE.md"]
@@ -8,7 +8,7 @@ author = "devfred78"
 readme = "README.md"
 requires-python = ">=3.12"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
@@ -19,6 +19,7 @@ classifiers = [
 dependencies = [
     "colorlog",
     "cryptography",
+    "bcrypt",
 ]
 
 [project.scripts]
@@ -33,10 +34,15 @@ dev = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.7,<0.12.0"]
+requires = ["uv_build>=0.11.7,<1.1.0"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]
 module-name = "multiplayer"
 module-root = "src"
 package-data = { "multiplayer" = ["data/*.csv"] }
+
+[dependency-groups]
+dev = [
+    "requests>=2.34.1",
+]

{multiplayer-0.12.0 → multiplayer-1.1.0}/src/multiplayer/__init__.py

@@ -1,6 +1,7 @@
 """
 This package provides classes for managing a multiplayer game, both locally and over a network.
 """
+__version__ = "1.1.0"
 from .game import Game, Player, Observer, GameState, GameGroup
 from .server import GameServer
 from .client import GameClient, RemoteGame, ServerAdmin, GroupAdmin
@@ -49,4 +50,5 @@ __all__ = [
     'ConnectionError',
     'ServerError',
     'AuthenticationError',
+    '__version__',
 ]