eolib 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

eolib/protocol/_generated/net/server/stat_skill_accept_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillAcceptServerPacket(Packet):
+    """
+    Response to spending skill points
+    """
     _byte_size: int = 0
     _skill_points: int = None # type: ignore [assignment]
     _spell: Spell = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/stat_skill_junk_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillJunkServerPacket(Packet):
+    """
+    Response to resetting stats and skills at a skill master
+    """
     _byte_size: int = 0
     _stats: CharacterStatsReset = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/stat_skill_open_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillOpenServerPacket(Packet):
+    """
+    Response from talking to a skill master NPC
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _shop_name: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/stat_skill_player_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillPlayerServerPacket(Packet):
+    """
+    Response to spending stat points
+    """
     _byte_size: int = 0
     _stat_points: int = None # type: ignore [assignment]
     _stats: CharacterStatsUpdate = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/stat_skill_remove_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillRemoveServerPacket(Packet):
+    """
+    Response to forgetting a skill at a skill master
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/stat_skill_reply_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillReplyServerPacket(Packet):
+    """
+    Response from unsuccessful action at a skill master
+    """
     _byte_size: int = 0
     _reply_code: SkillMasterReply = None # type: ignore [assignment]
     _reply_code_data: 'StatSkillReplyServerPacket.ReplyCodeData' = None

eolib/protocol/_generated/net/server/stat_skill_take_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillTakeServerPacket(Packet):
+    """
+    Response from learning a skill from a skill master
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _gold_amount: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_admin_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkAdminServerPacket(Packet):
+    """
+    Admin chat message
+    """
     _byte_size: int = 0
     _player_name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_announce_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkAnnounceServerPacket(Packet):
+    """
+    Admin announcement
+    """
     _byte_size: int = 0
     _player_name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_list_server_packet.py

@@ -13,6 +13,10 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkListServerPacket(Packet):
+    """
+    Global chat backfill.
+    Sent by the official game server when a player opens the global chat tab.
+    """
     _byte_size: int = 0
     _messages: list[GlobalBackfillMessage] = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/talk_msg_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkMsgServerPacket(Packet):
+    """
+    Global chat message
+    """
     _byte_size: int = 0
     _player_name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_open_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkOpenServerPacket(Packet):
+    """
+    Party chat message
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_player_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkPlayerServerPacket(Packet):
+    """
+    Public chat message
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_reply_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkReplyServerPacket(Packet):
+    """
+    Reply to trying to send a private message
+    """
     _byte_size: int = 0
     _reply_code: TalkReply = None # type: ignore [assignment]
     _name: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_request_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkRequestServerPacket(Packet):
+    """
+    Guild chat message
+    """
     _byte_size: int = 0
     _player_name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/talk_server_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkServerServerPacket(Packet):
+    """
+    Server message
+    """
     _byte_size: int = 0
     _message: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/talk_spec_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkSpecServerPacket(Packet):
+    """
+    Temporary mute applied
+    """
     _byte_size: int = 0
     _admin_name: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/talk_tell_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkTellServerPacket(Packet):
+    """
+    Private chat message
+    """
     _byte_size: int = 0
     _player_name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/trade_admin_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeAdminServerPacket(Packet):
+    """
+    Trade updated (items changed while trade was accepted)
+    """
     _byte_size: int = 0
     _trade_data: TradeItemData = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/trade_agree_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeAgreeServerPacket(Packet):
+    """
+    Partner agree state updated
+    """
     _byte_size: int = 0
     _partner_player_id: int = None # type: ignore [assignment]
     _agree: bool = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/trade_close_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeCloseServerPacket(Packet):
+    """
+    Partner closed trade window
+    """
     _byte_size: int = 0
     _partner_player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/trade_open_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeOpenServerPacket(Packet):
+    """
+    Trade window opens
+    """
     _byte_size: int = 0
     _partner_player_id: int = None # type: ignore [assignment]
     _partner_player_name: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/trade_reply_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeReplyServerPacket(Packet):
+    """
+    Trade updated (items changed)
+    """
     _byte_size: int = 0
     _trade_data: TradeItemData = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/trade_request_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeRequestServerPacket(Packet):
+    """
+    Trade request from another player
+    """
     _byte_size: int = 0
     _partner_player_id: int = None # type: ignore [assignment]
     _partner_player_name: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/trade_spec_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeSpecServerPacket(Packet):
+    """
+    Own agree state updated
+    """
     _byte_size: int = 0
     _agree: bool = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/trade_use_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeUseServerPacket(Packet):
+    """
+    Trade completed
+    """
     _byte_size: int = 0
     _trade_data: TradeItemData = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/walk_close_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkCloseServerPacket(Packet):
+    """
+    Your character has been frozen
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/walk_open_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkOpenServerPacket(Packet):
+    """
+    Your character has been unfrozen
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/walk_player_server_packet.py

@@ -3,6 +3,7 @@
 # This file should not be modified.
 # Changes will be lost when code is regenerated.
 
+from warnings import warn
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
 from ...direction import Direction
@@ -13,9 +14,12 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkPlayerServerPacket(Packet):
+    """
+    Nearby player has walked
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
-    _Direction: Direction = None # type: ignore [assignment]
+    _direction: Direction = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]
 
     @property
