Skip to content

MooncellWiki/torappu

Repository files navigation

Torappu

An unpacker for anime game assets with a focus on resource extraction and analysis.

Features

  • Asset extraction and processing
  • FlatBuffer schema parsing
  • Resource manifest handling
  • CLI interface for direct usage
  • Docker support for containerized execution
  • Versioned resource tracking

Requirements

  • Python 3.12+
  • Dependencies as specified in pyproject.toml

Installation

# Using uv (recommended)
uv sync

# Or using pip
pip install -e .

Configuration

Environment variables can be set using .env file or system environment variables.

TOKEN=your_token_here
ENDPOINT=your_backend_endpoint_here

Usage

Command Line

# Basic usage
python -m torappu [CLIENT_VERSION] [RES_VERSION]

# With previous version comparison
python -m torappu [CLIENT_VERSION] [RES_VERSION] -c [PREV_CLIENT_VERSION] -r [PREV_RES_VERSION]

# Include or exclude specific tasks
python -m torappu [CLIENT_VERSION] [RES_VERSION] -i task1,task2
python -m torappu [CLIENT_VERSION] [RES_VERSION] -e task1,task2

Docker Usage

# Build the image
docker build -t torappu .

# Basic extraction
docker run torappu [CLIENT_VERSION] [RES_VERSION]

# With previous version comparison
docker run torappu [CLIENT_VERSION] [RES_VERSION] -c [PREV_CLIENT_VERSION] -r [PREV_RES_VERSION]

# Include specific tasks
docker run torappu [CLIENT_VERSION] [RES_VERSION] -i CharArts,MapPreview

# With environment variables
docker run -e TOKEN=your_token -v $(pwd)/storage:/app/storage torappu [CLIENT_VERSION] [RES_VERSION]

Project Structure

  • torappu/: Main package
    • core/: Core functionality
  • OpenArknightsFBS/: FlatBuffer schema definitions
  • assets/: Asset resources
  • bin/: Binary tools (includes flatc for FlatBuffer compilation)
  • scripts/: Utility scripts
  • storage/: Storage for extracted assets

Development

This project uses uv for dependency management and ruff for linting:

# Install all dependencies
uv sync

# Run linting
uv run ruff check .
uv run ruff format .

License

MIT

About

An unpacker for anime game assets with a focus on resource extraction and analysis

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •