https://github.com/forlos/vn_re
Documentation and scripts for working with visual novel engines.
https://github.com/forlos/vn_re
python3 reverse-engineering visual-novel visual-novels
Last synced: 6 months ago
JSON representation
Documentation and scripts for working with visual novel engines.
- Host: GitHub
- URL: https://github.com/forlos/vn_re
- Owner: Forlos
- License: mit
- Created: 2020-01-19T22:17:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T14:21:35.000Z (almost 3 years ago)
- Last Synced: 2025-04-04T12:21:56.773Z (6 months ago)
- Topics: python3, reverse-engineering, visual-novel, visual-novels
- Language: Python
- Homepage:
- Size: 704 KB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
README
#+title: VN_RE
#+author: Forlos
* Visual novel reverse engineering
Documentation and scripts for working with visual novel archives.
For single binary with GUI see: https://github.com/Forlos/akaibu
** Prerequisites
- Python3 with pip
** Installation
Move into directory with setup.py file in it and run:
#+BEGIN_SRC bash
pip install -e . --user
#+END_SRC
Now you should be able to use tools in bin/ directory
** Usage
#+BEGIN_SRC bash
python script_to_run.py
#+END_SRC
*** Example
#+BEGIN_SRC bash
python extract_resources.py archive1.dat archive2.dat
#+END_SRC
** Structure
- bin/ directory contains tools for end user such as extracting/packing archives
- docs/ direcotry contains documentation about archives
- ksy/ directory contains Kaitai struct description of file formats
- vn_re/ directory contains main logic for tools to work
Each format should have:
- Format description as an ORG file
- [[https://github.com/kaitai-io/kaitai_struct][Kaitai struct]] description of format
- Python scripts to extract/create archive(creating may not be available)