Plugin README Files

Every SA plugin must include two README files inside its version folder:

1.0.0/
├── README-EN.md    ← English documentation
└── README-AR.md    ← Arabic documentation

These files power the plugin's store page. They contain a YAML frontmatter block with structured metadata, and optionally a Markdown body with a full description.

Frontmatter

---
image: images,logo.png
name: Quick Links
description: A short one-paragraph description shown in search results and store listings.
type: 0
store:
  - _8787455244
  - _957744244
bloger:
  - _2401863575
versions:
  - version: 1.0.0
    number: 0
    items: [
      'Initial release'
    ]
faq: []
features: []
slides:
  - images,index.png
  - images,setting.png
cost:
  year: 30
  month: 3
  own: 300
---

Frontmatter Fields

Field	Type	Description
image	string	Logo image path — use comma instead of / (e.g. images,logo.png = images/logo.png)
name	string	Plugin display name
description	string	Short description shown in store listings and search
type	number	Plugin category type (0 = general)
store	string[]	Store IDs where this plugin is listed
bloger	string[]	Author/blogger IDs associated with this plugin
versions	array	Version history (see below)
faq	array	FAQ entries (leave as [] if none)
features	array	Feature entries (leave as [] if none)
slides	string[]	Screenshot paths for the store slideshow — same comma format as image
cost.year	number	Annual subscription price
cost.month	number	Monthly subscription price
cost.own	number	One-time ownership price

versions Structure

versions:
  - version: 1.0.0      # semver string
    number: 0           # matches versionNumber in setting.json
    items: [
      'Initial release',
      'Added dashboard widget'
    ]
  - version: 1.1.0
    number: 1
    items: [
      'Bug fixes'
    ]

Image Path Format

Motanamy uses a comma (,) instead of / for image paths in frontmatter:

# Correct
image: images,logo.png
slides:
  - images,screenshot1.png

# Wrong
image: images/logo.png

Markdown Body

Add an optional Markdown description below the frontmatter block. This is displayed as the main content on the store listing page.

---
# ... frontmatter above
---

A brief intro paragraph about what the plugin does.

## Key Features

### 1. Feature Name
Description of the feature.

## Use Cases

Who should use this plugin and in what situations.

Complete Example

README-EN.md

---
image: images,logo.png
name: Quick Links
description: Add Quick Links is a plugin that makes it easier to access frequently used links. Users can add links to websites, apps, or services they use often — increasing productivity and saving time.
type: 0
store:
  - _8787455244
  - _957744244
bloger:
  - _2401863575
versions:
  - version: 1.0.0
    number: 0
    items: [
      'start application'
    ]
faq: []
features: []
slides:
  - images,index.png
  - images,setting.png
cost:
  year: 30
  month: 3
  own: 300
---

Quick Links makes your most-visited pages always one click away.

## Features

### Custom Links
Add any internal route or external URL as a quick-access tile on your dashboard.

### Icon Support
Each link gets an icon — choose from PrimeIcons or MDI using the built-in icon picker.

### Role-Based Visibility
Links can be scoped per user role so different teams see their relevant shortcuts.

README-AR.md

---
image: images,logo.png
name: روابط سريعة
description: إضافة روابط سريعة هي برنامج يتم إضافته لتسهيل الوصول إلى الروابط المستخدمة بشكل متكرر.
type: 0
store:
  - _8787455244
  - _957744244
bloger:
  - _2401863575
versions:
  - version: 1.0.0
    number: 0
    items: [
      'بدء التطبيق'
    ]
faq: []
features: []
slides:
  - images,index.png
  - images,setting.png
cost:
  year: 30
  month: 3
  own: 300
---

روابط سريعة تجعل صفحاتك الأكثر زيارة في متناول يدك دائمًا بنقرة واحدة.