Developer Guide

TrollFools Repository Guide

For developers: How to create your own repository

Repository Requirements

To create a TrollFools-compatible repository, you need:

Web Server
  • HTTPS Support
ملف trollpackages.json
  • In root directory
Package Files
  • .dylib, .zip, .deb

Repository Structure

Folder Structure
your-repository.com/
├── trollpackages.json
├── icons/
│   ├── tweak1-icon.png
│   └── tweak2-icon.png
├── downloads/
│   ├── tweak1.dylib
│   ├── tweak2.zip
│   └── tweak3.deb
├── screenshots/
│   ├── tweak1-screenshot1.png
│   └── tweak1-screenshot2.png
└── repo-icon.png

trollpackages.json File Format

JSON Structure
{
  "repository_name": "اسم مستودعك",
  "repository_icon": "https://yoursite.com/repo-icon.png",
  "packages": [
    {
      "name": "اسم الحزمه",
      "version": "v1.0.0",
      "description": "وصف مفصل للحزمه وميزاتها",
      "app_url": "رابط التطبيق اذا كانت الاداه تعمل على تطبيق معين",
      "bundle": "بندل التطبيق للحقن التلقائي",
      "icon_url": "https://yoursite.com/icons/package-icon.png",
      "dylib": "https://yoursite.com/downloads/package.dylib",
      "section": "قسم الحزمه",
      "size": "حجم الملف",
      "author": "اسم المطور",
      "screenshots": [
        "https://yoursite.com/screenshots/screenshot1.png",
        "https://yoursite.com/screenshots/screenshot2.png"
      ]
    }
  ]
}

Required and Optional Fields

Repository Fields
  • repository_name Required: Repository name
  • repository_icon Optional: Repository icon
  • packages Required: Packages array
Package Fields
  • name Required: Package name
  • version Required: Package version
  • description Required: Package description
  • app_url Optional: App link if the Tweak is for a specific app
  • bundle Optional: Application bundle for automatic injection
  • dylib Required: Package file link
  • icon_url Optional: Package icon
  • section Optional: Package section
  • size Optional: File size
  • author Optional: Developer name
  • screenshots Optional: Package screenshots

Supported File Types

.dylib: دايليب .zip: ملف مضغوط .deb: حزمة ديبيان

Server Requirements

HTTPS
  • Server must support HTTPS
CORS
  • Make sure CORS requests are not blocked
Content-Type
  • Ensure application/json is sent for JSON file

How to Add Repository for Users

  1. Open TrollFools
  2. Tap the "+" icon next to refresh button
  3. Enter repository URL (without /trollpackages.json)
  4. Example: https://trollfools.example.com

Best Practices Dear Developer

  1. High Quality Icons: Use 512x512 pixel icons
  2. Clear Descriptions: Write useful and detailed descriptions
  3. Accurate Sizes: Specify file sizes accurately
  4. Correct Links: Ensure all links are valid
  5. Regular Updates: Keep the repository updated

Test Repository

Make sure of:

  • trollpackages.json file accessibility
  • JSON format validity
  • All file links working
  • Repository and package icons availability
  • Entered information correctness

Publish Repository

  1. Upload all files to server
  2. Test repository access
  3. Share repository link with users