Code Monkey home page Code Monkey logo

yukatool's Introduction

What is this?

"Yuka System" is a visual novel engine used by a few companies such as HookSoft, Smee, PeasSoft and feng.
Unfortunately little to no information about the engine (and therefore no documentation) is publicly available, so I took a few weeks to carefully analyze the game archives.
Why? Because we (Rabu Rabu Translations) are currently working on a fan-tl of the game "Lover Able" by Smee: http://raburabu.net/projects/lover-able/progress/
I've attached my notes on the file formats and some general information I've gathered in the doc/ folder.

What does it do?

Yukatool aims to be the all in one solution for everything neccessary to properly work with the engine.
This includes features to deal with the three main components: archives, graphics and scripts.
At this point, the following operations (tasks) are supported:

  • help Displays a list of available commands
  • unpack Unpacks a yuka archive (.ykc) to a directory tree
  • pack Packs a directory tree into a yuka archive (.ykc)
  • patch Copies all files from one archive to another
  • split Splits a binary yuka script (.yks) into it's main sectors (code, index, data) and generates a comprehensible breakdown of the former two.
  • decompile Decompiles a binary yuka script into a yuka source file (.ykd) and an optional string table (.csv). Works on entire directory trees
  • compile Compiles a yuka source file (.ykd) and an optional string table (.csv) into a binary yuka script (.yks). Works on entire directory trees
  • unwrap Converts a yuka graphics file (.ykg) to png and optional meta information (.meta)
  • wrap Converts a png file and optional meta information (.meta) to a yuka graphics file (.ykg)

The following tasks are planned for future versions:

  • disassemble Unpacks a yuka archive and automatically decompiles all scripts / unwraps all graphics
  • assemble Packs a directory tree into a yuka archive and automatically compiles all scripts / wraps all graphics

How do I use it?

Yukatool is completely command-line operated. The basic syntax is as follows:
yuka.exe [flags] <task> <arguments...>
Flags do not have to be at the beginning and can be specified in a long or short form:
-rvw adds the flags --raw, --verbose and --wait
Which flags are available depends on the task you want to execute.

If you need technical support, want to contribute or have any other questions regarding the project, feel free to contact me at [email protected] :)

yukatool's People

Contributors

atomcrafty avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

yukatool's Issues

'Illegal characters in path.' warning on unpack task with partial unpacking result.

Hi, IDK if you're still actively maintaining this project, but currently I'm stuck on this issue.

Currently messing around on one of PeasSoft games with a bit of botched TL, and trying to fix it on my own. Tried to unpack one of the problematic .ykc, but as you can guess from the title, it just partially unpacked.

I presumed that all files with Japanese characters are triggering this (on -verbose, the last file that is problematic to unpack was riddled with ?????), but changing my system locale to Japanese doesn't seem to fix this.

What should I do to unpack (and pack it all again) correctly on English ver. of Windows? Or should I cross the bridge anyway and try using Japanese Windows through VM?

Thanks in advance.

Edit: Removed some brain farts, need more coffee.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.