legacy-puyo-tools 0.0.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

legacy_puyo_tools/__init__.py

@@ -1,7 +1,7 @@
 """A conversion tool for files used by the older Puyo games.
 
-Supports Puyo Puyo 7 and possibly Puyo Puyo! 15th Anniversary `mtx` and
-`fpd` files. Puyo Puyo!! 20th Anniversary is still not supported yet.
+Supports Puyo Puyo 7 and possibly Puyo Puyo! 15th Anniversary `mtx` and `fpd` files.
+Puyo Puyo!! 20th Anniversary is still not supported yet.
 
 SPDX-FileCopyrightText: 2025 Samuel Wu
 SPDX-License-Identifier: MIT

legacy_puyo_tools/__main__.py

@@ -0,0 +1,10 @@
+"""Allow the cli to be run from runpy or using `python -m legacy_puyo_tools`.
+
+SPDX-FileCopyrightText: 2025 Samuel Wu
+SPDX-License-Identifier: MIT
+"""
+
+if __name__ == "__main__":
+    from legacy_puyo_tools.cli import app
+
+    app()

legacy_puyo_tools/cli.py

@@ -1,4 +1,4 @@
-"""A commandline application that interfaces with conversion tools.
+"""A commandline interface for the conversion tools.
 
 SPDX-FileCopyrightText: 2025 Samuel Wu
 SPDX-License-Identifier: MIT
@@ -6,172 +6,146 @@ SPDX-License-Identifier: MIT
 
 from __future__ import annotations
 
-import argparse
-import sys
 from codecs import BOM_UTF16_LE
-from collections.abc import Callable
-from importlib import metadata
 from pathlib import Path
 from typing import BinaryIO
 
-from attrs import define
+import cloup
+from cloup import option, option_group
+from cloup.constraints import require_one
 
-from legacy_puyo_tools.exceptions import FileFormatError
+from legacy_puyo_tools.exceptions import ArgumentError, FileFormatError
 from legacy_puyo_tools.fpd import Fpd
 from legacy_puyo_tools.mtx import Mtx
 
-
-@define
-class _CliNamespace(argparse.Namespace):
-    func: Callable[[type[_CliNamespace]], None]
-    input: BinaryIO
-    output: BinaryIO
-    unicode: BinaryIO
-    fpd: BinaryIO
-    version: bool
-
-
-def _create_fpd(args: _CliNamespace) -> None:
-    if args.input.read(2) != BOM_UTF16_LE:
+output_option = option(
+    "--output",
+    "-o",
+    "output_file",
+    help="Output file. Defaults to an appropriate filename and extension.",
+    type=cloup.File("wb"),
+)
+
+mtx_options = option_group(
+    "Character table options",
+    option(
+        "--fpd",
+        help="Use a fpd file as the character table.",
+        type=cloup.Path(exists=True, dir_okay=False, path_type=Path),
+    ),
+    option(
+        "--unicode",
+        help="Use a unicode text file as the character table.",
+        type=cloup.Path(exists=True, dir_okay=False, path_type=Path),
+    ),
+    constraint=require_one.rephrased(
+        "exactly 1 character table required for mtx files",
+        "exactly 1 character table must be specified",
+    ),
+)
+
+
+@cloup.group()
+@cloup.version_option()
+def app() -> None:
+    """A conversion tool for files used by older Puyo games."""
+
+
+@app.group()
+def create() -> None:
+    """Create files to used by older Puyo games."""
+
+
+@create.command(name="fpd")
+@cloup.argument(
+    "input_file",
+    help="Unicode text file encoded in UTF-16 little-endian.",
+    type=cloup.File("rb"),
+)
+@output_option
+def create_fpd(input_file: BinaryIO, output_file: BinaryIO | None) -> None:
+    """Create a fpd file from a unicode text file."""  # noqa: DOC501
+    if input_file.read(2) != BOM_UTF16_LE:
         raise FileFormatError(
-            f"{args.input.name} is not a UTF-16 little-endian encoded text"
-            "file."
+            f"{input_file.name} is not a UTF-16 little-endian encoded text file."
         )
 
-    if args.output:
-        Fpd.read_unicode(args.input).write_fpd(args.output)
+    if output_file:
+        Fpd.read_unicode(input_file).write_fpd(output_file)
         return
 
-    path = Path(args.input.name).with_suffix("")
-
-    if path.suffix != ".fpd":
-        path = path.with_suffix(".fpd")
-
-    Fpd.read_unicode(args.input).write_fpd_to_path(path)
-
-
-def _create_mtx(args: _CliNamespace) -> None:
-    raise NotImplementedError()
-
-
-def _convert_fpd(args: _CliNamespace) -> None:
-    if args.output:
-        args.output.write(BOM_UTF16_LE)
-        Fpd.read_fpd(args.input).write_fpd(args.output)
+    path = Path(input_file.name).with_suffix(".fpd")
+
+    Fpd.read_unicode(input_file).write_fpd_to_path(path)
+
+
+@create.command(name="mtx", show_constraints=True)
+@cloup.argument(
+    "input_file",
+    help="XML file that contains markup text or dialog.",
+    type=cloup.File("rb"),
+)
+@output_option
+@mtx_options
+def create_mtx(
+    input_file: BinaryIO, output_file: BinaryIO, fpd: Path | None, unicode: Path | None
+) -> None:
+    """Create a mtx file from a XML file."""
+    raise NotImplementedError("Creating MTX files is currently not implemented yet.")
+
+
+@app.group()
+def convert() -> None:
+    """Convert files used by older Puyo games to an editable format."""
+
+
+@convert.command(name="fpd")
+@cloup.argument(
+    "input_file", help="Fpd file containing character data.", type=cloup.File("rb")
+)
+@output_option
+def convert_fpd(input_file: BinaryIO, output_file: BinaryIO | None) -> None:
+    """Convert a fpd file to a UTF-16 little-endian unicode text file."""
+    if output_file:
+        output_file.write(BOM_UTF16_LE)
+        Fpd.read_fpd(input_file).write_unicode(output_file)
         return
 
-    path = Path(args.input.name).with_suffix("")
-
-    if path.suffix != ".fpd":
-        path = path.with_suffix(".fpd")
-
-    Fpd.read_fpd(args.input).write_unicode_to_path(path)
-
-
-def _convert_mtx(args: _CliNamespace) -> None:
-    if args.fpd:
-        fpd_data = Fpd.read_fpd(args.fpd)
+    path = Path(input_file.name).with_suffix(".txt")
+
+    Fpd.read_fpd(input_file).write_unicode_to_path(path)
+
+
+@convert.command(name="mtx", show_constraints=True)
+@cloup.argument(
+    "input_file", help="Mtx file containing Manzai text.", type=cloup.File("rb")
+)
+@output_option
+@mtx_options
+def convert_mtx(
+    input_file: BinaryIO,
+    output_file: BinaryIO | None,
+    fpd: Path | None,
+    unicode: Path | None,
+) -> None:
+    """Convert a mtx file to a XML file."""  # noqa: DOC501
+    if fpd:
+        fpd_data = Fpd.read_fpd_from_path(fpd)
+    elif unicode:
+        fpd_data = Fpd.read_unicode_from_path(unicode)
     else:
-        if args.unicode.read(2) != BOM_UTF16_LE:
-            raise FileFormatError(
-                f"{args.input.name} is not a UTF-16 little-endian encoded text"
-                "file."
-            )
-
-        fpd_data = Fpd.read_unicode(args.unicode)
+        raise ArgumentError(
+            "You must specify a character table using --fpd or --unicode."
+        )
 
-    if args.output:
-        Mtx.read_mtx(args.input).write_xml(args.output, fpd_data)
+    if output_file:
+        Mtx.read_mtx(input_file).write_xml(output_file, fpd_data)
         return
 
-    path = Path(args.input.name).with_suffix("")
-
-    if path.suffix != ".xml":
-        path = path.with_suffix(".xml")
-
-    Mtx.read_mtx(args.input).write_xml_to_file(path, fpd_data)
-
-
-def _create_parsers(main_parser: argparse.ArgumentParser) -> None:
-    shared_options = argparse.ArgumentParser(add_help=False)
-    shared_options.add_argument(
-        "input", type=argparse.FileType("rb"), help="input file"
-    )
-    shared_options.add_argument(
-        "-o", "--output", type=argparse.FileType("wb"), help="output file"
-    )
-
-    mtx_options = argparse.ArgumentParser(
-        add_help=False, parents=[shared_options]
-    )
-    mtx_options_group = mtx_options.add_mutually_exclusive_group(required=True)
-    mtx_options_group.add_argument(
-        "--fpd", type=argparse.FileType("rb"), help="fpd file"
-    )
-    mtx_options_group.add_argument(
-        "--unicode", type=argparse.FileType("rb"), help="unicode text file"
-    )
-
-    sub_parser = main_parser.add_subparsers()
-
-    create_parser = sub_parser.add_parser("create")
-    create_sub_parser = create_parser.add_subparsers(required=True)
-
-    create_fpd_parser = create_sub_parser.add_parser(
-        "fpd",
-        help="create a fpd file from a unicode text file",
-        parents=[shared_options],
-    )
-    create_fpd_parser.set_defaults(func=_create_fpd)
-
-    create_mtx_parser = create_sub_parser.add_parser(
-        "mtx", help="create a mtx file from a XML file", parents=[mtx_options]
-    )
-    create_mtx_parser.set_defaults(func=_create_mtx)
-
-    convert_parser = sub_parser.add_parser("convert")
-    convert_sub_parser = convert_parser.add_subparsers(required=True)
-
-    convert_fpd_parser = convert_sub_parser.add_parser(
-        "fpd",
-        help="convert a fpd file to a unicode file",
-        parents=[shared_options],
-    )
-    convert_fpd_parser.set_defaults(func=_convert_fpd)
-
-    convert_mtx_parser = convert_sub_parser.add_parser(
-        "mtx", help="convert a mtx file to XML file", parents=[mtx_options]
-    )
-    convert_mtx_parser.set_defaults(func=_convert_mtx)
-
-
-def main() -> None:
-    """Entry point for the commandline application."""
-    main_parser = argparse.ArgumentParser(
-        description="A conversion tool for files used by older Puyo games."
-    )
-    main_parser.add_argument(
-        "-v", "--version", help="show version", action="store_true"
-    )
-
-    _create_parsers(main_parser)
-
-    args = main_parser.parse_args(namespace=_CliNamespace)
-
-    if args.version is True:
-        package_name = "legacy-puyo-tools"
-        version = metadata.version(package_name)
-
-        print(f"{package_name} {version}")
-
-        sys.exit(0)
-
-    if not hasattr(args, "func"):
-        main_parser.print_help(sys.stderr)
-        sys.exit(1)
+    path = Path(input_file.name).with_suffix(".xml")
 
-    args.func(args)
+    Mtx.read_mtx(input_file).write_xml_to_file(path, fpd_data)
 
 
 if __name__ == "__main__":
-    main()
+    app()

legacy_puyo_tools/exceptions.py

@@ -1,5 +1,6 @@
 """Exceptions that might be thrown when parsing files.
 
