3. Structure Directory

Folders

We describe the components of the development directory and environment.

The directory consists of two folders.

• rpp - Modules and functions that you can utilize to enhance your presence development.
• presences - Where the presences you will be developing are stored.

Each presence to be developed is stored in separate folders.

Files

Each presence must have at least the following two essential files:

main.py

The entry point of your presence . This will be the first file to execute and will define your presence as follows:

import rpp


@rpp.extension
class ExampleEmpty(rpp.Presence):
    def __init__(self):
        super().__init__(metadata=True)

    def on_load(self):
        self.log.info("Loaded")

    def on_update(self, **context):
        self.log.info("Updated")

    def on_close(self):
        self.log.info("Closed")

See Presence class for more information about the methods.

metadata.json

This file contains essential information about your presence, including its name, description, and other metadata that helps identify and categorize it.

{
    "name": "Youn presence name",
    "version": "1.0.0",
    "description": {},
    "clientId": "",
    "image": "",
    "updateInterval": 5,
    "author": "",
    "contributors": [],
    "web": false,
    "category": "",
    "color": "",
    "tags": []
}