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

eolib/__about__.py

@@ -1 +1 @@
-__version__ = "1.1.0"
+__version__ = "1.1.1"

eolib/encrypt/encryption_utils.py

@@ -5,7 +5,9 @@ def interleave(data: bytearray) -> None:
     Used when encrypting packets and data files.
 
     Example:
+        ```
         [0, 1, 2, 3, 4, 5] -> [0, 5, 1, 4, 2, 3]
+        ```
 
     This is an in-place operation.
 
@@ -41,7 +43,9 @@ def deinterleave(data: bytearray) -> None:
     Used when decrypting packets and data files.
 
     Example:
+        ```
         [0, 1, 2, 3, 4, 5] -> [0, 2, 4, 5, 3, 1]
+        ```
 
     This is an in-place operation.
 
@@ -78,7 +82,9 @@ def flip_msb(data: bytearray) -> None:
     Used when encrypting and decrypting packets.
 
     Example:
+        ```
         [0, 1, 127, 128, 129, 254, 255] -> [0, 129, 255, 128, 1, 126, 127]
+        ```
 
     This is an in-place operation.
 
@@ -98,8 +104,10 @@ def swap_multiples(data: bytearray, multiple: int) -> None:
     Used when encrypting and decrypting packets and data files.
 
     Example:
+        ```
         multiple = 3
         [10, 21, 27] -> [10, 27, 21]
+        ```
 
     This is an in-place operation.
 

eolib/protocol/_generated/net/client/account_agree_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AccountAgreeClientPacket(Packet):
+    """
+    Change password
+    """
     _byte_size: int = 0
     _username: str = None # type: ignore [assignment]
     _old_password: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/account_create_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AccountCreateClientPacket(Packet):
+    """
+    Confirm creating an account
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _username: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/account_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AccountRequestClientPacket(Packet):
+    """
+    Request creating an account
+    """
     _byte_size: int = 0
     _username: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/admin_interact_report_client_packet.py

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

eolib/protocol/_generated/net/client/admin_interact_tell_client_packet.py

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

eolib/protocol/_generated/net/client/attack_use_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AttackUseClientPacket(Packet):
+    """
+    Attacking
+    """
     _byte_size: int = 0
     _direction: Direction = None # type: ignore [assignment]
     _timestamp: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/bank_add_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BankAddClientPacket(Packet):
+    """
+    Depositing gold
+    """
     _byte_size: int = 0
     _amount: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/bank_open_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BankOpenClientPacket(Packet):
+    """
+    Talked to a banker NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/bank_take_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BankTakeClientPacket(Packet):
+    """
+    Withdrawing gold
+    """
     _byte_size: int = 0
     _amount: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/barber_buy_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BarberBuyClientPacket(Packet):
+    """
+    Purchasing a hair-style
+    """
     _byte_size: int = 0
     _hair_style: int = None # type: ignore [assignment]
     _hair_color: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/barber_open_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BarberOpenClientPacket(Packet):
+    """
+    Talking to a barber NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/board_create_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardCreateClientPacket(Packet):
+    """
+    Posting a new message to a town board
+    """
     _byte_size: int = 0
     _board_id: int = None # type: ignore [assignment]
     _post_subject: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/board_open_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardOpenClientPacket(Packet):
+    """
+    Opening a town board
+    """
     _byte_size: int = 0
     _board_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/board_remove_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardRemoveClientPacket(Packet):
+    """
+    Removing a post from a town board
+    """
     _byte_size: int = 0
     _board_id: int = None # type: ignore [assignment]
     _post_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/board_take_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardTakeClientPacket(Packet):
+    """
+    Reading a post on a town board
+    """
     _byte_size: int = 0
     _board_id: int = None # type: ignore [assignment]
     _post_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/book_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BookRequestClientPacket(Packet):
+    """
+    Request for a player's book
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/chair_request_client_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChairRequestClientPacket(Packet):
+    """
+    Sitting on a chair
+    """
     _byte_size: int = 0
     _sit_action: SitAction = None # type: ignore [assignment]
     _sit_action_data: 'ChairRequestClientPacket.SitActionData' = None

eolib/protocol/_generated/net/client/character_create_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CharacterCreateClientPacket(Packet):
+    """
+    Confirm creating a character
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _gender: Gender = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/character_remove_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CharacterRemoveClientPacket(Packet):
+    """
+    Confirm deleting character from an account
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _character_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/character_request_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CharacterRequestClientPacket(Packet):
+    """
+    Request to create a character
+    """
     _byte_size: int = 0
     _request_string: str = "NEW" # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/character_take_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CharacterTakeClientPacket(Packet):
