cd ~/Arbeitsfläche/Dream-Chatbox-Plugins && cat << 'EOF' > README.md
Welcome to the official plugin repository for OSC Dream Chatbox!
This repository serves as a collection of official plugins, community extensions, and templates to help developers build custom modules for the OSC Dream Chatbox ecosystem.
Dream-Chatbox-Plugins/
├── zip/ # Pre-built, ready-to-install plugin .zip files
├── template/ # Boilerplate example plugin for developers
└── plugins/ # Source code of official plugins
└── world_stats/ # Live VRChat instance info & clock integration
| Plugin | Version | Description | Source |
|---|---|---|---|
| World Stats | 1.0.0 |
Live VRChat info: player count, current world name, instance type, and local clock via log parsing. | plugins/world_stats |
- Download the pre-built
.zipfile of the plugin you want from thezip/folder or the Releases section. - Open OSC Dream Chatbox.
- Navigate to the Plugins tab and click Install Plugin (.zip).
- Select the downloaded
.zipfile and enable it!
Want to build a plugin for OSC Dream Chatbox? You can use the template/ directory as a starting point.
A plugin consists of a manifest (plugin.json) and the main logic file (main.py):
plugin.json: Defines the metadata, global placeholders, and user settings.main.py: Exportssetup(api),teardown(),get_values(), and optional UI hooks.
- Global Placeholders: Register placeholders without prefixes by adding them to
global_placeholdersinplugin.json(e.g.,{player_in_world},{realtime}). - Isolated Configuration: Settings are automatically stored under
plugins/<plugin_id>/configs/config.json. - Zero Dependencies: Keep core logic independent by bundling local helpers (e.g., log parsers) directly inside your plugin directory.
The templates and official plugins in this repository are licensed under the MIT License — feel free to copy, modify, and distribute your own plugins based on these examples without restrictions.
(Note: The core OSC Dream Chatbox application is licensed under GPLv3). EOF