multiplayer 0.11.0__py3-none-any.whl

multiplayer/data/rivers.csv

@@ -0,0 +1,103 @@
+name
+Nile
+Amazon
+Yangtze
+Mississippi
+Yenisei
+Yellow River
+Ob
+Parana
+Congo
+Amur
+Lena
+Mekong
+Mackenzie
+Niger
+Murray
+Tocantins
+Volga
+Shatt al-Arab
+Madeira
+Purus
+Yukon
+Indus
+Sao Francisco
+Syr Darya
+Salween
+Saint Lawrence
+Rio Grande
+Lower Tunguska
+Brahmaputra
+Danube
+Zambezi
+Vilyuy
+Araguaia
+Nelson
+Paraguay
+Kolyma
+Ganges
+Amu Darya
+Japura
+Ural
+Arkansas
+Colorado
+Dnieper
+Aldan
+Ubangi
+Negro
+Orinoco
+Irtysh
+Xingu
+Salado
+Tigris
+Songhua
+Tapajos
+Don
+Pechora
+Kama
+Liao
+Zeya
+Kasai
+Ohio
+Iriri
+Tarim
+Vitim
+Tunguska
+Euphrates
+Godavari
+Krishna
+Indigirka
+Saskatchewan
+Peace
+Orange
+Olenyok
+Jubba
+Magdalena
+Lomami
+Ogooue
+Pecos
+Kura
+Columbia
+Sankuru
+Ishim
+Jialing
+Benue
+Guapore
+Yamuna
+Senegal
+Churchill
+Tobol
+Alazeya
+Han
+Khatanga
+Olekma
+Platte
+Trisuli
+Ica
+Mara
+Vaal
+Okavango
+Limpopo
+Helmand
+Cunene
+Chari

multiplayer/data/roman_gods.csv

@@ -0,0 +1,109 @@
+name
+Jupiter
+Juno
+Neptune
+Minerva
+Apollo
+Diana
+Mars
+Venus
+Mercury
+Vesta
+Ceres
+Vulcan
+Bacchus
+Pluto
+Proserpina
+Saturn
+Uranus
+Janus
+Cupid
+Psyche
+Sol
+Luna
+Fortuna
+Victoria
+Concordia
+Fides
+Spes
+Salus
+Pax
+Libertas
+Honos
+Virtus
+Pietas
+Felicitas
+Genius
+Lares
+Penates
+Manes
+Faunus
+Flora
+Pomona
+Vertumnus
+Terminus
+Consus
+Ops
+Portunus
+Carmenta
+Bellona
+Quirinus
+Volturnus
+Tiberinus
+Aesculapius
+Hercules
+Castor
+Pollux
+Aeneas
+Romulus
+Remus
+Numa
+Camenae
+Egeria
+Muses
+Graces
+Fates
+Furies
+Horae
+Nymphs
+Sylvanus
+Tellus
+Maia
+Acca Larentia
+Anna Perenna
+Cardea
+Carna
+Clementia
+Disciplina
+Eventus Bonus
+Febris
+Feronia
+Fons
+Furrina
+Justitia
+Laetitia
+Laverna
+Libitina
+Mellona
+Muta
+Nemesis
+Nox
+Pales
+Robigo
+Rumina
+Rusina
+Securitas
+Trivia
+Veritas
+Voluptas
+Volturna
+Angerona
+Bubona
+Candelifera
+Lucina
+Mena
+Nascio
+Partula
+Strenia
+Viduus
+Volumnus

multiplayer/data/seas_oceans.csv