+    """
+    Request to delete a character from an account
+    """
     _byte_size: int = 0
     _character_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/chest_add_client_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestAddClientPacket(Packet):
+    """
+    Placing an item in to a chest
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
     _add_item: ThreeItem = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/chest_open_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestOpenClientPacket(Packet):
+    """
+    Opening a chest
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/chest_take_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestTakeClientPacket(Packet):
+    """
+    Taking an item from a chest
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
     _take_item_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/citizen_accept_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenAcceptClientPacket(Packet):
+    """
+    Confirm sleeping at an inn
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _behavior_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/citizen_open_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenOpenClientPacket(Packet):
+    """
+    Talking to a citizenship NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/citizen_remove_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenRemoveClientPacket(Packet):
+    """
+    Giving up citizenship of a town
+    """
     _byte_size: int = 0
     _behavior_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/citizen_reply_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenReplyClientPacket(Packet):
+    """
+    Subscribing to a town
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _behavior_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/citizen_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenRequestClientPacket(Packet):
+    """
+    Request sleeping at an inn
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _behavior_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/connection_accept_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ConnectionAcceptClientPacket(Packet):
+    """
+    Confirm initialization data
+    """
     _byte_size: int = 0
     _client_encryption_multiple: int = None # type: ignore [assignment]
     _server_encryption_multiple: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/connection_ping_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ConnectionPingClientPacket(Packet):
+    """
+    Ping reply
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/client/door_open_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class DoorOpenClientPacket(Packet):
+    """
+    Opening a door
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/emote_report_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EmoteReportClientPacket(Packet):
+    """
+    Doing an emote
+    """
     _byte_size: int = 0
     _emote: Emote = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/face_player_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class FacePlayerClientPacket(Packet):
+    """
+    Facing a direction
+    """
     _byte_size: int = 0
     _direction: Direction = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/global_close_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GlobalCloseClientPacket(Packet):
+    """
+    Closed global tab
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/client/global_open_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GlobalOpenClientPacket(Packet):
+    """
+    Opened global tab
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/client/global_player_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GlobalPlayerClientPacket(Packet):
+    """
+    Disable whispers
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/client/global_remove_client_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GlobalRemoveClientPacket(Packet):
+    """
+    Enable whispers
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/client/guild_accept_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildAcceptClientPacket(Packet):
+    """
+    Accept pending guild creation invite
+    """
     _byte_size: int = 0
     _inviter_player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/guild_agree_client_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildAgreeClientPacket(Packet):
+    """
+    Update the guild description or rank list
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _info_type: GuildInfoType = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_buy_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildBuyClientPacket(Packet):
+    """
+    Deposit gold in to the guild bank
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _gold_amount: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_create_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildCreateClientPacket(Packet):
+    """
+    Final confirm creating a guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _guild_tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_junk_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildJunkClientPacket(Packet):
+    """
+    Disband guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/guild_kick_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildKickClientPacket(Packet):
+    """
+    Kick member from guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _member_name: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_open_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildOpenClientPacket(Packet):
+    """
+    Talking to a guild master NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/guild_player_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildPlayerClientPacket(Packet):
+    """
+    Request to join a guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _guild_tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_rank_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildRankClientPacket(Packet):
+    """
+    Update a member's rank
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _rank: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_remove_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildRemoveClientPacket(Packet):
+    """
+    Leave guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/guild_report_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildReportClientPacket(Packet):
+    """
+    Requested general information of a guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _guild_identity: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildRequestClientPacket(Packet):
+    """
+    Requested to create a guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _guild_tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_take_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildTakeClientPacket(Packet):
+    """
+    Request guild description, rank list, or bank balance
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _info_type: GuildInfoType = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_tell_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildTellClientPacket(Packet):
+    """
+    Requested member list of a guild
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _guild_identity: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/guild_use_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildUseClientPacket(Packet):
+    """
+    Accepted a join request
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/init_init_client_packet.py

@@ -12,6 +12,10 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class InitInitClientPacket(Packet):
+    """
+    Connection initialization request.
+    This packet is unencrypted.
+    """
     _byte_size: int = 0
     _challenge: int = None # type: ignore [assignment]
     _version: Version = None # type: ignore [assignment]