legacy-puyo-tools 0.0.1__tar.gz

legacy_puyo_tools-0.0.1/.editorconfig

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yaml,yml}]
+indent_size = 2

legacy_puyo_tools-0.0.1/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

legacy_puyo_tools-0.0.1/.github/workflows/ci.yaml

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+name: Lint, format, and test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      # Setup environment
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - uses: actions/setup-python@v5
+
+      # Disable rules about documentation and TODOs in CI
+      # Let the developer decide when to fix them
+      - name: Ruff lint
+        run: uv run ruff check --fix --ignore=D101,D102,FIX002
+      - name: Lint using pylint
+        run: uv run pylint src --disable=C0115,C0116,W0511
+
+      - name: Lint using pyright
+        run: uv run pyright
+
+      - name: Ruff format
+        run: uv run ruff format

legacy_puyo_tools-0.0.1/.github/workflows/release.yaml

@@ -0,0 +1,39 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install package
+        run: uv sync --locked --all-extras --dev
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        run: uv publish --trusted-publishing always

legacy_puyo_tools-0.0.1/.gitignore

@@ -0,0 +1,225 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+!*.code-workspace
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

legacy_puyo_tools-0.0.1/.markdownlint.yaml

@@ -0,0 +1,62 @@
+# SPDX-FileCopyrightText: 2024 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+# Rules from https://wushenrong.github.io/markdown-formatting-style-guide
+# based on https://cirosantilli.com/markdown-style-guide/
+# and https://google.github.io/styleguide/docguide/style.html
+
+default: true
+
+heading-style:
+  style: atx
+
+ul-style:
+  style: dash
+
+ul-indent:
+  indent: 4
+
+no-trailing-spaces:
+  br_spaces: 0
+  strict: true
+
+no-hard-tabs:
+  spaces_per_tab: 4
+
+line-length:
+  heading_line_length: 120
+  code_block_line_length: 120
+  tables: false
+
+no-duplicate-heading:
+  siblings_only: true
+
+list-marker-space:
+  ul_multi: 3
+  ol_multi: 2
+
+hr-style:
+  style: ---
+
+fenced-code-language:
+  language_only: true
+
+code-block-style:
+  style: fenced
+
+code-fence-style:
+  style: backtick
+
+emphasis-style:
+  style: asterisk
+
+strong-style:
+  style: asterisk
+
+link-image-style:
+  collapsed: false
+  url_inline: false
+
+table-pipe-style:
+  style: no_leading_or_trailing

legacy_puyo_tools-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-docstring-first
+      - id: check-illegal-windows-names
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.3
+    hooks:
+      - id: ruff-check
+        args:
+          - --fix
+      - id: ruff-format
+
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.18.1
+    hooks:
+      - id: markdownlint-cli2
+        args:
+          - --fix
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.26.0
+    hooks:
+      - id: gitleaks
+
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v5.0.2
+    hooks:
+      - id: reuse
+
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes

legacy_puyo_tools-0.0.1/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 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.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.1 - 2025-07-15
+
+### Added
+
+- Basic extraction support for the `mtx` format.
+- Full conversion support for the `fpd` format.

legacy_puyo_tools-0.0.1/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 Samuel Wu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

legacy_puyo_tools-0.0.1/LICENSES/MIT-0.txt

@@ -0,0 +1,16 @@
+MIT No Attribution
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

legacy_puyo_tools-0.0.1/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

legacy_puyo_tools-0.0.1/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: legacy-puyo-tools
+Version: 0.0.1
+Summary: A tool to edit text for older Puyo Puyo games.
+Author-email: Samuel Wu <twopizza9621536@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: attrs>=25.3.0
+Requires-Dist: lxml>=6.0.0
+Description-Content-Type: text/markdown
+
+# Legacy Puyo Tools
+
+Supports Puyo Puyo 7 and possibly Puyo Puyo! 15th Anniversary `mtx` and `fpd`
+files. Puyo Puyo!! 20th Anniversary is still not supported yet. (Create an issue
+or pull request to support `fnt` and additional `mtx` controls). Also, legacy as
+in older Puyo Puyo games, not that this tool is decapitated.
+
+## Why
+
+The [Puyo Text Editor][1] can already do what Legacy Puyo Tools does and is the
+inspiration of this tool, but there are advantages to rewrite it in Python:
+
+- Better cross compatibility with Linux.
+- Don't have to update the language version every time it becomes End of Life.
+- Avoids the rigidness of using a pure object-oriented design.
+
+## License
+
+Under the MIT License. Based on [Puyo Text Editor][1] which is also under the
+MIT License.
+
+[1]: https://github.com/nickworonekin/puyo-text-editor

legacy_puyo_tools-0.0.1/README.md

@@ -0,0 +1,22 @@
+# Legacy Puyo Tools
+
+Supports Puyo Puyo 7 and possibly Puyo Puyo! 15th Anniversary `mtx` and `fpd`
+files. Puyo Puyo!! 20th Anniversary is still not supported yet. (Create an issue
+or pull request to support `fnt` and additional `mtx` controls). Also, legacy as
+in older Puyo Puyo games, not that this tool is decapitated.
+
+## Why
+
+The [Puyo Text Editor][1] can already do what Legacy Puyo Tools does and is the
+inspiration of this tool, but there are advantages to rewrite it in Python:
+
+- Better cross compatibility with Linux.
+- Don't have to update the language version every time it becomes End of Life.
+- Avoids the rigidness of using a pure object-oriented design.
+
+## License
+
+Under the MIT License. Based on [Puyo Text Editor][1] which is also under the
+MIT License.
+
+[1]: https://github.com/nickworonekin/puyo-text-editor

legacy_puyo_tools-0.0.1/REUSE.toml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2025 Samuel Wu
+#
+# SPDX-License-Identifier: MIT-0
+
+version = 1
+
+[[annotations]]
+SPDX-FileCopyrightText = "2025 Samuel Wu"
+SPDX-License-Identifier = "MIT"
+path = ["docs/formats.md"]
+
+[[annotations]]
+SPDX-FileCopyrightText = "2025 Samuel Wu"
+SPDX-License-Identifier = "MIT-0"
+path = ["README.md", "uv.lock"]

legacy_puyo_tools-0.0.1/docs/formats.md

@@ -0,0 +1,26 @@
+# Formats
+
+Older Puyo Puyo games used multiple formats to store manzai text and character
+data. This document contains how each format is structured and encoded.
+
+## The `fpd` format
+
+The `fpd` format is a binary character table format used by the developers for
+Puyo Puyo! 15th Anniversary and Puyo Puyo 7 to convert characters from UTF-16
+little-endian into an index that is used by the `mtx` for text. Each character
+entry in the `fpd` is 3 bytes long and formatted as follows: `XX XX YY`. Where
+`XX XX` is the character encoded in UTF-16 little-endian and `YY` is the width
+of the character. The entries are placed next to each other, creating a
+zero-based index that is offset by multiples of `0x03`. I.e. the 1st character
+is at index `0x00`, the 2nd character is at index `0x03`, the 3rd character is
+at index `0x06`, etc.
+
+The `fpd` is not used by the games internally except for the Nintendo DS version
+of Puyo Puyo 7.
+
+## The `mtx` format
+
+<!-- TODO: Finish the mtx format for PP15 and PP7 -->
+<!-- TODO: Look at the mtx format for PP20 -->
+The `mtx` format is a binary-encoded format used by older Puyo games for
+storing character dialog and text.