Skip to content

Commit

Permalink
Update docs for 1.7.2
Browse files Browse the repository at this point in the history
  • Loading branch information
jvlflame committed Jul 12, 2020
1 parent 080c3e5 commit 9d782b3
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 12 deletions.
28 changes: 28 additions & 0 deletions .github/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.7.2]
### Added
- Settings file validation for:
- True/False values
- Integer values
- Multi-sort throttle value

### Changed
- `-SetJavlibraryOwned` now accepts a Path as well as a text list of movie IDs
- If a path is detected, it will use Javinizer's default movie matching scheme to match IDs (regex-match supported as well)
- e.g. `Javinizer -SetJavlibraryOwned "C:\JAV\Sorted" -Recurse`
- If a file is detected, it will use the text list of movie IDs
- e.g. `Javinizer -SetJavlibraryOwned "C:\JAV\movies.txt"`
- Timeout for setting owned movies on JAVLibrary is now user-defined (in seconds)
- Setting `request-timeout-sec`
- Regex match sorting now allows user-defined match values (use `$DebugPreference = 'Continue'` if troubleshooting your matches)
- Setting `regex-id-match` and `regex-pt-match`
- `-Multi` sort now uses PowerShell native `Start-ThreadJob` cmdlet as opposed to PoshRSJob
- Progress bar when using parameter `-Multi` now includes current in-progress threads

### Fixed
- Movies failing to be sorted into separate folders when using `-Multi` with default settings
- Javinizer failing when regex match fails on an item and returns a null value
- Javinizer not ignoring movies that don't match the regex string when `regex-match=True`

### Removed
- PoshRSJob dependency removed

