Home - Morxemplum/bopymo GitHub Wiki

Welcome to the Bopymo wiki! This wiki will show you how to get started using the Bopymo module and using it to write Python scripts for generating your Bopimo levels.

Requirements

Bopymo requires a Python version of 3.12 or newer to use.

Depending on which version of Bopymo you install, it will only be compatible with certain versions of Bopimo. That's because unlike Bopymo, the bopjson format in of itself does not have reverse compatibility built in and if a feature is replaced with a new one, it is immediately reflected. When this happens, this usually will involve bumping up the minimum Bopimo version to ensure that Bopymo code will not generate files incompatible on older versions of Bopimo.

Before Getting Started

This wrapper requires users to know how to use the Python programming language. If you are new to Python and/or you want to learn how to code, there are plenty of useful tutorials out there that will teach you the basics of Python. The effectiveness of this wrapper reflects on your coding skills; if you know how to write good code, you can take full advantage of Bopymo and reap its benefits.

While you are free to write code in any text editor of your choosing, it is recommended to use an IDE such as Visual Studio Code (or Codium as a FOSS alternative) so that you are able to easily manage your Python code.

It is highly recommended that you use a type checker such as MyPy or Pylance. Bopymo has extensive type hinting that will be incredibly useful for catching typing errors when using an IDE. This will make your debugging much simpler, I promise.

Installing Bopymo

Since 0.3, Bopymo is now a package that must be installed through Pip. There are no online sources for installing Bopymo, so you will have to install it through a file. There are two ways of getting the Bopymo package. The first and easier method is by downloading it from the releases page. The alternative way is by cloning the git repository and building it yourself using python -m build.

Once you have the tarball for the Bopymo package, you are going to install it through Pip. For a global Python environment, run the following command to install Bopymo.

python -m pip install path/to/bopymo-version-number.tar.gz

However, if you're using a virtual environment (which is recommended), the command will look more like this.

.venv/bin/pip install path/to/bopymo-version-number.tar.gz