Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.92 KB

File metadata and controls

56 lines (39 loc) · 1.92 KB

🧩 Project Raco Plugin Documentation

This guide outlines how to create, structure, and deploy plugins for Project Raco.

Click to view Plugin Architecture
Design of Plugin drawio

⚙️ How It Works

Unlike standard Magisk Modules, Raco plugins have unique execution behaviors. A plugin can operate in two modes:

  1. Manual Execution
  2. Start on Boot

Warning

Syntax Requirement: All scripts (install.sh, service.sh, uninstall.sh) must be written in standard Shell Language.
Do not use Magisk Module-specific syntax or functions, as they will cause the plugin to fail.

Plugins is on /data/ProjectRaco/Plugins


📂 Plugin Structure

Your plugin .zip file must follow this exact directory structure:

Raco Plugin.zip/
├── raco.prop
├── service.sh
├── webroot / (If you want to add WebUI (added in Raco 5.0)
├── uninstall.sh
├── install.sh
├── post-fs-data.sh
└── Logo.png (Optional) - Max 512x512

📝 Configuration (raco.prop)

The raco.prop file is the heart of your plugin. You must define the following property for the plugin to be recognized by the system:

RacoPlugin=1

If this line is missing, the installation will fail.

🔗 Resources & Downloads

Resource Description Link
Plugin Example A reference implementation (PingImp) View Example
Plugin Template Empty starter template Download Template