## [1.7.1]
### Added
- Parameter `-SetJavlibraryOwned` to add a list of movies as owned on JAVLibrary
Expand Down
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Javinizer (JAV Organizer)
[![Build Status](https://dev.azure.com/jli141928/Javinizer/_apis/build/status/jvlflame.Javinizer?branchName=master)](https://dev.azure.com/jli141928/Javinizer/_build/latest?definitionId=2&branchName=master)
[![GitHub release](https://img.shields.io/github/v/release/jvlflame/Javinizer?include_prereleases&style=flat&label=Release)](https://github.com/jvlflame/Javinizer/releases)
[![Last commit](https://img.shields.io/github/last-commit/jvlflame/Javinizer?style=flat&color=blue&label=Last%20Commit)](https://github.com/jvlflame/Javinizer/commits/dev)
[![PSGallery Downloads](https://img.shields.io/powershellgallery/dt/javinizer?color=red&label=PSGallery%20Downloads&style=flat)](https://www.powershellgallery.com/packages/Javinizer/)
[![GitHub Downloads](https://img.shields.io/github/downloads/jvlflame/javinizer/total?color=red&label=GitHub%20Downloads&style=flat)](https://github.com/jvlflame/Javinizer/releases)
[![Discord](https://img.shields.io/discord/608449512352120834?color=yellow&style=flat&label=Discord)](https://discord.gg/K2Yjevk)
[![GitHub release](https://img.shields.io/github/v/release/jvlflame/Javinizer?include_prereleases&style=flat&label=release)](https://github.com/jvlflame/Javinizer/releases)
[![Last commit](https://img.shields.io/github/commits-since/jvlflame/Javinizer/latest/staging?style=flat&color=blue)](https://github.com/jvlflame/Javinizer/commits/staging)
[![PSGallery Downloads](https://img.shields.io/powershellgallery/dt/javinizer?color=red&label=psgallery%20downloads&style=flat)](https://www.powershellgallery.com/packages/Javinizer/)
[![GitHub Downloads](https://img.shields.io/github/downloads/jvlflame/javinizer/total?color=red&label=github%20downloads&style=flat)](https://github.com/jvlflame/Javinizer/releases)
[![Discord](https://img.shields.io/discord/608449512352120834?color=brightgreen&style=flat&label=discord%20chat)](https://discord.gg/K2Yjevk)

A command-line based tool to scrape and sort your local Japanese Adult Video (JAV) files.

Expand All @@ -23,16 +23,12 @@ A rebuild of my previous project [JAV-Sort-Scrape-javlibrary](https://github.com
### Install module dependencies

- [PowerShell 6 or PowerShell 7](https://github.com/PowerShell/PowerShell) - Windows PowerShell 5 is **NOT** supported
- [PoshRSJob](https://github.com/proxb/PoshRSJob)
- [Python 3+ (64-bit)](https://www.python.org/downloads/) - Linux calls `python3`
- [Cloudscraper](https://pypi.org/project/cloudscraper/)
- [Pillow](https://pypi.org/project/Pillow/)
- [Googletrans](https://pypi.org/project/googletrans/)

```powershell
# pwsh
PS> Install-Module PoshRSJob
# python (Windows)
> pip install cloudscraper
> pip install pillow
Expand Down Expand Up @@ -418,6 +414,8 @@ minimum-filesze-to-sort | Integer value (0+) | Sets the minimum filesize video f
included-file-extensions | String value | Sets the file extension types for Javinizer to read from your sort directory in comma separated format (no spaces)
excluded-file-strings | String value | Sets the paths/string values with wildcards (*) for Javinizer to ignore from your sort directory in comma separated format (no spaces)
regex-match | True/False | Sets Javinizer to match your JAV files using a regular expression instead of the default matcher; The JAV ID in the filename must match website metadata exactly to successfully match
regex-id-match | Integer value (0+) | Sets the regex match value of the movie Id in the filename
regex-pt-match | Integer value (0+) | Sets the regex match value of the movie part number in the filename
regex | String value | The regular expression string to match files if `regex-match=True`; Match 1 should be the movie ID (e.g. ABP-234), Match 2 (optional) should be the part number of the movie (e.g. 2)
create-nfo | True/False | Creates a .nfo metadata file for the sorted movie that follows the nfo-file-string naming format
create-nfo-per-file | True/False | Creates a .nfo metadata for each sorted movie that mirrors the name of the movie (Required for Emby/Jellyfin)
Expand All @@ -441,6 +439,7 @@ server-api-key | String value | The API key for your Emby/Jellyfin server instan
set-owned | True/False | Sets sorted movies as "Owned" on JAVLibrary, requires a JAVLibrary account
username | String value | Your JAVLibrary username
session-cookie | String value | After logging in, view the cookies under the `www.javlibrary.com/cookies/session` directory and copy the cookie content
request-timeout-sec | Integer value (0+) | Sets the timeout value in seconds on how long Javinizer will continue polling Javinizer to set the owned status (polls every 3 seconds)
log-path | String value (Path) | Sets the path to your log file; If left blank, it will default to a location within your module folder
check-updates | True/False | Checks for updates to the Javinizer module upon your first console session runtime
verbose-shell-output | True/False | Displays verbose output to your shell
Expand Down
8 changes: 5 additions & 3 deletions src/Javinizer/settings.ini
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[Main]
scrape-r18=True
scrape-r18=False
scrape-r18zh=False
scrape-dmm=True
scrape-dmm=False
scrape-javlibrary=True
scrape-javlibraryja=False
scrape-javlibraryzh=False
Expand All @@ -15,7 +15,7 @@ scrape-actress-ja=True

[General]
# Maximum number of threads to sort with if parameter '-Multi' is applied (range 1-15)
multi-sort-throttle-limit=10
multi-sort-throttle-limit=5
move-to-folder=True
rename-file=True
# Available tags for file/folder rename string
Expand Down Expand Up @@ -44,7 +44,9 @@ excluded-file-strings=*-trailer.*,*-5.*
# Allows you to use a regex string to match files if the default Javinizer matcher doesn't work
# (e.g. In regex ([a-zA-Z|tT28]+-\d+z{0,1}Z{0,1}e{0,1}E{0,1})(?:-pt){0,1}(\d{1,2})? , "[ABP-123] Title text-pt3.mp4", match 1 is "ABP-123, match 2 is "3")
regex-match=False
# The match value of your movie ID (e.g. "ID-112")
regex-id-match=1
# The match value of your movie part number (e.g. "2")
regex-pt-match=2
regex=([a-zA-Z|tT28]+-\d+z{0,1}Z{0,1}e{0,1}E{0,1})(?:-pt){0,1}(\d{1,2})?

Expand Down

0 comments on commit 9d782b3

Please sign in to comment.