init

README.md

@@ -1,2 +1,108 @@
 # flexget-nexusphp
-A flexget plugin for filter nexusphp torrents
+Flexget插件，增强对NexusPHP的过滤
+过滤条件包括种子优惠信息（free等）、做种者情况、下载者情况
+- `注意：本插件为测试版，未经过完全的测试`
+
+## 运行环境
+- 已安装flexget
+- python 3.X
+
+## 安装插件
+将插件拷贝至配置文件夹下的plugins文件夹，例如：
+```
+~/.flexget/plugins/  # Linux
+C:\Users\<YOURUSER>\flexget\plugins\  # Windows
+```
+## 使用
+1. 编辑flexget配置文件，添加nexusphp选项，按照需要进行配置
+``` yaml
+nexusphp:
+  cookie: 'you_cookie'
+  discount:
+    - free
+    - 2x
+    - 2x50%
+    - 2xfree
+    - 50%
+    - 30%
+  seeders:
+    min: 1
+    max: 2
+  leechers:
+    min: 10
+    max: 100
+    max_complete: 0.8
+```
+2. 为rss的other_fields字段添加link属性
+``` yaml
+rss: 
+  url: https://www.example.com/rss.xml
+  other_fields:
+    - link
+```
+3. 启动flexget
+``` bash
+flexget execute
+```
+
+## 详细配置
+### cookie
+网站cookie，必须填写
+### discount
+优惠类型，默认不限制优惠类型。
+列表类型，Flexget会只下载含有列表内优惠类型的种子。
+有效值：`free 2x 2x50% 2xfree 50% 30%`
+`注意：x为英文字母`
+### seeders
+做种情况，包含字段`min` `max`。做种人数超出范围的，Flexget将不会下载
+#### min
+数字，最小做种人数，默认不限制
+#### max
+数字，最大做种人数，默认不限制
+### leechers
+下载情况，包含字段`min` `max` `max_complete`。做种人数超出范围的，Flexget将不会下载
+#### min
+数字，最小下载人数，默认不限制
+#### max
+数字，最大下载人数，默认不限制
+### max_complete
+小数，范围`0-1.0` 下载者中最大完成度，超过这个值将不下载，默认为1
+
+## 完整配置示例
+### 免费热种
+``` yaml
+tasks:
+  task_name:
+    rss: 
+      url: https://www.example.com/rss.xml
+      other_fields:
+        - link
+    nexusphp:
+      cookie: 'you_cookie'
+      discount:
+        - free
+        - 2xfree
+      seeders:
+        min: 1
+        max: 3
+      leechers:
+        min: 5
+        max_complete: 0.5
+    download: ~/flexget/torrents/
+```
+### 热种
+``` yaml
+tasks:
+  task_name:
+    rss: 
+      url: https://www.example.com/rss.xml
+      other_fields:
+        - link
+    nexusphp:
+      cookie: 'you_cookie'
+      seeders:
+        min: 1
+      leechers:
+        min: 20
+    download: ~/flexget/torrents/
+```