+SPDX-FileCopyrightText: 2021 Nick Woronekin
 SPDX-FileCopyrightText: 2025 Samuel Wu
 SPDX-License-Identifier: MIT
 """
@@ -11,3 +12,7 @@ class FormatError(Exception):
 
 class FileFormatError(FormatError):
     """The file does not conform to a file format or is malformed."""
+
+
+class ArgumentError(Exception):
+    """One of the argument is invalid or missing."""

legacy_puyo_tools/fpd.py

@@ -1,18 +1,21 @@
-"""fpd conversion tool for older puyo games.
+"""Fpd conversion tool for older Puyo games.
 
-This module supports the encoding and decoding of the fpd format used by
-Puyo Puyo! 15th Anniversary and Puyo Puyo 7.
+This module supports the encoding and decoding of the fpd format used by Puyo Puyo! 15th
+Anniversary and Puyo Puyo 7.
 
 SPDX-FileCopyrightText: 2025 Samuel Wu
 SPDX-License-Identifier: MIT
 """
 
+from __future__ import annotations
+
 from codecs import BOM_UTF16_LE
-from io import BytesIO
+from io import BytesIO, StringIO
+from os import PathLike
 from pathlib import Path
-from typing import BinaryIO, Self
+from typing import BinaryIO
 
-from attrs import define
+import attrs
 
 from legacy_puyo_tools.exceptions import FileFormatError, FormatError
 
