nas/syno-videoinfo-plugin
1
0
Fork 0
mirror of https://github.com/C5H12O5/syno-videoinfo-plugin.git synced 2025-07-29 12:49:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
C5H12O5
2023-08-17 11:45:04 +08:00
parent f8247d5d76
commit 4a6e87665d
2 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -13,12 +13,21 @@ other than the default ones.
* Implemented in Python without any third-party dependencies.
* Supports multiple sources, and can be easily extended to support more.
* Has a simple configuration page where you can customize your plugin.
## Usage
1. Download the latest release from [here](https://github.com/C5H12O5/syno-videoinfo-plugin/releases).
2. Open your Video Station, go to "Settings" > "Video Info Plugin".
3. Click "Add", select the downloaded file, and click "OK".
Install the plugin:
1. Download the latest release from [**here**](https://github.com/C5H12O5/syno-videoinfo-plugin/releases).
2. Open your Video Station, go to ***Settings*** > ***Video Info Plugin***.
3. Click ***Add***, select the downloaded file, and click ***OK***.
Configure the plugin:
1. Open your browser, go to `http://[NAS_IP]:5125` (replace `[NAS_IP]` with your NAS IP address).
2. Change the configuration as you want, and click ***Save Button*** in the upper right corner.
3. Go back to your Video Station, the configuration should be applied automatically.
## Requirements
@ -39,7 +48,7 @@ other than the default ones.
> * Example: Avatar (2009).avi
>
> TV Show:
> * Naming format: TV_Show_Name.SXX.EYY.ext ("S" as a shorthand for "Season and "E" for "Episode")
> * Naming format: TV_Show_Name.SXX.EYY.ext (***S*** as a shorthand for ***Season*** and ***E*** for ***Episode***)
> * Example: Gossip Girl.S03.E04.avi
## Development
@ -55,7 +64,7 @@ $ git clone https://github.com/C5H12O5/syno-videoinfo-plugin
2. Modify the code as you want, and test it like this:
```sh
$ python main.py --type movie --input "{\"title\":\"{movie title}\"}" --limit 1 --loglevel debug
$ python main.py --type movie --input "{\"title\":\"{movie_title}\"}" --limit 1 --loglevel debug
```
3. Package the plugin using the following command:

21
README.zh-CN.md
View File

@ -12,12 +12,21 @@
* 使用Python标准库实现，无需安装任何依赖。
* 支持多个数据来源，并且可以轻松扩展。
* 有简单的配置页面，可以自定义你的插件。
## 使用说明
1. 从[此处](https://github.com/C5H12O5/syno-videoinfo-plugin/releases)下载最新版本。
2. 打开 Video Station，进入“设置” > “视频信息插件”。
3. 点击“新增”，选择第一步下载的压缩包，然后点击“确定”。
安装插件：
1. 从[**此处**](https://github.com/C5H12O5/syno-videoinfo-plugin/releases)下载最新版本。
2. 打开 Video Station，进入 ***设置*** > ***视频信息插件***。
3. 点击 ***新增***，选择第一步下载的压缩包，然后点击 ***确定***。
配置插件：
1. 打开你的浏览器，输入`http://[NAS_IP]:5125`（将`[NAS_IP]`替换为你的NAS的IP地址）。
2. 根据你的需要修改配置，然后点击右上角的***保存按钮***。
3. 返回你的 Video Station，保存的配置将会自动生效。
## 版本要求
@ -34,11 +43,11 @@
>
> 电影：
>
> * 命名格式：电影_名称 (发行_年份).ext
> * 命名格式：电影名称 (发行年份).ext
> * 例如：Avatar (2009).avi
>
> 电视节目：
> * 命名格式：电视_节目_名称.SXX.EYY.ext（“S”是“季数”的缩写，“E”是“集数”的缩写）
> * 命名格式：电视节目名称.SXX.EYY.ext（***S*** 是 ***季数*** 的缩写，***E*** 是 ***集数*** 的缩写）
> * 例如：Gossip Girl.S03.E04.avi
## 如何开发
@ -54,7 +63,7 @@ $ git clone https://github.com/C5H12O5/syno-videoinfo-plugin
2. 根据需要修改代码，并可以使用以下命令进行测试：
```sh
$ python main.py --type movie --input "{\"title\":\"{movie title}\"}" --limit 1 --loglevel debug
$ python main.py --type movie --input "{\"title\":\"{movie_title}\"}" --limit 1 --loglevel debug
```
3. 然后可以使用以下命令进行打包并上传使用：