katsuba

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 14 Open GitHub ↗

Tools for deserializing, extracting, and introspecting various KingsIsle file formats

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Katsuba

[![Discord](https://img.shields.io/discord/1469643277455065264)](https://discord.gg/Anagxv6NBX)
[![GitHub Release](https://img.shields.io/github/v/release/vbe0201/katsuba)](https://github.com/vbe0201/katsuba/releases/latest)
[![PyPI - Version](https://img.shields.io/pypi/v/katsuba)](https://pypi.org/project/katsuba)

Katsuba is a tool for deserializing, extracting and inspecting various file
formats used by KingsIsle in their games.

It supersedes [printrospector](https://gitlab.com/vale_/printrospector) and
extends its feature set.

## Supported formats

- **NAV:** NavigationGraph and ZoneNavigationGraph reading

- **BCD:** Binary Collision Data reading

- **POI:** Point of Interest data reading

- **WAD:** Archive introspection, validation, and extraction

- **ObjectProperty:** Deserialization of binary state

## Building the project

You will need an [installation of Rust](https://www.rust-lang.org/tools/install)
to build the project.

Then run the following commands to build and install katsuba to your machine:

```shell
# Clone the repository
$ git clone https://github.com/vbe0201/katsuba
$ cd katsuba

# Install the CLI tool (can be invoked with katsuba command)
$ cargo install --path src/katsuba

# OPTIONAL: Install the Python bindings.
# This assumes a recent installation of Python on the system.
$ cd src/katsuba-py
$ python -m pip install .
```

## Library usage

There are currently no plans to publish `katsuba` to crates.io, so for the
time being the preferred way to use it is:

```toml
# in Cargo.toml:

[dependencies]
katsuba = { git = "https://github.com/vbe0201/katsuba.git" }
```

## Using the CLI

For general help, see the output of the `--help` flag for `katsuba` and its
individual subcommands.

### ObjectProperty types

For the `katsuba op` subcommands to work properly, a type list must be provided.

These files are generated by an external project which requires an installation
of Python >= 3.10.

With an open Wizard101/Pirate101 game client, run:

```shell
# ONLY FOR WIZARD101:
$ pip install wiztype
# ONLY FOR PIRATE101:
$ pip install arrtype

# This requires that you are currently running the game client.

# Wizard101:
$ wiztype
# Pirate101:
$ arrtype
```

The resulting file can then be passed to the `-t` option.

## Licensing

The Katsuba crates, the CLI tool, and the Python bindings are collectively
licensed under the terms of the [ISC License](./LICENSE).

katsuba

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

katsuba

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README