Creating a Module¶

To start developing your own module, you first need to create the required files inside your modules/ directory. These files are as follows:

my_module/
├─ __init__.py
├─ manifest.toml
└─ settings_schema.toml  (optional)

__init__.py¶

This is the entrypoint into your module. When your module is loaded, Breadcord will try to import from this file.

manifest.toml¶

This contains metadata which describes your module to Breadcord. See the Module Manifest page for more information.

settings_schema.toml¶

This defines the settings which your module uses, to be added to the settings.toml file. This file is optional and can be omitted if your module does not need any settings.