@@ -0,0 +1,104 @@
+name
+Pacific Ocean
+Atlantic Ocean
+Indian Ocean
+Arctic Ocean
+Southern Ocean
+Mediterranean Sea
+Caribbean Sea
+South China Sea
+Bering Sea
+Gulf of Mexico
+Okhotsk Sea
+East China Sea
+Hudson Bay
+Japan Sea
+Andaman Sea
+North Sea
+Red Sea
+Baltic Sea
+Black Sea
+Arabian Sea
+Coral Sea
+Tasman Sea
+Philippine Sea
+Sargasso Sea
+Greenland Sea
+Barents Sea
+Kara Sea
+Laptev Sea
+East Siberian Sea
+Chukchi Sea
+Beaufort Sea
+Lincoln Sea
+Wandel Sea
+Norwegian Sea
+Irish Sea
+Celtic Sea
+English Channel
+Bay of Biscay
+Adriatic Sea
+Aegean Sea
+Ionian Sea
+Tyrrhenian Sea
+Ligurian Sea
+Alboran Sea
+Balearic Sea
+Sea of Crete
+Sea of Marmara
+Sea of Azov
+Caspian Sea
+Aral Sea
+Salton Sea
+Dead Sea
+Sea of Galilee
+White Sea
+Pechora Sea
+Timor Sea
+Arafura Sea
+Banda Sea
+Celebes Sea
+Sulu Sea
+Molucca Sea
+Java Sea
+Flores Sea
+Savu Sea
+Halmahera Sea
+Ceram Sea
+Bismarck Sea
+Solomon Sea
+Gulf of Carpentaria
+Gulf of Thailand
+Gulf of Tonkin
+Yellow Sea
+Bohai Sea
+Seto Inland Sea
+Sea of Japan
+Gulf of Alaska
+Gulf of California
+Labrador Sea
+Irminger Sea
+Davis Strait
+Baffin Bay
+James Bay
+Gulf of St. Lawrence
+Bay of Fundy
+Sunda Strait
+Makassar Strait
+Lombok Strait
+Malacca Strait
+Singapore Strait
+Palk Strait
+Bab-el-Mandeb
+Strait of Hormuz
+Persian Gulf
+Gulf of Oman
+Gulf of Aden
+Gulf of Guinea
+Mozambique Channel
+Great Australian Bight
+Spencer Gulf
+Gulf St Vincent
+Bass Strait
+Cook Strait
+Foveaux Strait

multiplayer/exceptions.py

@@ -0,0 +1,39 @@
+"""
+Custom exceptions for the multiplayer module.
+"""
+
+class MultiplayerError(Exception):
+    """Base class for exceptions in this module."""
+    pass
+
+class GameLogicError(MultiplayerError):
+    """Raised for errors in game logic (e.g., starting a game with no players)."""
+    pass
+
+class PlayerLimitReachedError(GameLogicError):
+    """Raised when trying to add a player to a full game."""
+    pass
+
+class ObserverLimitReachedError(GameLogicError):
+    """Raised when trying to add an observer to a full game."""
+    pass
+
+class GameNotFoundError(MultiplayerError):
+    """Raised when a game_id is not found on the server."""
+    pass
+
+class NetworkError(MultiplayerError):
+    """Base class for network-related errors."""
+    pass
+
+class ConnectionError(NetworkError):
+    """Raised for errors connecting to the server."""
+    pass
+
+class ServerError(NetworkError):
+    """Raised when the server reports a generic internal error."""
+    pass
+
+class AuthenticationError(NetworkError):
+    """Raised for password authentication failures."""
+    pass

multiplayer/game.py

