README.md

Custom Format Sync for Radarr and Sonarr

This project provides a GitHub Actions workflow to automatically sync custom formats across multiple Radarr and Sonarr instances, ensuring consistency in your media management setup.

✨ Key Features

• Sync custom formats to multiple Radarr and Sonarr instances
• Control which instances receive each custom format
• Set custom format scores for each quality profile
• Version tracking to ensure only updated formats are synced
• Automated syncing using GitHub Actions

📋 Custom Format Template

A _template.json file is provided in the custom_formats/ directory to help you create your own custom formats. The template includes:

• Required and optional fields with documentation
• Version handling using cfSync_version for automatic updates
• Instance targeting options (cfSync_radarr, cfSync_sonarr, cfSync_instances)
• Score management with cfSync_score
• Example specification structure

Simply copy _template.json, rename it, and modify according to your needs. The version in version.json will be automatically updated based on your custom format's cfSync_version.

🚀 Quick Start

1. Fork this repository (use the template-fork branch)
2. Set up GitHub Secrets for your Radarr and Sonarr instances
3. Enable GitHub Actions for your repository
4. Customize your custom formats in the custom_formats/ directory

For detailed instructions, please refer to our Wiki.

📚 Documentation

• Setup Guide
• Configuration
• Usage Instructions
• Troubleshooting

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

⚖️ License

This project is licensed under the AGPLv3 License - see the LICENSE file for details.