From 8ddc675955b97dbc84c442198ab0ffb5d0d8aed0 Mon Sep 17 00:00:00 2001 From: Yoshiko2 <42309414+yoshiko2@users.noreply.github.com> Date: Mon, 29 Jun 2020 19:37:05 +0800 Subject: [PATCH] Update README.md --- README.md | 333 +++--------------------------------------------------- 1 file changed, 14 insertions(+), 319 deletions(-) diff --git a/README.md b/README.md index 9b750a8..e075e42 100644 --- a/README.md +++ b/README.md @@ -20,26 +20,6 @@ CLI 版本 **日本电影元数据 抓取工具 | 刮削器**，配合本地影片管理软件 Emby, Jellyfin, Kodi 等管理本地影片，该软件起到分类与元数据（metadata）抓取作用，利用元数据信息来分类，供本地影片分类整理使用。 #### 本地电影刮削与整理一体化解决方案 -# 目录 -* [声明](#声明) -* [FAQ](#FAQ) -* [效果图](#效果图) -* [下载](#下载) -* [如何使用](#如何使用) - * [快速开始](#快速开始) -* [完整文档](#完整文档) - * [运行参数](#运行参数) - * [拖动法/奇葩番号](#拖动法) - * [配置文件选择](#配置文件选择) - * [程序退出选择参数](#程序退出选择参数) - * [模块安装](#模块安装) - * [配置](#配置configini) - * [多目录影片处理](#多目录影片处理) - * [多集影片处理](#多集影片处理) - * [中文字幕处理](#中文字幕处理) - * [异常处理（重要）](#异常处理重要) -* [写在后面](#写在后面) - # 声明 **当你运行了本软件，即代表你接受了以下条款** * 本软件仅供**技术交流，学术交流**使用 @@ -61,309 +41,24 @@ CLI 版本 * The author of this software yoshiko2 reserves the right of final decision and final interpretation **If the user does not agree with any of the above terms, please do not use this software** - -# FAQ -### 软件能下片吗？ -* 本软件不提供任何影片下载地址，仅供本地影片分类整理使用 -### 什么是元数据（metadata）？ -* 元数据包括了影片的封面，导演，演员，简介，类型...... -### 软件收费吗？ -* 本软件永久免费，**除了作者钦yìng点以外** -### 软件运行异常怎么办？ -* 认真看 [异常处理（重要）](#异常处理重要) -### 为什么软件要单线程运行？ -* 多线程爬取可能会触发网站反爬机制，同时也违背了些道德，故单线程运行 - -# 效果图 -**图片来自网络**，图片仅供参考，具体效果请自行联想 -![preview_picture_1](https://i.loli.net/2019/07/04/5d1cf9bb1b08b86592.jpg) -![preview_picture_2](https://i.loli.net/2019/07/04/5d1cf9bb2696937880.jpg) - -# 下载 -### [下载地址](https://github.com/yoshiko2/AV_Data_Capture/releases) - -### For Advenced User|高级用户|开发者 -* 请clone源码包运行，并手动安装Python3环境 - -# 如何使用 -## 快速开始: -1. 下载[可执行程序](https://github.com/yoshiko2/AV_Data_Capture/#下载)或者源码 -1. 把软件拉到和电影的同一目录(暂不支持绝对路径工作) -2. 设置 config.ini 文件 -3. 运行软件等待完成 -4. 把 导出文件夹 导入至 Kodi, Emby, Jellyfin, Plex 中。 -5. emby/jellyfin头像上传可使用[gfriends](https://github.com/xinxin8816/gfriends) - -## 使用 Docker -Docker容器可以方便在在NAS上使用。 - -1. 将docker目录中的内容下载下来 -2. 构建镜像 `sudo docker-compose build jav` -3. 运行容器 `JAVUID=$(id -u) JAVGID=$(id -g) JAV_PATH= sudo docker up -d jav` -4. 容器运行结束后会自动退出，处理好的内容会存入`/organized`, 失败的内容会移入`/failure_output`. -5. 注意目前容器不支持配置代理。所以必须在路由器上配置好透明代理，或者在build之前自行修改`config.ini`的内容。 - -详细请看以下完整文档 - -# 完整文档 - -## 模块安装 -如果运行**源码**版，运行前请安装**Python环境**和安装以下**模块** - -在终端 cmd/Powershell/Terminal 中输入以下代码来安装模块 - -``` -pip install requests pyquery lxml Beautifulsoup4 pillow -``` - -## 配置config.ini -### 运行模式 -``` -[common] -main_mode=1 -``` -1为普通模式， -2为整理模式：仅根据女优把电影命名为番号并分类到女优名称的文件夹下 - -``` -success_output_folder=JAV_outputd -failed_output_folder=failed -``` -设置成功输出目录和失败输出目录 - --- -#### 软链接 -方便PT下载完既想刮削又想继续上传的仓鼠党同志 -``` -[common] -soft_link=0 -``` -1为开启软链接模式 -0为关闭 +**このソフトウェアを実行すると、次の条件に同意したことになります** +*このソフトウェアは、**技術交換、学術交換**専用です。 +*ソフトウェアの作成者は、Pythonを学習してプログラミングを改善するためにこのソフトウェアを作成しました +※本ソフトウェアを使用する前に、現地の法令を理解し、遵守してください本ソフトウェアの使用中に現地の法令に違反する場合は、本ソフトウェアを使用しないでください +※本ソフトウェアをご利用の際、地域で違法行為を行った場合は、お客様の負担となります。 +*ユーザーがこのソフトウェアを商業的および個人的な目的で使用することは固く禁じられています +*このソフトウェアの作者yoshiko2は、最終決定および最終解釈の権利を留保します。 +**ユーザーが上記の条件のいずれかに同意しない場合は、このソフトウェアを使用しないでください** ---- -### 网络设置 -``` -[proxy] -type=http -proxy=127.0.0.1:1081 -timeout=10 -retry=3 -``` -#### 针对某些地区的代理设置 +# 官方文档 +* [WIKI](https://github.com/yoshiko2/AV_Data_Capture/wiki/AV-Data-Capture-CLI) -``` -type=http -``` -代理类型 http或socks5 - -``` -proxy=127.0.0.1:1081 -``` - -打开```config.ini```,在```[proxy]```下的```proxy```行设置本地代理地址和端口，支持Shadowxxxx/X,V2XXX本地代理端口 -素人系列抓取建议使用日本代理 -**路由器拥有自动代理功能的可以把proxy=后面内容去掉** -**本地代理软件开全局模式的用户同上** -**如果遇到tineout错误，可以把文件的proxy=后面的地址和端口删除，并开启代理软件全局模式，或者重启电脑，代理软件，网卡** - ---- -#### 连接超时重试设置 -``` -timeout=10 -``` -10为超时重试时间 单位：秒 - ---- -#### 连接重试次数设置 -``` -retry=3 -``` -3即为重试次数 - ---- -#### 检查更新开关 -``` -[update] -update_check=1 -``` -0为关闭，1为开启，不建议关闭 - ---- -### 刮削网站优先级 -``` -[priority] -website=javbus,javdb,fanza,xcity,mgstage,fc2,avsox,jav321 -``` -用```,```英文逗号分开网站，刮削顺序从左往右 - ---- -### 排除指定字符和目录 -``` -[escape] -literals=\ -folders=failed,JAV_output -``` - -```literals=``` 标题指定字符删除，例如```iterals=\()```，则删除标题中```\()```字符 -```folders=``` 指定目录，例如```folders=failed,JAV_output```，多目录刮削时跳过failed,JAV_output - ---- -### 调试模式 -``` -[debug_mode] -switch=1 -``` - -如要开启调试模式，请手动输入以上代码到```config.ini```中，开启后可在抓取中显示影片元数据 - ---- -### (可选)设置自定义目录和影片重命名规则 -``` -[Name_Rule] -location_rule=actor+'/'+number -naming_rule=number+'-'+title -``` -已有默认配置 - ---- -### 命名参数 -``` -title = 片名 -actor = 演员 -studio = 公司 -director = 导演 -release = 发售日 -year = 发行年份 -number = 番号 -cover = 封面链接 -tag = 类型 -outline = 简介 -runtime = 时长 -series = 系列 -``` - -上面的参数以下都称之为**变量** - -### 例子： -自定义规则方法：有两种元素，变量和字符，无论是任何一种元素之间连接必须要用加号 **+** ，比如：```'naming_rule=['+number+']-'+title```，其中冒号 ' ' 内的文字是字符，没有冒号包含的文字是变量，元素之间连接必须要用加号 **+** - -### locaton_rule -该为影片路径规则 -目录结构规则：默认 ```location_rule=actor+'/'+number``` - -**不推荐修改时在这里添加 title**，有时 title 过长，因为 Windows API 问题，抓取数据时新建文件夹容易出错。 - -### naming_rule -该为媒体库内标题的命名规则规则，NFO文件内标题命名规则 -影片命名规则：默认 ```naming_rule=number+'-'+title``` - -**在 Emby, Kodi等本地媒体库显示的标题，不影响目录结构下影片文件的命名**，依旧是 番号+后缀。 - ---- - -### 更新开关 -``` -[update] -update_check=1 -``` - -1为开，0为关 - -## 运行参数 -以下运行参数均为可选参数 -### 拖动法 -如果遇到番号比较奇葩的影片，同时存在于可刮削的网站，可用拖动影片之主程序刮削，或者输入以下 -``` -AV_Data_Capture xxx-xxx-xxx.mp4 -``` -### 配置文件选择 -可以用```-c```或者```--config```选择其他配置文件 -默认值为```config.ini``` -``` -AV_Data_Capture -c config_other.ini -``` -### 程序自动退出 - -``` -AV_Data_Capture -a -``` -输入参数即可在刮削结束后自动结束程序 - -## 多集影片处理 -**建议使用视频合并合并为一个视频文件** -可以把多集电影按照集数后缀命名为类似```ssni-xxx-cd1.mp4m,ssni-xxx-cd2.mp4，abp-xxx-CD1.mp4```的规则，只要含有```-CDn./-cdn.```类似命名规则，即可使用分集功能 - -## 中文字幕处理 - -运行 ```AV_Data_capture.py/.exe``` - -当文件名包含: -中文，字幕，-c., -C., 处理元数据时会加上**中文字幕**标签 - -## 异常处理（重要） - -### 请确保软件是完整地！确保ini文件内容是和下载提供ini文件内容的一致的！ ---- -### 关于软件打开就闪退 -可以打开cmd命令提示符，把 ```AV_Data_capture.py/.exe```拖进cmd窗口回车运行，查看错误，出现的错误信息**依据以下条目解决** - ---- -### 关于 ```Updata_check``` 和 ```JSON``` 相关的错误 -跳转 [网络设置](#网络设置) - ---- -### 关于字幕文件移动功能 -字幕文件前缀必须与影片文件前缀一致，才可以使用该功能 - ---- -### 关于```FileNotFoundError: [WinError 3] 系统找不到指定的路径。: 'JAV_output''``` -在软件所在文件夹下新建 JAV_output 文件夹，可能是你没有把软件拉到和电影的同一目录 - ---- -### 关于连接拒绝的错误 -请设置好[代理](#针对某些地区的代理设置) - ---- -### 关于Nonetype,xpath报错 -同上 - ---- -### 关于番号提取失败或者异常 -**可以提取元数据的网站:avsox, javbus, javdb, dmm(fanza), fc2, jav321, mgstage(素人)** - -目前作者已经完善了番号提取机制，功能较为强大，各大网站的影片请用以下规则命名（dmm(fanza)下载的影片除外） -``` -COSQ-004.mp4 -``` -对于dmm(fanza)上下好的电影，请使用影片cid命名，示例如下 -``` -kawd00969.mp4 -``` - -条件：文件名中间要有下划线或者减号"_","-"，没有多余的内容只有番号为最佳，可以让软件更好获取元数据 -对于多影片重命名，可以用 [ReNamer](http://www.den4b.com/products/renamer) 来批量重命名 +# 版本发布 +* [Release](https://github.com/yoshiko2/AV_Data_Capture/releases) ---- -### 关于PIL/image.py -暂时无解，可能是网络问题或者pillow模块打包问题，你可以用源码运行（要安装好第一步的模块） - -### 拖动法 -针对格式比较奇葩的番号 -影片放在和程序同一目录下，拖动至```AV_Data_Capture.exe```，即可完成刮削和整理 - - -### 软件会自动把元数据获取成功的电影移动到 JAV_output 文件夹中，根据演员分类，失败的电影移动到failed文件夹中。 - -### 把JAV_output文件夹导入到 Emby, Kodi中，等待元数据刷新，完成 - -### 关于群晖NAS -开启 SMB，并在 Windows 上挂载为网络磁盘即可使用本软件，也适用于其他 NAS - -## 写在后面 -怎么样，看着自己的日本电影被这样完美地管理，是不是感觉成就感爆棚呢? - -**tg官方电报群:[ 点击进群](https://t.me/joinchat/J54y1g3-a7nxJ_-WS4-KFQ)** +# Telegram讨论群 +* [点击进群](https://t.me/joinchat/J54y1g3-a7nxJ_-WS4-KFQ)