@@ -44,13 +48,32 @@ class WalkPlayerServerPacket(Packet):
         """
         self._player_id = player_id
 
+    @property
+    def direction(self) -> Direction:
+        return self._direction
+
+    @direction.setter
+    def direction(self, direction: Direction) -> None:
+        self._direction = direction
+
     @property
     def Direction(self) -> Direction:
-        return self._Direction
+        """
+        !!! warning "Deprecated"
+
+            Use `direction` instead. (Deprecated since v1.1.0)
+        """
+        warn("'WalkPlayerServerPacket.Direction' is deprecated as of 1.1.0, use 'direction' instead.", DeprecationWarning, stacklevel=2)
+        return self.direction
 
     @Direction.setter
-    def Direction(self, Direction: Direction) -> None:
-        self._Direction = Direction
+    def Direction(self, direction: Direction) -> None:
+        """
+        !!! warning "Deprecated"
+
+            Use `direction` instead. (Deprecated since v1.1.0)
+        """
+        self.direction = direction
 
     @property
     def coords(self) -> Coords:
@@ -101,9 +124,9 @@ class WalkPlayerServerPacket(Packet):
         if data._player_id is None:
             raise SerializationError("player_id must be provided.")
         writer.add_short(data._player_id)
-        if data._Direction is None:
-            raise SerializationError("Direction must be provided.")
-        writer.add_char(int(data._Direction))
+        if data._direction is None:
+            raise SerializationError("direction must be provided.")
+        writer.add_char(int(data._direction))
         if data._coords is None:
             raise SerializationError("coords must be provided.")
         Coords.serialize(writer, data._coords)
@@ -124,7 +147,7 @@ class WalkPlayerServerPacket(Packet):
         try:
             reader_start_position: int = reader.position
             data._player_id = reader.get_short()
-            data._Direction = Direction(reader.get_char())
+            data._direction = Direction(reader.get_char())
             data._coords = Coords.deserialize(reader)
             data._byte_size = reader.position - reader_start_position
             return data
@@ -132,4 +155,4 @@ class WalkPlayerServerPacket(Packet):
             reader.chunked_reading_mode = old_chunked_reading_mode
 
     def __repr__(self):
-        return f"WalkPlayerServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, Direction={repr(self._Direction)}, coords={repr(self._coords)})"
+        return f"WalkPlayerServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, direction={repr(self._direction)}, coords={repr(self._coords)})"

eolib/protocol/_generated/net/server/walk_reply_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkReplyServerPacket(Packet):
+    """
+    Players, NPCs, and Items appearing in nearby view
+    """
     _byte_size: int = 0
     _player_ids: list[int] = None # type: ignore [assignment]
     _npc_indexes: list[int] = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/warp_agree_server_packet.py

@@ -15,6 +15,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpAgreeServerPacket(Packet):
+    """
+    Reply after accepting a warp
+    """
     _byte_size: int = 0
     _warp_type: WarpType = None # type: ignore [assignment]
     _warp_type_data: 'WarpAgreeServerPacket.WarpTypeData' = None

eolib/protocol/_generated/net/server/warp_create_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpCreateServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.MapMutation
+    """
     _byte_size: int = 0
     _map_file: MapFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/warp_player_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpPlayerServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.WarpMap
+    """
     _byte_size: int = 0
     _map_file: MapFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/warp_request_server_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpRequestServerPacket(Packet):
+    """
+    Warp request from server
+    """
     _byte_size: int = 0
     _warp_type: WarpType = None # type: ignore [assignment]
     _map_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/welcome_net242_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeNet242ServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.FileEnf
+    """
     _byte_size: int = 0
     _pub_file: PubFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/welcome_net243_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeNet243ServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.FileEsf
+    """
     _byte_size: int = 0
     _pub_file: PubFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/welcome_net244_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeNet244ServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.FileEcf
+    """
     _byte_size: int = 0
     _pub_file: PubFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/welcome_ping_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomePingServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.FileMap
+    """
     _byte_size: int = 0
     _map_file: MapFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/welcome_pong_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomePongServerPacket(Packet):
+    """
+    Equivalent to INIT_INIT with InitReply.FileEif
+    """
     _byte_size: int = 0
     _pub_file: PubFile = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/welcome_reply_server_packet.py

@@ -23,6 +23,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeReplyServerPacket(Packet):
+    """
+    Reply to selecting a character / entering game
+    """
     _byte_size: int = 0
     _welcome_code: WelcomeCode = None # type: ignore [assignment]
     _welcome_code_data: 'WelcomeReplyServerPacket.WelcomeCodeData' = None

{eolib-1.0.0.dist-info → eolib-1.1.1.dist-info}/METADATA

@@ -1,15 +1,15 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: eolib
-Version: 1.0.0
+Version: 1.1.1
 Summary: Core library for writing applications related to Endless Online.
-Project-URL: Documentation, https://github.com/Cirras/eolib#readme
-Project-URL: Issues, https://github.com/Cirras/eolib/issues
-Project-URL: Source, https://github.com/Cirras/eolib
+Project-URL: Documentation, https://github.com/Cirras/eolib-python#readme
+Project-URL: Issues, https://github.com/Cirras/eolib-python/issues
+Project-URL: Source, https://github.com/Cirras/eolib-python
 Author-email: Jonah Jeleniewski <cirrasbu@hotmail.com>
 License-Expression: MIT
 License-File: LICENSE.txt
 Keywords: endless-online
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -79,4 +79,4 @@ Utilities:
 | `hatch run docs:build`      | Build documentation using `mkdocs`                     |
 | `hatch run docs:serve`      | Build and serve documentation using `mkdocs`           |
 | `hatch run docs:deploy`     | Build and deploy documentation using `mkdocs` & `mike` |
-| `hatch run prepare:release` | Prepare and tag a new release                          |
+| `hatch run release:prepare` | Prepare and tag a new release                          |