@@ -22,20 +25,20 @@ UTF16_LENGTH = 2
 WIDTH_ENTRY_OFFSET = 2
 
 
-@define
+@attrs.define
 class FpdCharacter:
     """A fpd character entry.
 
-    A fpd character is a binary entry that is 3 bytes long and formatted
-    as follows: `XX XX YY`. Where `XX XX` is the character encoded in
-    UTF-16 LE and `YY` is the width of the character.
+    A fpd character is a binary entry that 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.
 
     Attributes:
         code_point:
             A string that stores a single character.
         width:
-            How wide should the character be, only used in the Nintendo
-            DS versions of the games.
+            How wide should the character be, only used in the Nintendo DS versions of
+            the games.
     """
 
     code_point: str
@@ -53,16 +56,21 @@ class FpdCharacter:
         self.code_point = code_point.decode(ENCODING)
         self.width = width
 
+    def __str__(self) -> str:
+        """Returns the character as a single character string."""
+        return self.code_point
+
     def encode(self) -> bytes:
         """Encodes the character back to a fpd character entry.
 
         Returns:
             The character in UTF-16 LE format and its width.
         """
-        return self.code_point.encode(ENCODING) + self.width.to_bytes()
+        # TODO: When updating Python to 3.11, remove arguments from width.to_bytes
+        return self.code_point.encode(ENCODING) + self.width.to_bytes(1, "little")
 
     @classmethod
