Update GitBook Documentation

javinizer · May 9, 2023 · 0c5f8fe · 0c5f8fe
1 parent 31e5ac7
commit 0c5f8fe
Show file tree

Hide file tree

Showing 42 changed files with 1,622 additions and 285 deletions.
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@
   <a href="#features"><strong>Features</strong></a> •
   <a href="#getting-started"><strong>Getting Started</strong></a> •
   <a href="#example-output"><strong>Examples</strong></a> •
-  <a href="https://docs.jvlflame.net/" target="_blank"><strong>Documentation</strong></a>
+  <a href="https://javinizer.gitbook.io/docs" target="_blank"><strong>Documentation</strong></a>
 
 </p>
 

diff --git a/docs/.gitbook/assets/dashboard_notrunning.png b/docs/.gitbook/assets/dashboard_notrunning.png
diff --git a/docs/.gitbook/assets/dashboard_sort.png b/docs/.gitbook/assets/dashboard_sort.png
diff --git a/docs/.gitbook/assets/demo.gif b/docs/.gitbook/assets/demo.gif
diff --git a/docs/.gitbook/assets/docker_desktop.png b/docs/.gitbook/assets/docker_desktop.png
diff --git a/docs/.gitbook/assets/docker_run.png b/docs/.gitbook/assets/docker_run.png
diff --git a/docs/.gitbook/assets/javlibrary_cookie.png b/docs/.gitbook/assets/javlibrary_cookie.png
diff --git a/docs/.gitbook/assets/javlibrary_login.png b/docs/.gitbook/assets/javlibrary_login.png
diff --git a/docs/.gitbook/assets/network_ls.png b/docs/.gitbook/assets/network_ls.png
diff --git a/docs/.gitbook/assets/network_path.png b/docs/.gitbook/assets/network_path.png
diff --git a/docs/.gitbook/assets/powershell_env.png b/docs/.gitbook/assets/powershell_env.png
diff --git a/docs/.gitbook/assets/regex_match.png b/docs/.gitbook/assets/regex_match.png
diff --git a/docs/.gitbook/assets/unraid_example.png b/docs/.gitbook/assets/unraid_example.png
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,20 @@
+# Javinizer
+
+What is Javinizer?
+
+Javinizer is a tool built originally as a PowerShell module to organize a local JAV media library. It scans your filesystem for JAV movie files and organizes them according to your defined settings.
+
+Javinizer currently supports the following scraper sources:
+
+* Javlibrary
+* R18.dev
+* Dmm
+* Javbus
+* Jav321
+* AVEntertainment
+* MGStage
+* DLGetchu
+
+Javinizer currently lives on [GitHub](https://github.com/javinizer/Javinizer).
+
+<figure><img src=".gitbook/assets/demo.gif" alt=""><figcaption></figcaption></figure>
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,38 @@
+# Table of contents
+
+* [Javinizer](README.md)
+
+## Installation
+
+* [Install Javinizer (CLI)](installation/install-javinizer-cli.md)
+* [Install Javinizer (Web GUI)](installation/install-javinizer-web-gui.md)
+* [Updating Javinizer](installation/updating-javinizer.md)
+
+## Using Javinizer
+
+* [Using the CLI](using-javinizer/using-the-cli/README.md)
+  * [Sorting Files](using-javinizer/using-the-cli/sorting-files.md)
+  * [Searching for Metadata](using-javinizer/using-the-cli/searching-for-metadata.md)
+  * [Updating Settings via the Cmdline](using-javinizer/using-the-cli/updating-settings-via-the-cmdline.md)
+  * [Setting owned movies on Javlibrary](using-javinizer/using-the-cli/setting-owned-movies-on-javlibrary.md)
+* [Using the GUI](using-javinizer/using-the-gui.md)
+* [File Matching](using-javinizer/file-matching/README.md)
+  * [Regex Match](using-javinizer/file-matching/regex-match.md)
+  * [Multi-part Match](using-javinizer/file-matching/multi-part-match.md)
+* [Media Library Setup](using-javinizer/media-library-setup.md)
+
+## Configuration
+
+* [Settings](configuration/settings/README.md)
+  * [Actor Thumbnail CSV](configuration/settings/actor-thumbnail-csv.md)
+  * [Genre/Tag CSV](configuration/settings/genre-tag-csv.md)
+  * [R18 Uncensor CSV](configuration/settings/r18-uncensor-csv.md)
+* [Dynamic Folder Structures](configuration/dynamic-folder-structures.md)
+* [Format Strings](configuration/format-strings.md)
+* [Metadata Priorities](configuration/metadata-priorities.md)
+* [Metadata Translation](configuration/metadata-translation.md)
+* [Proxy Configuration](configuration/proxy-configuration.md)
+
+## Troubleshooting
+
+* [Frequently Asked Questions](troubleshooting/frequently-asked-questions.md)
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/configuration/dynamic-folder-structures.md b/docs/configuration/dynamic-folder-structures.md
@@ -0,0 +1,75 @@
+# Dynamic Folder Structures
+
+Javinizer supports dynamic folder structures for your sorted files using the setting `sort.format.outputfolder`. The setting will "concatenate" each entered [format string](format-strings.md) as a nested folder. If the `<METADATA>` metadata in the format string is null, it will be replaced as `Unknown`.
+
+If you leave the setting blank, the movie folder will be created in the root destination output path: `"sort.format.outputfolder": []`.
+
+## Example
+
+### Settings values
+
+```
+"sort.format.outputfolder": ["<YEAR>", "<STUDIO>"]
+"sort.format.folder": "<ID> - <TITLE> (<YEAR>)"
+"sort.format.file": "<ID>"
+```
+
+### Metadata Search
+
+Normally, you would need to run a Javinizer sort using `-Path`, but we are using `-Find` in this example to show the metadata output.
+
+```
+Javinizer -Find abw-003 -Javlibrary -R18 -DmmJa -Aggregated
+```
+
+```
+Id             : ABW-003
+ContentId      : 118abw00003
+DisplayName    : [ABW-003] Kana Kawaguchi Will Serve You As An Ultra Newest Beauty Salon Addict 49 She Will Provide
+                 Exquisite Refreshment For Her Customers Pent-Up Desires And Relieve Their Hardened Cocks!!
+Title          : Kana Kawaguchi Will Serve You As An Ultra Newest Beauty Salon Addict 49 She Will Provide Exquisite
+                 Refreshment For Her Customer's Pent-Up Desires And Relieve Their Hardened Cocks!!
+AlternateTitle : 川口夏奈がご奉仕しちゃう超最新やみつきエステ 49 お客様の欲望で凝り固まったアソコを極上リフレッシュ！！
+Description    : プレステージ専属女優『川口 夏奈』の超最新やみつきエステが味わえる‘エステdeなつな’がオープン！エステテ
+                 ィシャン・夏奈が刺激的なコスチュームでお出迎えし、全力ご奉仕♪ふわふわFカップで優しく包み込むような洗体
+                 プレイが味わえる「全身密着リフレッシュコース」！乳首をグリグリ弄りながらフェラ＆パイズリで最高の射精へ
+                 と導く「ディープコース」！いやらしい腰使いでマ〇コを擦り付け、理性崩壊でまさかの本番行為に発展！？「素
+                 股体感コース」！ぬるぬるローションでチ〇コをしごきながらのアナル舐めで昇天「集中癒しコース」！オイルま
+                 みれの身体をお客様から逆マッサージを施され、つい欲情してしまう「オイルマッサージコース」！誰もがやみつ
+                 きになる5つのコースで至福のひと時をご提供します！！
+Rating         : @{Rating=9; Votes=3}
+ReleaseDate    : 2020-08-28
+Runtime        : 149
+Director       : Charlie Tanaka
+Maker          : Prestige
+Label          : ABSOLUTELY WONDERFUL
+Series         : Newest Beauty Salon Addict
+Tag            : {Newest Beauty Salon Addict}
+Tagline        :
+Credits        :
+Actress        : {@{LastName=Kawaguchi; FirstName=Natsuna; JapaneseName=川口夏奈;
+                 ThumbUrl=https://pics.r18.com/mono/actjpgs/kawaguti_natuna.jpg}}
+Genre          : {Big Tits, Cosplay, Massage Parlor, Titty Fuck}
+CoverUrl       : https://pics.r18.com/digital/video/118abw00003/118abw00003pl.jpg
+ScreenshotUrl  : {https://pics.r18.com/digital/video/118abw00003/118abw00003jp-1.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-2.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-3.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-4.jpg…}
+TrailerUrl     : https://awscc3001.r18.com/litevideo/freepv/1/118/118abw003/118abw003_dmb_w.mp4
+MediaInfo      :
+```
+
+### Example Output
+
+With the above settings, you should receive this folder structure for your sorted file.
+
+```
+C:.
+\---2020
+    \---Prestige
+        \---ABW-003 - Kana Kawaguchi Will Serve You As An Ultra Newest Beauty Salon Addict 49 She Will Provide... (2020)
+            |   ABW-003.mp4
+            |   ABW-003.nfo
+            |   fanart.jpg
+            |   folder.jpg
+```
diff --git a/docs/configuration/format-strings.md b/docs/configuration/format-strings.md
@@ -0,0 +1,92 @@
+# Format Strings
+
+Javinizer allows you options to use tags for file naming using scraped metadata. The available tags are as follows, conforming with the naming schema available from the JAVMovieScraper application:
+
+* \<ID>
+* \<CONTENTID>
+* \<DIRECTOR>
+* \<TITLE>
+* \<RELEASEDATE>
+* \<YEAR>
+* \<STUDIO>
+* \<RUNTIME>
+* \<SET>
+* \<LABEL>
+* \<ACTORS>
+* \<ORIGINALTITLE>
+* \<FILENAME>
+* \<RESOLUTION>&#x20;
+  * &#x20;Resolution requires `sort.metadata.nfo.mediainfo` as true
+
+## Example
+
+### Metadata Output
+
+```
+C:/> Javinizer -Find abp-420 -Javlibrary -R18 -DmmJa -Aggregated
+
+Id               : ABP-420
+ContentId        : 118abp00420
+DisplayName      : [ABP-420] Endless Sex Starring Rino Kirishima
+Title            : Endless Sex Starring Rino Kirishima
+AlternateTitle   : エンドレスセックス 桐嶋りの
+Description      : プレステージ専属女優『桐嶋 りの』が、45人の男優とノンストップセックスを展開！抜群の包容力とテクニッ
+                   クで多数の肉棒を相手に奮闘する！次々にぶち込まれ、トロケルように色っぽい表情で感じ続ける！激しいピス
+                   トンに眉間に皺を寄せながら悶絶イキ！「快楽の誘い人」として集められた屈強な男優10名にマワされ、執拗な
+                   までに続く挿入の快感にアクメ絶頂！！顔射され顔面をドロドロに汚されながら大口を開けて精子をネダる姿は
+                   堪りません！！
+Rating           :
+ReleaseDate      : 2016-01-08
+Runtime          : 136
+Director         : Manhattan Kimura
+Maker            : Prestige
+Label            : ABSOLUTELY PERFECT
+Series           : Endless Sex
+Tag              : {Endless Sex}
+Tagline          :
+Credits          :
+Actress          : {@{LastName=Kirishima; FirstName=Rino; JapaneseName=桐嶋りの;
+                   ThumbUrl=https://pics.r18.com/mono/actjpgs/kirisima_rino.jpg}}
+Genre            : {Cosplay, Solowork, Facial, Squirting…}
+CoverUrl         : https://pics.r18.com/digital/video/118abp00420/118abp00420pl.jpg
+ScreenshotUrl    : {https://pics.r18.com/digital/video/118abp00420/118abp00420jp-1.jpg,
+                   https://pics.r18.com/digital/video/118abp00420/118abp00420jp-2.jpg,
+                   https://pics.r18.com/digital/video/118abp00420/118abp00420jp-3.jpg,
+                   https://pics.r18.com/digital/video/118abp00420/118abp00420jp-4.jpg…}
+TrailerUrl       : https://awscc3001.r18.com/litevideo/freepv/1/118/118abp420/118abp420_dmb_w.mp4
+OriginalFileName : ABP-420.1080p.mp4
+MediaInfo        :
+```
+
+### Metadata Assignment
+
+In this example for movie ABP-420, the tags would be defined as:
+
+| Tag              | Value                               |
+| ---------------- | ----------------------------------- |
+| \<ID>            | ABP-420                             |
+| \<CONTENTID>     | 118abp00420                         |
+| \<DIRECTOR>      | Manhattan Kimura                    |
+| \<TITLE>         | Endless Sex Starring Rino Kirishima |
+| \<RELEASEDATE>   | 2016-01-08                          |
+| \<YEAR>          | 2016                                |
+| \<STUDIO>        | Prestige                            |
+| \<RUNTIME>       | 136                                 |
+| \<SET>           | Endless Sex                         |
+| \<LABEL>         | ABSOLUTELY PERFECT                  |
+| \<ACTORS>        | Kirishima Rino                      |
+| \<ORIGINALTITLE> | エンドレスセックス 桐嶋りの                      |
+| \<FILENAME>      | ABP-420.1080p                       |
+| \<RESOLUTION>    |                                     |
+
+### Format Strings
+
+Here are some examples of how you can build your desired format string.
+
+| Format String                       | Value                                                |
+| ----------------------------------- | ---------------------------------------------------- |
+| \<ID> - \<TITLE> (\<YEAR>)          | ABP 420 - Endless Sex Starring Rino Kirishima (2016) |
+| \[\<STUDIO>] \[\<YEAR>] \<ID>       | \[Prestige] \[2016] ABP-420                          |
+| \<ID> (\<RUNTIME>min)               | ABP-420 (136min)                                     |
+| \<ID> (\<ACTORS>) \[\<RELEASEDATE>] | ABP-420 (Kirishima Rino) \[2016-01-08]               |
+| \[\<STUDIO>] \[\<LABEL>] - \<ID>    | \[Prestige] \[ABSOLUTELY PERFECT] - ABP-420          |
diff --git a/docs/configuration/metadata-priorities.md b/docs/configuration/metadata-priorities.md
@@ -0,0 +1,52 @@
+# Metadata Priorities
+
+Javinizer assigns metadata to fields in order by the sources listed in`sort.metadata.priority.(field)`  as long as the scraper is enabled by the setting `scraper.movie.(source)`. Metadata will never be combined using data from multiple sources, but rather assigned only to the first priority source that has non-null data.
+
+| Setting                               |
+| ------------------------------------- |
+| sort.metadata.priority.actress        |
+| sort.metadata.priority.alternatetitle |
+| sort.metadata.priority.coverurl       |
+| sort.metadata.priority.description    |
+| sort.metadata.priority.director       |
+| sort.metadata.priority.genre          |
+| sort.metadata.priority.id             |
+| sort.metadata.priority.label          |
+| sort.metadata.priority.maker          |
+| sort.metadata.priority.rating         |
+| sort.metadata.priority.releasedate    |
+| sort.metadata.priority.runtime        |
+| sort.metadata.priority.series         |
+| sort.metadata.priority.screenshoturl  |
+| sort.metadata.priority.title          |
+| sort.metadata.priority.trailerurl     |
+
+## Example
+
+For example, if your actress priority looks like this: `"sort.metadata.priority.actress": ["r18dev", "javlibrary", "javbus"]`
+
+* If actresses are found from the R18.dev scraper --> R18.dev actresses will be assigned to the metadata field
+* If actresses are not found on the R18.dev scraper but are found on the Javlibrary scraper --> Javlibrary actresses will be assigned to the metadata field
+* If actresses are not found on the R18.dev and Javlibrary scrapers but are found on the JavBus scraper --> JavBus actresses will be assigned to the metadata field
+* If actresses are not found on any of the scrapers, it will be returned as null
+
+## Scraper sources:
+
+These are the exact scraper names that you need to enter into the priority setting array:
+
+* dmm
+* dmmja
+* jav321ja
+* javbus
+* javbusja
+* javbuszh
+* javdb
+* javdbzh
+* javlibrary
+* javlibraryja
+* javlibraryzh
+* mgstageja
+* r18dev
+* tokyohot
+* tokyohotja
+* tokoyhotzh
diff --git a/docs/configuration/metadata-translation.md b/docs/configuration/metadata-translation.md
@@ -0,0 +1,67 @@
+# Metadata Translation
+
+Javinizer utilizes either the `googletrans` or `google_trans_new` python modules to perform translations on metadata scraped from your desired sources. The translation modules will automatically detect the source language and perform the translation as applicable.
+
+For usage, you will need to utilize the following settings:
+
+| Setting                              | Value                                                                                                                                                                                    |
+| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| sort.metadata.nfo.translate          | true or false                                                                                                                                                                            |
+| sort.metadata.nfo.translate.module   | googletrans or google\_trans\_new                                                                                                                                                        |
+| sort.metadata.nfo.translate.language | Enter a language code from [here](https://developers.google.com/admin-sdk/directory/v1/languages).                                                                                       |
+| sort.metadata.nfo.translate.field    | <p>An array of accepted metadata fields.</p><ul><li>Title</li><li>AlternateTitle</li><li>Description</li><li>Director</li><li>Series</li><li>Genre</li><li>Maker</li><li>Label</li></ul> |
+
+The source language of the field does not matter, meaning that you are even able to translate English metadata fields to a language of your choice.
+
+## Example
+
+For this example, we will be translating the description, title, and genre metadata fields to Korean.
+
+### Settings Values
+
+```
+    "sort.metadata.nfo.translate": true,
+    "sort.metadata.nfo.translate.module": "googletrans",
+    "sort.metadata.nfo.translate.field": ["description", "title", "genre"],
+    "sort.metadata.nfo.translate.language": "ko",
+```
+
+### Metadata Search
+
+```
+Javinizer -Find abw-003 -Javlibrary -R18 -DmmJa -Aggregated
+
+Id             : ABW-003
+ContentId      : 118abw00003
+DisplayName    : [ABW-003] Kana Kawaguchi가 최신 뷰티 살롱 중독자로 당신을 섬길 것입니다 49 그녀는 그녀의 고객의
+                 욕망에 절묘한 상쾌함을 제공하고 그들의 굳은 자지를 풀어줍니다!
+Title          : Kana Kawaguchi가 최신 뷰티 살롱 중독자로 당신을 섬길 것입니다 49 그녀는 그녀의 고객의 욕망에 절묘한
+                 상쾌함을 제공하고 그들의 굳은 자지를 풀어줍니다!
+AlternateTitle : 川口夏奈がご奉仕しちゃう超最新やみつきエステ 49 お客様の欲望で凝り固まったアソコを極上リフレッシュ！！
+Description    : 프레스티지전속여배우"가와구치夏奈"매우최신중독성에스테틱을 맛볼 수있는'에스테틱de나츠
+                 나'가오픈!미용사여름나나가자극적 인의상으로마중최선봉사♪털이F 컵으로 부드럽게감싸는씻음
+                 체플레이를맛볼 수있는 「전신밀착리프레쉬코스」!젖꼭지를둥글 둥글만지작하면서페라&파이즈
+                 리에서최고의사정으로 이끄는'딥코스」!불쾌한허리값어치마〇코를칠해이성붕괴설마실전 행위로 발전!?"가랑이
+                 체험코스」!칙칙한로션치〇코를훑어보면서애무승천"집중치료코스」!기름투성이의몸을고객반대로마사지를베풀
+                 어 져붙어욕정해 버리는"오일 마사지코스」!모두가중독이되는5개의코스에서행복한시간을제공합니다!!
+Rating         : @{Rating=9; Votes=3}
+ReleaseDate    : 2020-08-28
+Runtime        : 149
+Director       : Charlie Tanaka
+Maker          : Prestige
+Label          : ABSOLUTELY WONDERFUL
+Series         : Newest Beauty Salon Addict
+Tag            : {Newest Beauty Salon Addict}
+Tagline        :
+Credits        :
+Actress        : {@{LastName=Kawaguchi; FirstName=Natsuna; JapaneseName=川口夏奈;
+                 ThumbUrl=https://pics.r18.com/mono/actjpgs/kawaguti_natuna.jpg}}
+Genre          : {큰 가슴, 코스프레, 마사지 응접실, 가슴 씨발}
+CoverUrl       : https://pics.r18.com/digital/video/118abw00003/118abw00003pl.jpg
+ScreenshotUrl  : {https://pics.r18.com/digital/video/118abw00003/118abw00003jp-1.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-2.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-3.jpg,
+                 https://pics.r18.com/digital/video/118abw00003/118abw00003jp-4.jpg…}
+TrailerUrl     : https://awscc3001.r18.com/litevideo/freepv/1/118/118abw003/118abw003_dmb_w.mp4
+MediaInfo      :
+```
diff --git a/docs/configuration/proxy-configuration.md b/docs/configuration/proxy-configuration.md
@@ -0,0 +1,18 @@
+---
+description: Use a custom proxy on your network requests within Javinizer
+---
+
+# Proxy Configuration
+
+{% hint style="warning" %}
+NOTE: This is an experimental feature. Though it has been added, it has largely been untested with various proxy configurations. If you find that it is not working, please create a new issue or message me on the Javinizer discord.
+{% endhint %}
+
+If you want to use a proxy with Javinizer, a few configurations are provided.
+
+1. Open your settings file `Javinizer -OpenSettings` or via the JSON editor on the web gui.
+2. Set proxy configurations
+   1. `proxy.enabled` - true or false
+   2. `proxy.host` - the hostname / IP of your proxy
+   3. `proxy.username` - the username for your proxy (if required)
+   4. `proxy.password` - the password for your proxy (if required)