|logo|
SkyTemple Randomizer
====================
|build| |crowdin| |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
.. |crowdin| image:: https://badges.crowdin.net/skytemple/localized.svg
:target: https://crowdin.com/project/skytemple
:alt: Localization Progress
.. |build| image:: https://img.shields.io/github/actions/workflow/status/SkyTemple/skytemple-randomizer/build-test-publish.yml
:target: https://pypi.org/project/skytemple-randomizer/
:alt: Build Status
.. |pypi-version| image:: https://img.shields.io/pypi/v/skytemple-randomizer
:target: https://pypi.org/project/skytemple-randomizer/
:alt: Version
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/skytemple-randomizer
:target: https://pypi.org/project/skytemple-randomizer/
:alt: Downloads
.. |pypi-license| image:: https://img.shields.io/pypi/l/skytemple-randomizer
:alt: License (GPLv3)
.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/skytemple-randomizer
:alt: Supported Python versions
.. |discord| image:: https://img.shields.io/discord/710190644152369162?label=Discord
:target: https://discord.gg/skytemple
:alt: Discord
.. |kofi| image:: https://www.ko-fi.com/img/githubbutton_sm.svg
:target: https://ko-fi.com/I2I81E5KH
:alt: Ko-Fi
Randomizer for Pokémon Mystery Dungeon Explorers of Sky.
It is available for Linux, macOS and Windows.
Downloads
---------
- Windows: https://projectpokemon.org/home/files/file/4235-skytemple-randomizer/
- MacOS: https://projectpokemon.org/home/files/file/4235-skytemple-randomizer/
- Linux: https://flathub.org/apps/details/org.skytemple.Randomizer
|flathub_badge|
Frontends
---------
GTK frontend
~~~~~~~~~~~~
When installing from source, you probably want to install the "gtk" extra (``pip install -e '.[gtk]'``),
in order to have the actual GUI functional.
The GTK frontend requires GTK 4.14+, all related libraries and libadwaita 1.5+ to be
installed.
When installing this way, the GUI can be started with
``skytemple_randomizer gui`` or ``python -m skytemple.randomizer.main gui``.
The command takes an optional argument, the path to a ROM to open.
Build
.....
Install the required GTK and Adwaita versions. Under Windows, use gvsbuild_ in at least version 2024.4.0.
In addition to normally installing the Python package in dev mode, you also need to make sure you
have all submodules checked out. After this you need to compile all MO files (localizations) and Blueprint
Files to XML UI files. To do that:
- Linux, possibly MacOS: ``make``
- Linux/MacOS without make: ``./build-blp-to-ui.sh && installer/generate-mo.sh``
- Windows: ``.\build-blp-to-ui.ps1`` with PowerShell and ``installer\generate-mo.sh`` with an MSys2 environment bash
shell. Gettext must be available.
If you are working with the UI files you may want to use the Blueprint Compiler Language Server or setup file watchers
to compile BLP files to UI files. More info about Blueprint Compiler can be found on its website:
https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/
CLI
~~~
SkyTemple Randomizer can be used via CLI. It's available via ``skytemple_randomizer cli`` or
``python -m skytemple.randomizer.main cli``.
Its documentation can be found in CLI_API.md.
API
~~~
You can also use SkyTemple Randomizer as a Python API.
See the ``skytemple_randomizer.randomizer_thread`` for the entrypoint (specifically the class ``RandomizerThread``).
You will need to implement your own ``AbstractFrontend``. The passed in ``Status`` object can be used to monitor the
status of the randomization for progress display. See the GTK implementation for reference on how to use all of this.
.. _Flathub: https://flathub.org/apps/details/org.skytemple.Randomizer
.. |flathub_badge| image:: https://flathub.org/assets/badges/flathub-badge-en.png
:target: https://flathub.org/apps/details/org.skytemple.Randomizer
:alt: Install on Flathub
:width: 240px
.. _SkyTemple: https://github.com/SkyTemple/SkyTemple
.. _gvsbuild: https://github.com/wingtk/gvsbuild
See also
--------
Source repository for the Flatpak: https://github.com/flathub/org.skytemple.Randomizer
|kofi|
Raw data
{
"_id": null,
"home_page": null,
"name": "skytemple-randomizer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "rom-hacking, game-modding, skytemple, gtk, randomizer",
"author": null,
"author_email": "\"Marco \\\"Capypara\\\" K\u00f6pcke\" <hello@capypara.de>",
"download_url": null,
"platform": null,
"description": "|logo|\n\nSkyTemple Randomizer\n====================\n\n|build| |crowdin| |pypi-version| |pypi-downloads| |pypi-license| |pypi-pyversions| |discord|\n\n.. |logo| image:: https://raw.githubusercontent.com/SkyTemple/skytemple/master/skytemple/data/icons/hicolor/256x256/apps/skytemple.png\n\n.. |crowdin| image:: https://badges.crowdin.net/skytemple/localized.svg\n :target: https://crowdin.com/project/skytemple\n :alt: Localization Progress\n\n.. |build| image:: https://img.shields.io/github/actions/workflow/status/SkyTemple/skytemple-randomizer/build-test-publish.yml\n :target: https://pypi.org/project/skytemple-randomizer/\n :alt: Build Status\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/skytemple-randomizer\n :target: https://pypi.org/project/skytemple-randomizer/\n :alt: Version\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/skytemple-randomizer\n :target: https://pypi.org/project/skytemple-randomizer/\n :alt: Downloads\n\n.. |pypi-license| image:: https://img.shields.io/pypi/l/skytemple-randomizer\n :alt: License (GPLv3)\n\n.. |pypi-pyversions| image:: https://img.shields.io/pypi/pyversions/skytemple-randomizer\n :alt: Supported Python versions\n\n.. |discord| image:: https://img.shields.io/discord/710190644152369162?label=Discord\n :target: https://discord.gg/skytemple\n :alt: Discord\n\n.. |kofi| image:: https://www.ko-fi.com/img/githubbutton_sm.svg\n :target: https://ko-fi.com/I2I81E5KH\n :alt: Ko-Fi\n\nRandomizer for Pok\u00e9mon Mystery Dungeon Explorers of Sky.\n\nIt is available for Linux, macOS and Windows.\n\nDownloads\n---------\n- Windows: https://projectpokemon.org/home/files/file/4235-skytemple-randomizer/\n- MacOS: https://projectpokemon.org/home/files/file/4235-skytemple-randomizer/\n- Linux: https://flathub.org/apps/details/org.skytemple.Randomizer\n\n|flathub_badge|\n\nFrontends\n---------\n\nGTK frontend\n~~~~~~~~~~~~\nWhen installing from source, you probably want to install the \"gtk\" extra (``pip install -e '.[gtk]'``),\nin order to have the actual GUI functional.\n\nThe GTK frontend requires GTK 4.14+, all related libraries and libadwaita 1.5+ to be\ninstalled.\n\nWhen installing this way, the GUI can be started with\n``skytemple_randomizer gui`` or ``python -m skytemple.randomizer.main gui``.\nThe command takes an optional argument, the path to a ROM to open.\n\nBuild\n.....\nInstall the required GTK and Adwaita versions. Under Windows, use gvsbuild_ in at least version 2024.4.0.\n\nIn addition to normally installing the Python package in dev mode, you also need to make sure you\nhave all submodules checked out. After this you need to compile all MO files (localizations) and Blueprint\nFiles to XML UI files. To do that:\n\n- Linux, possibly MacOS: ``make``\n- Linux/MacOS without make: ``./build-blp-to-ui.sh && installer/generate-mo.sh``\n- Windows: ``.\\build-blp-to-ui.ps1`` with PowerShell and ``installer\\generate-mo.sh`` with an MSys2 environment bash\n shell. Gettext must be available.\n\nIf you are working with the UI files you may want to use the Blueprint Compiler Language Server or setup file watchers\nto compile BLP files to UI files. More info about Blueprint Compiler can be found on its website:\nhttps://jwestman.pages.gitlab.gnome.org/blueprint-compiler/\n\nCLI\n~~~\nSkyTemple Randomizer can be used via CLI. It's available via ``skytemple_randomizer cli`` or\n``python -m skytemple.randomizer.main cli``.\n\nIts documentation can be found in CLI_API.md.\n\nAPI\n~~~\nYou can also use SkyTemple Randomizer as a Python API.\nSee the ``skytemple_randomizer.randomizer_thread`` for the entrypoint (specifically the class ``RandomizerThread``).\nYou will need to implement your own ``AbstractFrontend``. The passed in ``Status`` object can be used to monitor the\nstatus of the randomization for progress display. See the GTK implementation for reference on how to use all of this.\n\n.. _Flathub: https://flathub.org/apps/details/org.skytemple.Randomizer\n\n.. |flathub_badge| image:: https://flathub.org/assets/badges/flathub-badge-en.png\n :target: https://flathub.org/apps/details/org.skytemple.Randomizer\n :alt: Install on Flathub\n :width: 240px\n\n.. _SkyTemple: https://github.com/SkyTemple/SkyTemple\n\n.. _gvsbuild: https://github.com/wingtk/gvsbuild\n\nSee also\n--------\n\nSource repository for the Flatpak: https://github.com/flathub/org.skytemple.Randomizer\n\n|kofi|\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Randomizer GUI to randomize the ROM of Pok\u00e9mon Mystery Dungeon Explorers of Sky",
"version": "2.0.0",
"project_urls": {
"Announcements": "https://blog.skytemple.org",
"Changelog": "https://download.skytemple.org/randomizer",
"Discord": "https://discord.gg/skytemple",
"Documentation": "https://wiki.skytemple.org",
"Downloads": "https://download.skytemple.org/randomizer",
"Homepage": "https://skytemple.org",
"Issues": "https://github.com/SkyTemple/skytemple-randomizer/issues",
"Repository": "https://github.com/SkyTemple/skytemple-randomizer.git"
},
"split_keywords": [
"rom-hacking",
" game-modding",
" skytemple",
" gtk",
" randomizer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf1dfc9d6db6fef465e1ac21f928969feb7f49b20f82fe87d89822f1292aa123",
"md5": "7086f654b233eb35ce12c29a321ff4bf",
"sha256": "4e63ae621a2334d1791153e83a1eb4370acb668420e033bfb662a1975648aeec"
},
"downloads": -1,
"filename": "skytemple_randomizer-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7086f654b233eb35ce12c29a321ff4bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 3067090,
"upload_time": "2024-04-24T23:08:12",
"upload_time_iso_8601": "2024-04-24T23:08:12.983387Z",
"url": "https://files.pythonhosted.org/packages/cf/1d/fc9d6db6fef465e1ac21f928969feb7f49b20f82fe87d89822f1292aa123/skytemple_randomizer-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 23:08:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SkyTemple",
"github_project": "skytemple-randomizer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "skytemple-randomizer"
}
JSON