-    def decode(cls, fpd_entry: bytes) -> Self:
+    def decode(cls, fpd_entry: bytes) -> FpdCharacter:
         """Decodes a fpd character into its code point and width.
 
         Args:
@@ -71,28 +79,25 @@ class FpdCharacter:
 
         Raises:
             FormatError:
-                The entry given does not conform to the fpd character
-                format.
+                The entry given does not conform to the fpd character format.
 
         Returns:
             A fpd character entry containing its code point and width.
         """
         if len(fpd_entry) != FPD_ENTRY_LENGTH:
-            raise FormatError(
-                f"{fpd_entry} does not matches size {FPD_ENTRY_LENGTH}"
-            )
+            raise FormatError(f"{fpd_entry} does not matches size {FPD_ENTRY_LENGTH}")
 
         return cls(fpd_entry[:UTF16_LENGTH], fpd_entry[WIDTH_ENTRY_OFFSET])
 
 
-@define
+@attrs.define
 class Fpd:
     """A fpd character table.
 
-    The fpd stores character table in which each entry is placed right
-    next to each other and the indices 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 stores character table in which each entry is placed right next to each
+    other and the indices 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.
 
     Attributes:
         entries:
@@ -113,19 +118,26 @@ class Fpd:
         """
         return self.entries[index].code_point
 
+    def __str__(self) -> str:
+        """Returns a string representation of the fpd character table."""
+        with StringIO() as string_buffer:
+            for character in self.entries:
+                string_buffer.write(str(character))
+
+            return string_buffer.getvalue()
+
     @classmethod
-    def read_fpd_from_path(cls, path: Path) -> Self:
+    def read_fpd_from_path(cls, path: str | PathLike[str]) -> Fpd:
         """Reads and extract characters from a fpd file.
 
         Args:
             path:
-                A path to a fpd encoded file that contains a fpd
-                character table.
+                A path to a fpd encoded file that contains a fpd character table.
 
         Raises:
             FileFormatError:
-                The fpd file contain a entry that does not conform
-                to the fpd character format.
+                The fpd file contain a entry that does not conform to the fpd character
+                format.
 
         Returns:
             A fpd character table.
@@ -137,7 +149,7 @@ class Fpd:
                 raise FileFormatError(f"{path} is not a valid fpd file") from e
 
     @classmethod
-    def read_fpd(cls, fp: BinaryIO) -> Self:
+    def read_fpd(cls, fp: BinaryIO) -> Fpd:
         """Reads and extract characters from a file object.
 
         Args:
@@ -150,13 +162,12 @@ class Fpd:
         return cls.decode_fpd(fp.read())
 
     @classmethod
