Metadata-Version: 2.1
Name: skytemple-files
Version: 0.1.0a5
Summary: Python library to edit the ROM of Pokémon Mystery Dungeon Explorers of Sky (EU/US)
Home-page: https://github.com/SkyTemple/skytemple-files/
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/x-rst
Requires-Dist: ndspy (>=3.0.0)
Requires-Dist: Pillow (>=6.1.0)
Requires-Dist: appdirs (>=1.4.0)
Requires-Dist: explorerscript (>=0.0.5)
Requires-Dist: skytemple-rust (>=0.0.1)
Requires-Dist: tilequant (>=0.0.1)
Requires-Dist: typing-extensions (==3.7.4.2) ; python_version < "3.7"
Requires-Dist: pyobjc (==6.2.1) ; sys_platform == "darwin"

|logo|

SkyTemple Files
===============

|build| |pypi-version| |pypi-downloads| |pypi-license| |pypi-pyversions| |discord|

.. |logo| image:: https://raw.githubusercontent.com/SkyTemple/skytemple/master/skytemple/data/icons/hicolor/256x256/apps/skytemple.png

.. |build| image:: https://jenkins.riptide.parakoopa.de/buildStatus/icon?job=skytemple-files%2Fmaster
    :target: https://jenkins.riptide.parakoopa.de/blue/organizations/jenkins/skytemple-files/activity
    :alt: Build Status

.. |pypi-version| image:: https://img.shields.io/pypi/v/skytemple-files
    :target: https://pypi.org/project/skytemple-files/
    :alt: Version

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/skytemple-files
    :target: https://pypi.org/project/skytemple-files/
    :alt: Downloads

.. |pypi-license| image:: https://img.shields.io/pypi/l/skytemple-files
    :alt: License (GPLv3)

.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/skytemple-files
    :alt: Supported Python versions

.. |discord| image:: https://img.shields.io/discord/710190644152369162?label=Discord
    :target: https://discord.gg/4e3X36f
    :alt: Discord

.. |kofi| image:: https://www.ko-fi.com/img/githubbutton_sm.svg
    :target: https://ko-fi.com/I2I81E5KH
    :alt: Ko-Fi

Python library to work with the files inside the ROM of Pokémon Mystery Dungeon Explorers of Sky.

This is still very WIP, so I didn't feel like
putting a proper README here! But you'll find
README's containing the documentation for file types
in the directories for the file handlers.

Directly in the package (``skytemple_files`` directory) you can find a few example scripts that help with understanding
how to use this library. After installing the package you will have them as cli commands: ``skytemple_<name>``. So for
``dungeon_randomizer.py`` it's ``skytemple_dungeon_randomizer``::

  $ skytemple_dungeon_randomizer input.nds output.nds

In addition to the dependencies in the ``requirements.txt`` and ``setup.py``, ARMIPS must
be installed and in the system's ``PATH`` to be able to apply ROM patches.

|kofi|


