docs: add README for NicotinePlus plugins with installation and usage details

2026-05-23 10:22:28 -04:00
parent 9548dc5555
commit 817618333b
1 changed files with 69 additions and 0 deletions
@@ -0,0 +1,69 @@
+# 🎵 NicotinePlus Plugins
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.6+-green.svg)](https://www.python.org/)
+[![Nicotine+](https://img.shields.io/badge/Nicotine+-Compatible-brightgreen.svg)](https://nicotine-plus.org/)
+
+> Enhance your Nicotine+ experience with powerful, community-driven plugins.
+
+## 📋 Table of Contents
+
+- [About](#about)
+- [Available Plugins](#available-plugins)
+- [Installation](#installation)
+- [Contributing](#contributing)
+
+## About
+
+This directory contains plugins for **Nicotine+**, a graphical client for the Soulseek file sharing network. 
+
+A plugin is a Python module that extends the functionality of the main application. Plugins can:
+- ✨ Add new features
+- 🔧 Modify existing features
+- 🔗 Integrate with other applications
+- 🤖 Automate common tasks
+
+## Available Plugins
+
+### 🤖 [Autobuddy](https://gitea.rcs1.top/sickprodigy/nicotineplus-plugins/src/branch/main/autobuddy)
+
+Automatically manage your buddy list based on channel interactions.
+
+**Features:**
+- Auto-add users who join specific channels
+- Customizable trigger phrases (e.g., "add me plz")
+- Perfect for communities like **SickGaming.net**
+
+**How it works:**
+When a user joins a monitored channel and says a trigger phrase, anyone with this plugin enabled will automatically add them to their buddy list.
+
+---
+
+### 📚 [ExamplePlugin](https://gitea.rcs1.top/sickprodigy/nicotineplus-plugins/src/branch/main/exampleplugin)
+
+A reference implementation demonstrating best practices for Nicotine+ plugin development.
+
+**Perfect for:**
+- Learning plugin architecture
+- Understanding Nicotine+ API
+- Creating custom plugins
+
+---
+
+## Installation
+
+1. Clone or download the plugin files
+2. Place them in your Nicotine+ plugins directory
+3. Restart Nicotine+ to load the plugins
+4. Enable plugins in Preferences → Plugins
+
+## Contributing
+
+Contributions are welcome! Feel free to:
+- Report issues
+- Suggest new features
+- Submit pull requests
+
+---
+
+**Made with ❤️ for the Soulseek community**