eolib 1.1.0__tar.gz → 1.2.0__tar.gz

eolib-1.2.0/.github/workflows/release.yml

@@ -0,0 +1,105 @@
+name: release
+
+on:
+  push:
+    tags:
+      - v*
+
+concurrency:
+  group: release
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install Hatch
+        run: pip install --upgrade hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Push Python artifacts to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+  publish-docs:
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install Hatch
+        run: pip install --upgrade hatch
+
+      - name: Get version from tag
+        id: get-version
+        run: echo "version-without-v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+      
+      - name: Deploy documentation
+        run: |
+          git fetch origin gh-pages --depth=1
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          hatch run docs:deploy ${{ steps.get-version.outputs.version-without-v }}
+          git push origin gh-pages
+ 
+  publish-github:
+    needs: publish-docs
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      
+      - name: Get version from tag
+        id: get-version
+        run: echo "version-without-v=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
+        shell: bash
+
+      - name: Get changelog release info
+        id: changelog
+        uses: release-flow/keep-a-changelog-action@v2
+        with:
+          command: query
+          version: ${{ steps.get-version.outputs.version-without-v }}
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: EOLib v${{ steps.get-version.outputs.version-without-v }}
+          body: ${{ steps.changelog.outputs.release-notes }}

eolib-1.2.0/.github/workflows/sonar.yml

@@ -0,0 +1,38 @@
+name: sonar
+
+on:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: "0 0 * * *"
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install Hatch
+        run: pip install --upgrade hatch
+
+      - name: Run tests
+        run: hatch run test
+
+      - name: SonarCloud Scan
+        uses: sonarsource/sonarqube-scan-action@v5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

eolib-1.2.0/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: test
+
+on:
+  push:
+    branches: master
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+concurrency:
+  group: test-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  run:
+    name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14.0-beta.3']
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Hatch
+      run: pip install --upgrade hatch
+
+    - name: Run tests
+      run: hatch run test

eolib-1.2.0/CHANGELOG.md

