Skip to content

README.md

Latest commit

 

History

History
35 lines (26 loc) · 1.19 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.19 KB

Pyamoto

The New Super Mario Bros. U level editor

Pyamoto is an advanced fork of the original Miyamoto editor with the purpose of improving functionality and usability.

Installation

Download the latest release from the releases page.

Usage

Follow the guide on the wiki.

Running from Source

Prerequisites: Python 3 (Windows: check "Add Python to PATH" during install), Git.

git clone https://github.com/Zenith-Team/Pyamoto
cd Pyamoto
bash setup_venv.sh
.venv/bin/python3 pyamoto.py   # macOS/Linux
# or on Windows:
# .venv\Scripts\python pyamoto.py

Building from Source

Install the extra build dependencies, then run the release script:

.venv/bin/pip install "cx_Freeze==8.4.1" "dmgbuild==1.6.5"  # macOS; omit dmgbuild on Windows/Linux
bash build_release.sh          # uses the version in project.json
bash build_release.sh 1.1      # override the version
  • macOS — produces Pyamoto-v<version>-macOS-universal.dmg in the repo root.
  • Windows / Linux — produces distrib/miyamoto_v<version>/ ready to zip.