Create a module
A module is a folder with a manifest manifest.json and code in Python or Rust. The manifest says what the module takes, what it gives and what settings it has; from it the platform draws its node in the graph and its fields on the panel. The platform hands each step of a program to its module and takes the answer.
Where to start
- In the workshop: «Library» → «Modules» → «Create a module». The platform lays down a template — a working module you only change.
- Write on SDK_Ogas: it takes care of the exchange with the platform, files, the chosen network, reports of progress.
- Check with
ogas_check.pyfrom the SDK: it names what in the module breaks the contract and the rules of the platform — by the files, before a run. - If the module takes the video card, say in the manifest how much video memory it needs (
resources.gpu_mb): by this number the platform shares the card, and the library tells a person whether the module runs on their computer.
Licences
- SDK_Ogas — Apache-2.0: you licence a module built on it as you wish, closed and paid included.
- The module template — 0BSD, no conditions: what you make of it is yours.
How to get on the showcase
Offer the module to the showcase from the platform: it goes as its files, signed by your profile. A module not in Python is sent as its sources with a lock file of its dependencies — the author of the site builds it himself. The author reads the code, checks the licence and where the module goes on the network, and puts it on the official showcase under your name, pinned by its checksum. A new version is checked again.