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 overview is a good place to start. It covers the supported Python subset, the core types, and the modules the library provides.

You can also check out the Sonolus.py guide. It walks through building a complete simple rhythm game engine in Sonolus.py.

For an example, pydori is a Sonolus.py engine implementing Bandori-style (vertical scrolling rhythm game) gameplay.

When creating a new project, you may want to use the new project template. The sonolus-py command line tool builds and serves a project.

Documentation

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