-    def decode_fpd(cls, data: bytes) -> Self:
+    def decode_fpd(cls, data: bytes) -> Fpd:
         """Extracts the fpd character table from a fpd encoded stream.
 
         Args:
             data:
-                A fpd encoded stream that contains a fpd character
-                table.
+                A fpd encoded stream that contains a fpd character table.
 
         Returns:
             A fpd character table.
@@ -166,7 +177,7 @@ class Fpd:
             for i in range(0, len(data), FPD_ENTRY_LENGTH)
         ])
 
-    def write_fpd_to_path(self, path: Path) -> None:
+    def write_fpd_to_path(self, path: str | PathLike[str]) -> None:
         """Writes the fpd character table to a fpd encoded file.
 
         Args:
@@ -198,31 +209,32 @@ class Fpd:
             return bytes_buffer.getvalue()
 
     @classmethod
-    def read_unicode_from_path(cls, path: Path) -> Self:
-        """Reads and convert characters from a UTF-16 LE text file.
+    def read_unicode_from_path(cls, path: str | PathLike[str]) -> Fpd:
+        """Reads and convert characters from a UTF-16 little-endian text file.
 
         Arguments:
-            path:
-                A path to a UTF-16 LE text file.
+            path: A path to a UTF-16 LE text file.
 
         Raises:
             FileFormatError:
-                The file is not a UTF-16 LE encoded text file or is
-                missing the Byte Order Mark for UTF-16 LE.
+                The file is not a UTF-16 little-endian encoded text file or is missing
+                the Byte Order Mark for UTF-16 little-endian.
 
         Returns:
             A fpd character table.
         """
         with Path(path).open("rb") as fp:
-            # Check the Byte Order Mark (BOM) to see if it is really a
-            # UTF-16 LE text file
+            # Check the Byte Order Mark (BOM) to see if it is really a UTF-16 LE text
+            # file
             if fp.read(2) != BOM_UTF16_LE:
-                raise FileFormatError(f"{path} is not a UTF-16 LE text file.")
+                raise FileFormatError(
+                    f"{path} is not a UTF-16 little-endian text file."
+                )
 
             return cls.read_unicode(fp)
 
     @classmethod
-    def read_unicode(cls, fp: BinaryIO) -> Self:
+    def read_unicode(cls, fp: BinaryIO) -> Fpd:
         """Reads and convert UTF-16 LE characters from a file object.
 
         Args:
@@ -234,10 +246,9 @@ class Fpd:
         """
         return cls.decode_unicode(fp.read())
 
-    # TODO: Somehow allow people to specify the width of the character
-    # during decoding
+    # TODO: Somehow allow people to specify the width of the character during decoding
     @classmethod
-    def decode_unicode(cls, unicode: bytes) -> Self:
+    def decode_unicode(cls, unicode: bytes) -> Fpd:
         """Converts a UTF-16 LE stream into a fpd character table.
 
         Args:
@@ -252,7 +263,7 @@ class Fpd:
             for i in range(0, len(unicode), UTF16_LENGTH)
         ])
 
-    def write_unicode_to_path(self, path: Path) -> None:
+    def write_unicode_to_path(self, path: str | PathLike[str]) -> None:
         """Writes the fpd character table to a UTF-16 LE text file.
 
         Args:
@@ -278,11 +289,6 @@ class Fpd:
         """Encodes the fpd character table into a UTF-16 LE text stream.
 
         Returns:
-            A UTF-16 LE encoded text stream with characters from the
-            fpd.
+            A UTF-16 LE encoded text stream with characters from the fpd.
         """
-        with BytesIO() as bytes_buffer:
-            for character in self.entries:
-                bytes_buffer.write(character.code_point.encode(ENCODING))
-
-            return bytes_buffer.getvalue()
+        return str(self).encode(ENCODING)

legacy_puyo_tools/mtx.py

@@ -1,24 +1,46 @@
 """Manzai text conversion tool for older Puyo Puyo games.
 
-This module converts `mtx` files to and from XML for modding Puyo games.
-Currently supports Puyo Puyo 7 and might support Puyo Puyo! 15th
-Anniversary.
+This module converts mtx files to and from XML for modding Puyo games. Currently
+supports Puyo Puyo 7 and might support Puyo Puyo! 15th Anniversary.
 
