VienDesuPorting/VNTools
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update all README.md files

Browse source
This commit is contained in:
OleSTEEP 2024-10-13 22:28:14 +03:00
parent 0b43756ef5
commit d8e55bac9a
4 changed files with 37 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -2,10 +2,10 @@
Collection of tools used by VienDesu! Porting Team
### Tools
* `FFMpeg-Compressor` - Python utility to compress Visual Novel Resources
* `RenPy-Android-Unpack` - A Python script for extracting game project from Ren'Py based .apk and .obb files
* `RenPy-Unpacker` - Simple .rpy script that will make any RenPy game unpack itself
* `VNDS-to-RenPy` - Simple script for converting VNDS engine scripts to .rpy ones
* `vnrecode` - Python utility to compress Visual Novel Resources
* `unrenapk` - A Python script for extracting game project from Ren'Py based .apk and .obb files
* `renpy-ripper` - Simple .rpy script that will make any RenPy game unpack itself
* `vnds2renpy` - Simple script for converting VNDS engine scripts to .rpy ones
### Installation
#### Download from releases:

4
unrenapk/README.md
View file

@ -1,6 +1,6 @@
## RenPy-Android-Unpack
## unrenapk
A simple Python script for unpacking Ren'Py based .apk and .obb files to ready to use Ren'Py SDK's Project
### How to use
* Put some .apk & .obb files in folder
* `rendroid-unpack` (It unpacks all .apk and .obb files in the directory where it is located)
* `unrenapk` (It unpacks all .apk and .obb files in the directory where it is located)

4
vnds2renpy/README.md
View file

@ -1,7 +1,7 @@
## VNDS-to-RenPy
## vnds2renpy
Simple script for converting vnds scripts to rpy
### How to use
* Extract VNDS visual novel's archive and get `scripts` folder from these (or `script.zip` if scripts folder is empty)
* Launch `convert.py` (It will automatically extract `scripts.zip` archive (if it needed) and converts .scr scripts to .rpy)
* Launch `vnds2renpy` (It will automatically extract `scripts.zip` archive (if it needed) and converts .scr scripts to .rpy)

39
vnrecode/README.md
View file

@ -1,13 +1,7 @@
## FFMpeg-Compressor
Python utility uses ffmpeg to compress Visual Novel Resources
## vnrecode
Python utility uses Pillow and ffmpeg to compress Visual Novel Resources
### How to use
* Download `ffmpeg-comp.toml` and put in next to binary or in to `/etc` folder
* Change the configuration of the utility in `ffmpeg-comp.toml` for yourself
* `ffmpeg-comp {folder}`
* In result, you get `{folder-compressed}` near with original `{folder}`
### Configuration
### Configuration file
#### FFMPEG section
* CopyUnprocessed - Copy all files that failed to compress by ffmpeg to destination folder. In can help to recreate original folder, but with compressed files. (default: `true`)
* ForceCompress - Force try to compress all files in directory via ffmpeg. (default: `false`)
@ -32,9 +26,34 @@ Python utility uses ffmpeg to compress Visual Novel Resources
* Extension - Required image file extension. It supports: `.3gp`, `.amv`, `.avi`, `.gif`, `.m2l`, `.m4v`, `.mkv`, `.mov`, `.mp4`, `.m4v`, `.mpeg`, `.mpv`, `.webm`, `.ogv`
* Codec - (Maybe optional in future) Required video codec. (See official ffmpeg documentation for supported codecs)
### CLI Parameters
##### positional arguments:
* source - Directory with game files to recode
##### options:
* ` -h, --help ` - show this help message and exit
* ` -c CONFIG ` - Utility config file
* ` -nu ` - Don't copy unprocessed
* ` -f, --force ` - Try to recode unknown files
* ` -nm, --no-mimic ` - Disable mimic mode
* ` -v, --show_errors ` - Show recode errors
* ` --webp-rgb ` - Recode .webp without alpha channel
* ` -j JOBS, --jobs JOBS ` - Number of threads
* ` -ae A_EXT ` - Audio extension
* ` -ab A_BIT ` - Audio bit rate
* ` -id I_DOWN ` - Image resolution downscale multiplier
* ` -ie I_EXT ` - Image extension
* ` -ife I_FALLEXT ` - Image fallback extension
* ` -il ` - Image losing compression mode
* ` -iq I_QUALITY ` - Image quality
* ` --v_crf V_CRF ` - Video CRF number
* ` -vs ` - Skip video recoding
* ` -ve V_EXT ` - Video extension
* ` -vc V_CODEC ` - Video codec name
### TODO (for testing branch)
* [x] Recreate whole game directory with compressed files
* [x] Cross-platform (Easy Windows usage and binaries, macOS binaries)
* [x] Use ffmpeg python bindings instead of cli commands
* [x] Use ffmpeg python bindings instead of os.system
* [x] Multithread
* [ ] Reorganize code