Welcome to Foundry’s Documentation!#

Release Unknown (What’s new?).

`Foundry` is the all-in-one editor for modifying Super Mario Bros. 3..

Our priority is providing an enjoyable platform to unleash your creative protential for the best game the world has to offer. Particularly with level editing, but we hope to extend our ambitions in the future.

It provides a modern graphical user interface built to make editing SMB3 as easy and simple as possible.

The editor can be downloaded through three methods:

Downloading through the precompiled releases on Github. Simply select a version and download the version in accordance to your machine.

Downloading the package through pip.

$ python -m pip install foundry-smb3

Downloading the repository and running it with Python.

$ git clone git@github.com:TheJoeSmo/Foundry.git
$ cd Foundry
$ pip install -r requirements-dev.txt
$ python -m foundry.main

Call for Contributions#

Foundry is a community driven initiative that relies on your help and expertise.

Small improvements or fixes are critical to this repository’s success. Issues labeled `good first issue` are a great place to start.

You do not need to be literate with programming to aid Foundry on its journey. We also need help with:

  • Developing tutorials

  • Creating graphics for our brand and promotional material

  • Translation

  • Outreach and onboarding new contributors

  • Reviewing issues and suggestions

If you are undecided on where to start, we encourage you to reach out. You can ask on our Discord or privately through email.

If you are new to open source projects and want to be caught up to speed, we recommend this guide.

Contents:

Indices and tables#