+SPDX-FileCopyrightText: 2021 Nick Woronekin
 SPDX-FileCopyrightText: 2025 Samuel Wu
 SPDX-License-Identifier: MIT
 """
 
+from __future__ import annotations
+
+import sys
 from collections.abc import Callable
-from itertools import pairwise
+from os import PathLike
 from pathlib import Path
-from typing import BinaryIO, Literal, Self
+from typing import BinaryIO, Literal
 
-from attrs import define
+import attrs
 from lxml import etree
 
 from legacy_puyo_tools.exceptions import FileFormatError, FormatError
 from legacy_puyo_tools.fpd import Fpd
 
+# TODO: When updating to Python 3.10, remove the stub implementation of pairwise
+# from the python documentation:
+# https://docs.python.org/3/library/itertools.html#itertools.pairwise
+if sys.version_info >= (3, 10):
+    from itertools import pairwise
+else:
+    from collections.abc import Iterable
+    from itertools import tee
+    from typing import TypeVar
+
+    T = TypeVar("T")
+
+    def pairwise(iterable: Iterable[T]) -> Iterable[tuple[T, T]]:
+        """Simple pairwise implementation for Python < 3.10."""  # noqa: DOC201
+        a, b = tee(iterable)
+        next(b, None)
+        return zip(a, b)
+
+
 CHARACTER_WIDTH = 2
 ENDIAN = "little"
 
@@ -49,29 +71,28 @@ def _identify_mtx(data: bytes) -> tuple[Literal[8, 16], Literal[4, 8]]:
     raise FormatError("The given data is not in a valid `mtx` format")
 
 
-type MtxString = list[int]
+# TODO: When upgrading to Python 3.12, add type to the beginning of the alias
+MtxString = list[int]
 
 
-@define
+@attrs.define
 class Mtx:
     strings: list[MtxString]
 
     @classmethod
-    def read_mtx_from_file(cls, path: Path) -> Self:
+    def read_mtx_from_file(cls, path: str | PathLike[str]) -> Mtx:
         with Path(path).open("rb") as fp:
             try:
                 return cls.read_mtx(fp)
             except FormatError as e:
-                raise FileFormatError(
-                    f"{path} is not a valid `mtx` file"
-                ) from e
+                raise FileFormatError(f"{path} is not a valid `mtx` file") from e
 
     @classmethod
-    def read_mtx(cls, fp: BinaryIO) -> Self:
+    def read_mtx(cls, fp: BinaryIO) -> Mtx:
         return cls.decode_mtx(fp.read())
 
     @classmethod
-    def decode_mtx(cls, data: bytes) -> Self:
+    def decode_mtx(cls, data: bytes) -> Mtx:
         length = int.from_bytes(data[:4], ENDIAN)
 
         if length != len(data):
@@ -85,9 +106,7 @@ class Mtx:
 
         sections = [
             read_offset(data, section_table_offset + (i * int_width))
-            for i in range(
-                (string_table_offset - section_table_offset) // int_width
-            )
+            for i in range((string_table_offset - section_table_offset) // int_width)
         ]
 
         # Add the length to the sections so we can read to end of stream
@@ -97,15 +116,13 @@ class Mtx:
 
         for current_string_offset, next_string_offset in pairwise(sections):
             strings.append([
-                _read_character(
-                    data, current_string_offset + (i * CHARACTER_WIDTH)
-                )
+                _read_character(data, current_string_offset + (i * CHARACTER_WIDTH))
                 for i in range(next_string_offset - current_string_offset)
             ])
 
         return cls(strings)
 
-    def write_xml_to_file(self, path: Path, fpd: Fpd) -> None:
+    def write_xml_to_file(self, path: str | PathLike[str], fpd: Fpd) -> None:
         with Path(path).open("wb") as fp:
             self.write_xml(fp, fpd)
 
@@ -121,18 +138,18 @@ class Mtx:
             dialog.text = "\n"
 
             for character in string:
-                match character:
-                    case 0xF813:
-                        dialog.append(etree.Element("arrow"))
-                    # TODO: Figure out what this control character does
-                    case 0xF883:
-                        dialog.text += "0xF883"
-                    case 0xFFFD:
-                        dialog.text += "\n"
-                    case 0xFFFF:
-                        break
-                    case _:
-                        dialog.text += fpd[character]
+                # TODO: When upgrading to Python 3.10, use `match` statements
+                if character == 0xF813:
+                    dialog.append(etree.Element("arrow"))
+                # TODO: Figure out what this control character does
+                elif character == 0xF883:
+                    dialog.text += "0xF883"
+                elif character == 0xFFFD:
+                    dialog.text += "\n"
+                elif character == 0xFFFF:
+                    break
+                else:
+                    dialog.text += fpd[character]
 
         etree.indent(root)
 

legacy_puyo_tools-0.2.0.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: legacy-puyo-tools
+Version: 0.2.0
+Summary: A tool to edit text for older Puyo Puyo games.
+Project-URL: changelog, https://github.com/wushenrong/legacy-puyo-tools/blob/main/CHANGELOG.md
+Project-URL: homepage, https://github.com/wushenrong/legacy-puyo-tools
+Project-URL: issues, https://github.com/wushenrong/legacy-puyo-tools/issues
+Project-URL: source, https://github.com/wushenrong/legacy-puyo-tools.git
+Author-email: Samuel Wu <twopizza9621536@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: puyopuyo
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: File Formats
+Classifier: Topic :: Games/Entertainment :: Puzzle Games
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: attrs>=25.3.0
+Requires-Dist: click>=8.1.8
+Requires-Dist: cloup>=3.0.7
+Requires-Dist: lxml>=6.0.0
+Description-Content-Type: text/markdown
+
+# Legacy Puyo Tools
+
+A command line tool for modding older Puyo Puyo games (Yes, the name is using a
+[reversed naming scheme](https://github.com/microsoft/WSL)).
+
+## Installation
+
+Install [Python](https://www.python.org/) 3.9 or later, preferably the latest
+version.
+
+`legacy-python-tools` is published to
+[PyPI](https://pypi.org/project/legacy-puyo-tools/). It is recommended to
+install tools from PyPI into an isolated Python environment.
+
+You can use [`pipx`](https://pipx.pypa.io):
+
+```bash
+pipx install legacy-python-tools
+# Or to run the cli without installing legacy-python-tools
+pipx run legacy-python-tools
+```
+
+Or [`uv`](https://docs.astral.sh/uv):
+
+```bash
+uv tool install legacy-python-tools
+# Or to run the cli without installing legacy-python-tools
+uv tool run legacy-python-tools
+# Or the shorter uvx
+uvx legacy-python-tools
+```
+
+And of course, you can use good old pip in a virtual Python environment using
+[`virualenv`](https://virtualenv.pypa.io) or the built-in `venv` library:
+
+```bash
+# Create a virtual python environment
+python -m venv .venv
+# Activate the virtual environment
+./.venv/Scripts/activate
+# Install legacy-python-tools
+python -m pip install legacy-python-tools
+```
+
+## Usage
+
+Create a `fpd` file from a UTF-16 little-endian encoded text file.
+
+```bash
+legacy-puyo-tools create fpd puyo14.txt
+```
+
+Or convert a `mtx` file to an editable XML file using a `fpd` file.
+
+```bash
+legacy-puyo-tools convert mtx --output custom_als.mtx --fpd puyo14.fpd als.xml
+```
+
+You can use the `--help` flag to see what sub-commands and options are
+available.
+
+## Supported Games
+
+This tool will try to support formats from the following Puyo games:
+
+- Puyo Puyo! 15th Annversivery
+- Puyo Puyo 7
+- Puyo Puyo!! 20th Annversivery (If there is demand)
+
+See
+[Formats](https://github.com/wushenrong/legacy-puyo-tools/blob/main/formats.md)
+for detailed information about these formats, and the current progress on
+creating and converting them.
+
+## Why
+
+The [Puyo Text Editor][puyo-text-editor] can already do what `legacy-puyo-tools`
+does and is the inspiration of this tool, but there are advantages to rewrite it
+in Python:
+
+[puyo-text-editor]: https://github.com/nickworonekin/puyo-text-editor
+
+- Better cross compatibility with Linux.
+- Easier migration when upgrade away from end of life language versions.
+- Avoids the rigidness of using a pure object-oriented design.
+
+## Contributing
+
+If you want to contribute to the project check out
+[Contributing](https://github.com/wushenrong/legacy-puyo-tools/blob/main/CONTRIBUTING.md).
+
+## License
+
+Under the MIT License. Based on [Puyo Text Editor][puyo-text-editor] which is
+also under the MIT License.

legacy_puyo_tools-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+legacy_puyo_tools/__init__.py,sha256=LjS0jFv5pdhJceptQG9WtToZKBMzwCCXRiCa9YofnO0,277
+legacy_puyo_tools/__main__.py,sha256=LCp7zRagZzAyqpsJSzgMlRF36sWvMMNC7Ufq52cUdVQ,232
+legacy_puyo_tools/cli.py,sha256=ql8nEAiojQTpl1ug6VMYIaWEXHko2_JJHk8_w7ZhCac,4128
+legacy_puyo_tools/exceptions.py,sha256=0xT7q1t1r_YSZAv7OUPUgiui1QN3AwBw4cNyxOt_pkA,472
+legacy_puyo_tools/fpd.py,sha256=2_FBRSZjmioYYbZ7govMqtEkXdh1Exl3NmfswvZQ1qY,8763
+legacy_puyo_tools/mtx.py,sha256=3DukplefdG7jnsLaDXoQ68QaUto9qpsmYgMPmF0Pksk,4972
+legacy_puyo_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+legacy_puyo_tools-0.2.0.dist-info/METADATA,sha256=PqX1AU9Jr4lkZ6ynmTWFLlt1qVP0b1wCJEn-oohLMXY,4042
+legacy_puyo_tools-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+legacy_puyo_tools-0.2.0.dist-info/entry_points.txt,sha256=U1UoBDFd576Xi_8PuLVUXZcGV6Idk1Bc-UlF9UNYYh0,64
+legacy_puyo_tools-0.2.0.dist-info/licenses/LICENSE,sha256=4G2c45JIaRJFR-0AbNA1uV354akZGEcbnBgpdNokvGE,1117
+legacy_puyo_tools-0.2.0.dist-info/RECORD,,

legacy_puyo_tools-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+legacy-puyo-tools = legacy_puyo_tools.cli:app

{legacy_puyo_tools-0.0.1.dist-info → legacy_puyo_tools-0.2.0.dist-info}/licenses/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2025 Samuel Wu
+Copyright (c) 2021 Nick Woronekin
+Copyright (c) 2025 Samuel Wu and contributors
 
 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

legacy_puyo_tools-0.0.1.dist-info/METADATA

@@ -1,34 +0,0 @@
-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.dist-info/RECORD

@@ -1,11 +0,0 @@
-legacy_puyo_tools/__init__.py,sha256=tTzyNju0CFsXWki9ttjO6qnNx4Dlmur-1zgJ-n9toB0,277
-legacy_puyo_tools/cli.py,sha256=gqwjiuSqAzuJRc_Tei1WRxRWGMC0AycWhf940oY-UrY,4934
-legacy_puyo_tools/exceptions.py,sha256=vqoMG7VjUddzWGMIvzWtE18U6fnmMW7VcpwdOIoOiBc,341
-legacy_puyo_tools/fpd.py,sha256=XXVCMlYD_eJAhmIQzDlRFvqm-FG9imm68bLooM2-mi4,8306
-legacy_puyo_tools/mtx.py,sha256=8dGHE719LuOZ9fi8uEgAKh5YIdCuvo9bXAEbcwxaC8Q,4253
-legacy_puyo_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-legacy_puyo_tools-0.0.1.dist-info/METADATA,sha256=PCxhnsrQHopcml8PQbgEuBGBP4z_4rPbZWHMkFftFxc,1167
-legacy_puyo_tools-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-legacy_puyo_tools-0.0.1.dist-info/entry_points.txt,sha256=SWkgMVVrmWMKaFJXbb0vx-qAjqMWnxm3_0AVwYCdZLs,65
-legacy_puyo_tools-0.0.1.dist-info/licenses/LICENSE,sha256=hu6L3ztT5uuc-EMaEgsjrhAHSTh56efyD-tVaEpc7Rw,1066
-legacy_puyo_tools-0.0.1.dist-info/RECORD,,

legacy_puyo_tools-0.0.1.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-legacy-puyo-tools = legacy_puyo_tools.cli:main