@@ -0,0 +1,275 @@
+"""
+This module provides classes for managing a multiplayer game.
+"""
+
+import enum
+import uuid
+from .exceptions import GameLogicError, PlayerLimitReachedError, ObserverLimitReachedError, AuthenticationError
+
+class GameState(enum.Enum):
+    """
+    Represents the state of the game.
+    """
+    PENDING = "pending"
+    IN_PROGRESS = "in_progress"
+    FINISHED = "finished"
+
+class Player:
+    """
+    Represents a player in the game.
+
+    Args:
+        name (str): The name of the player.
+        id (str, optional): The player's ID.
+        **kwargs: Additional attributes for the player.
+    """
+    def __init__(self, name, id=None, **kwargs):
+        self.name = name
+        self.attributes = kwargs
+        self._id = id or str(uuid.uuid4())
+
+    @property
+    def ID(self):
+        """
+        The unique ID of the player.
+        """
+        return self._id
+
+class GameGroup:
+    """
+    Represents a group of games on a server.
+
+    Args:
+        name (str): The name of the group.
+        admin_password (str, optional): A password for administrative actions on this group.
+        **kwargs: Additional attributes for the group.
+    """
+    def __init__(self, name, admin_password=None, **kwargs):
+        self.name = name
+        self.admin_password = admin_password
+        self.attributes = kwargs
+        self.games = []
+        self._id = str(uuid.uuid4())
+
+    @property
+    def ID(self):
+        """
+        The unique ID of the group.
+        """
+        return self._id
+
+    def add_game(self, game):
+        """
+        Adds a game to the group.
+
+        Args:
+            game (Game): The game to add.
+        """
+        if game not in self.games:
+            self.games.append(game)
+
+    def remove_game(self, game_id):
+        """
+        Removes a game from the group by ID.
+
+        Args:
+            game_id (str): The ID of the game to remove.
+        """
+        game_to_remove = next((g for g in self.games if g.ID == game_id), None)
+        if game_to_remove:
+            self.games.remove(game_to_remove)
+
+class Observer:
+    """
+    Represents an observer in the game.
+
+    Args:
+        name (str): The name of the observer.
+        id (str, optional): The observer's ID.
+        **kwargs: Additional attributes for the observer.
+    """
+    def __init__(self, name, id=None, **kwargs):
+        self.name = name
+        self.attributes = kwargs
+        self._id = id or str(uuid.uuid4())
+
+    @property
+    def ID(self):
+        """
+        The unique ID of the observer.
+        """
+        return self._id
+
+class Game:
+    """
+    Represents a multiplayer game.
+
+    Args:
+        name (str, optional): The name of the game session. Defaults to None.
+        max_players (int, optional): The maximum number of players allowed in the game. Defaults to None.
+        max_observers (int, optional): The maximum number of observers allowed in the game. Defaults to None.
+        turn_based (bool, optional): Whether the game is turn-based or simultaneous. Defaults to False.
+        password (str, optional): A password to protect this specific game.
+        **kwargs: Additional attributes for the game.
+    """
+    def __init__(self, name=None, max_players=None, max_observers=None, turn_based=False, password=None, observer_password=None, **kwargs):
+        self.name = name
+        self.max_players = max_players
+        self.max_observers = max_observers
+        self.turn_based = turn_based
+        self.password = password
+        self.observer_password = observer_password
+        self.attributes = kwargs
+        self.players = []
+        self.observers = []
+        self.state = GameState.PENDING
+        self.current_player_index = 0
+        self.custom_state = {}
+        self._id = str(uuid.uuid4())
+
+    @property
+    def ID(self):
+        """
+        The unique ID of the game.
+        """
+        return self._id
+
+    def add_player(self, player, password=None):
+        """
+        Adds a player to the game.
+
+        Args:
+            player (Player): The player to add.
+            password (str, optional): The password required to join the game.
+
+        Raises:
+            AuthenticationError: If the provided password does not match the game's password.
+            PlayerLimitReachedError: If the maximum number of players has been reached.
+        """
+        if self.password is not None and self.password != password:
+            raise AuthenticationError("Invalid password for this game")
+        if self.max_players is not None and len(self.players) >= self.max_players:
+            raise PlayerLimitReachedError("Maximum number of players reached")
+        self.players.append(player)
+
+    def add_observer(self, observer, password=None):
+        """
+        Adds an observer to the game.
+
+        Args:
+            observer (Observer): The observer to add.
+            password (str, optional): The password required to join the game as an observer.
+
+        Raises:
+            AuthenticationError: If the provided password does not match the observer password (or game password if no observer password is set).
+            ObserverLimitReachedError: If the maximum number of observers has been reached.
+        """
+        required_password = self.observer_password if self.observer_password is not None else self.password
+        if required_password is not None and required_password != password:
+            raise AuthenticationError("Invalid password for this game")
+        if self.max_observers is not None and len(self.observers) >= self.max_observers:
+            raise ObserverLimitReachedError("Maximum number of observers reached")
+        self.observers.append(observer)
+
+    def remove_player(self, player_id):
+        """
+        Removes a player from the game by ID.
+
+        Args:
+            player_id (str): The ID of the player to remove.
+        """
+        player_to_remove = next((p for p in self.players if p.ID == player_id), None)
+        if player_to_remove:
+            removed_player_index = self.players.index(player_to_remove)
+            self.players.remove(player_to_remove)
+            
+            if self.turn_based and self.state == GameState.IN_PROGRESS:
+                if not self.players:
+                    self.state = GameState.PENDING
+                elif self.current_player_index >= removed_player_index:
+                    self.current_player_index = self.current_player_index % len(self.players)
+
+    def remove_observer(self, observer_id):
+        """
+        Removes an observer from the game by ID.
+
+        Args:
+            observer_id (str): The ID of the observer to remove.
+        """
+        observer_to_remove = next((o for o in self.observers if o.ID == observer_id), None)
+        if observer_to_remove:
+            self.observers.remove(observer_to_remove)
+
+    def start(self):
+        """
+        Starts the game.
+
+        Raises:
+            GameLogicError: If there are no players in the game or if the game is already in progress.
+        """
+        if self.state == GameState.IN_PROGRESS:
+            raise GameLogicError("Game is already in progress")
+        if not self.players:
+            raise GameLogicError("Cannot start a game with no players")
+        self.state = GameState.IN_PROGRESS
+
+    def pause(self):
+        """
+        Pauses the game.
+
+        Raises:
+            GameLogicError: If the game is not in progress.
+        """
+        if self.state != GameState.IN_PROGRESS:
+            raise GameLogicError("Game is not in progress")
+        self.state = GameState.PENDING
+
+    def resume(self):
+        """
+        Resumes the game.
+
+        Raises:
+            GameLogicError: If the game is not pending.
+        """
+        if self.state != GameState.PENDING:
+            raise GameLogicError("Game is not pending")
+        self.state = GameState.IN_PROGRESS
+
+    def stop(self):
+        """
+        Stops the game.
+        """
+        self.state = GameState.FINISHED
+
+    def next_turn(self):
+        """
+        Advances to the next turn in a turn-based game.
+
+        Raises:
+            GameLogicError: If the game is not turn-based or not in progress.
+        """
+        if not self.turn_based:
+            raise GameLogicError("Game is not turn-based")
+        if self.state != GameState.IN_PROGRESS:
+            raise GameLogicError("Game is not in progress")
+        if self.players:
+            self.current_player_index = (self.current_player_index + 1) % len(self.players)
+
+    @property
+    def current_player(self):
+        """
+        The current player in a turn-based game.
+
+        Returns:
+            Player: The current player.
+
+        Raises:
+            GameLogicError: If the game is not turn-based or not in progress.
+        """
+        if not self.turn_based:
+            raise GameLogicError("Game is not turn-based")
+        if self.state != GameState.IN_PROGRESS:
+            raise GameLogicError("Game is not in progress")
+        if not self.players:
+            return None
+        return self.players[self.current_player_index]

multiplayer/language/__init__.py

@@ -0,0 +1,23 @@
+"""
+multiplayer, a Python library for managing multiplayer games
+Copyright (C) 2025 [devfred78](https://github.com/devfred78)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+This package provides tools for managing interface languages.
+"""
+
+from .language import Language, Languages
+
+__all__ = ["Language", "Languages"]