Skip to content

Sonolus.py

Sonolus.py is a Python library for creating Sonolus engines.

Installation

Sonolus.py is available on PyPI and can be installed using a package manager like pip.

pip install sonolus.py

uv add sonolus.py

Getting Started

If you're new to Sonolus.py, the guide section is a good place to start. It provides an introduction to various aspects of making a Sonolus.py engine.

For a ready-to-use example, the pydori engine is a Sonolus.py engine that implements a Bandori-style (vertical scrolling rhythm game) gameplay and is intended to serve as a reference implementation of a Sonolus.py engine.

When creating a new project, you may want to use the new project template.

Documentation

  • Overview: High-level overview of Sonolus.py.
  • Concepts: Detailed information on concepts and usage.
  • Reference: Detailed information on included classes and functions.