@@ -0,0 +1,102 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.2.0] - 2025-06-30
+
+### Added
+
+- Support for Python 3.13.
+- Support for Python 3.14.
+- Support for server pub files:
+  - `DropRecord` class.
+  - `DropNpcRecord` class.
+  - `DropFile` class.
+  - `InnQuestionRecord` class.
+  - `InnRecord` class.
+  - `InnFile` class.
+  - `SkillMasterSkillRecord` class.
+  - `SkillMasterRecord` class.
+  - `SkillMasterFile` class.
+  - `ShopTradeRecord` class.
+  - `ShopCraftIngredientRecord` class.
+  - `ShopCraftRecord` class.
+  - `ShopRecord` class.
+  - `ShopFile` class.
+  - `TalkMessageRecord` class.
+  - `TalkRecord` class.
+  - `TalkFile` class.
+- `GuildTakeClientPacket.guild_tag` field.
+
+### Fixed
+
+- Fix bug on Python 3.13+ where any protocol enum instance constructed from an int value would be
+  treated like an unrecognized value.
+- Fix `AttributeError` on Python 3.14 because the readonly `__doc__` attribute was being assigned to
+  in generated protocol code.
+- Fix incorrect (de)serialization of some data structures containing arrays with trailing delimiters.
+- Fix incorrect (de)serialization of data structures containing both `<dummy>` and `<field>` elements.
+  (Only `ChestCloseServerPacket` was impacted.)
+- Fix incorrect (de)serialization of `NpcAgreeServerPacket` due to the `npcs` array's length being
+  treated as a `short` instead of `char`.
+- Fix incorrect (de)serialization of `GuildTakeClientPacket` due to missing `guild_tag` field.
+- Fix incorrect (de)serialization of `AvatarAdminServerPacket` due to incorrect ordering of the
+  `caster_direction` and `damage` fields.
+- Fix inaccurate (de)serialization of `JukeboxMsgClientPacket` due to the packet being treated as a
+  chunked data structure.
+- Sanitize strings within chunked sections of protocol data structures.
+  - Generated code now sets `EoWriter.string_sanitization_mode` during serialization.
+  - For more information, see
+    [Chunked Reading: Sanitization](https://github.com/Cirras/eo-protocol/blob/master/docs/chunks.md#sanitization).
+- Properly escape characters from the upsteam protocol XML in docstrings and downstream generated documentation.
+
+## [1.1.1] - 2024-08-22
+
+### Changed
+
+- The package is now [PEP 561](https://peps.python.org/pep-0561/) compatible, exposing type
+  information for usage in type checkers like
+  [mypy](https://mypy.readthedocs.io/en/stable/index.html).
+
+## [1.1.0] - 2023-12-19
+
+### Added
+
+- `WalkPlayerServerPacket.direction` field.
+
+### Changed
+
+- Remove trailing break from `ArenaSpecServerPacket`.
+- Remove trailing break from `ArenaAcceptServerPacket`.
+- Deprecate `WalkPlayerServerPacket.Direction` field.
+
+## [1.0.0] - 2023-11-07
+
+### Added
+
+- Support for EO data structures:
+  - Client packets
+  - Server packets
+  - Endless Map Files (EMF)
+  - Endless Item Files (EIF)
+  - Endless NPC Files (ENF)
+  - Endless Spell Files (ESF)
+  - Endless Class Files (ECF)
+- Utilities:
+  - Data reader
+  - Data writer
+  - Number encoding
+  - String encoding
+  - Data encryption
+  - Packet sequencer
+
+[Unreleased]: https://github.com/cirras/eolib-python/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/cirras/eolib-python/compare/v1.1.1...v1.2.0
+[1.1.1]: https://github.com/cirras/eolib-python/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/cirras/eolib-python/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/cirras/eolib-python/releases/tag/v1.0.0

eolib-1.2.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: eolib
+Version: 1.2.0
+Summary: Core library for writing applications related to Endless Online.
+Project-URL: Documentation, https://cirras.github.io/eolib-python
+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 :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# EOLib
+
+[![PyPI - Version](https://img.shields.io/pypi/v/eolib.svg)](https://pypi.org/project/eolib)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eolib.svg)](https://pypi.org/project/eolib)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cirras_eolib-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cirras_eolib-python)
+[![Lint](https://github.com/Cirras/eolib-python/actions/workflows/lint.yml/badge.svg?event=push)](https://github.com/Cirras/eolib-python/actions/workflows/lint.yml)
+
+A core Python library for writing applications related to Endless Online.
+
+## Installation
+
+```console
+pip install eolib
+```
+
+## Features
+
+Read and write the following EO data structures:
+
+- Client packets
+- Server packets
+- Endless Map Files (EMF)
+- Endless Item Files (EIF)
+- Endless NPC Files (ENF)
+- Endless Spell Files (ESF)
+- Endless Class Files (ECF)
+
+Utilities:
+
+- Data reader
+- Data writer
+- Number encoding
+- String encoding
+- Data encryption
+- Packet sequencer
+
+## Development
+
+### Requirements
+
+- [Python](https://www.python.org/downloads/) 3.8+
+- [Hatch](https://hatch.pypa.io/latest/install/)
+
+### Available Commands
+
+| Command                     | Description                                            |
+| --------------------------- | ------------------------------------------------------ |
+| `hatch build`               | Build package                                          |
+| `hatch clean`               | Remove build artifacts                                 |
+| `hatch run test`            | Run unit tests with coverage                           |
+| `hatch run lint:format`     | Format source files using `black`                      |
+| `hatch run lint:style`      | Check formatting using `black`                         |
+| `hatch run lint:typing`     | Check typing using `mypy`                              |
+| `hatch run lint:all`        | Check formatting using `black` and typing using `mypy` |
+| `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 release:prepare` | Prepare and tag a new release                          |

eolib-1.2.0/README.md

@@ -0,0 +1,58 @@
+# EOLib
+
+[![PyPI - Version](https://img.shields.io/pypi/v/eolib.svg)](https://pypi.org/project/eolib)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/eolib.svg)](https://pypi.org/project/eolib)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Cirras_eolib-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Cirras_eolib-python)
+[![Lint](https://github.com/Cirras/eolib-python/actions/workflows/lint.yml/badge.svg?event=push)](https://github.com/Cirras/eolib-python/actions/workflows/lint.yml)
+
+A core Python library for writing applications related to Endless Online.
+
+## Installation
+
+```console
+pip install eolib
+```
+
+## Features
+
+Read and write the following EO data structures:
+
+- Client packets
+- Server packets
+- Endless Map Files (EMF)
+- Endless Item Files (EIF)
+- Endless NPC Files (ENF)
+- Endless Spell Files (ESF)
+- Endless Class Files (ECF)
+
+Utilities:
+
+- Data reader
+- Data writer
+- Number encoding
+- String encoding
+- Data encryption
+- Packet sequencer
+
+## Development
+
+### Requirements
+
+- [Python](https://www.python.org/downloads/) 3.8+
+- [Hatch](https://hatch.pypa.io/latest/install/)
+
+### Available Commands
+
+| Command                     | Description                                            |
+| --------------------------- | ------------------------------------------------------ |
+| `hatch build`               | Build package                                          |
+| `hatch clean`               | Remove build artifacts                                 |
+| `hatch run test`            | Run unit tests with coverage                           |
+| `hatch run lint:format`     | Format source files using `black`                      |
+| `hatch run lint:style`      | Check formatting using `black`                         |
+| `hatch run lint:typing`     | Check typing using `mypy`                              |
+| `hatch run lint:all`        | Check formatting using `black` and typing using `mypy` |
+| `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 release:prepare` | Prepare and tag a new release                          |

eolib-1.2.0/eo-protocol/README.md

@@ -0,0 +1,45 @@
+# EO Protocol
+
+An XML-based specification of the Endless Online network protocol and data files.
+
+## Motivation
+
+Most of this information has been available for some time. It's been scattered through different projects, only partially documented, or living in the heads of various community members.
+
+The idea is to put all of that collective knowledge in one place.
+
+## Use cases
+
+- Documentation
+- Code generation
+
+## Projects
+
+Community projects based on this specification.
+
+### Libraries
+
+1. **[eolib-go](https://github.com/ethanmoffat/eolib-go)** ([@ethanmoffat](https://github.com/ethanmoffat))
+    * Core Golang library for writing Endless Online applications.
+2. **[eolib-java](https://github.com/cirras/eolib-java)** ([@cirras](https://github.com/cirras))
+    * Core Java library for writing Endless Online applications.
+3. **[eolib-python](https://github.com/cirras/eolib-python)** ([@cirras](https://github.com/cirras))
+    * Core Python library for writing Endless Online applications.
+4. **[eolib-rs](https://github.com/sorokya/eolib-rs)** ([@sorokya](https://github.com/sorokya))
+    * Core Rust library for writing Endless Online applications.
+5. **[eolib-ts](https://github.com/cirras/eolib-ts)** ([@cirras](https://github.com/cirras))
+    * Core Typescript library for writing Endless Online applications.
+
+### Documentation
+
+1. **[eo-protocol-web](https://eoserv.net/eo-protocol-web/)** ([@tehsausage](https://github.com/tehsausage))
+    * Generated protocol documentation site.
+
+## Acknowledgements
+
+- Julian Smythe
+  - The `eo_protocol.txt` and `pub_protocol.txt` documentation that this project is based on, which was [released](https://eoserv.net/forum/topic/23799) in 2017 on the EOSERV forums.
+  - The [EOSERV](https://github.com/eoserv/eoserv) project, which has been a valuable reference point.
+  - Answering questions that none of us even knew we had about the protocol and official packet reader.
+- Richard Leek
+  - Improvements and corrections to the aforementioned `eo_protocol.txt` and `pub_protocol.txt` documentation. (See [eo_protocol](https://github.com/sorokya/eo_protocol))