Skip to content

Commit

Permalink
Update README & docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Duosion committed Nov 15, 2024
1 parent a5eafad commit 46dcaa2
Show file tree
Hide file tree
Showing 6 changed files with 436 additions and 126 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ twintail currently supports the game's global and Japan servers.
You can download the most recent version from the [releases page](https://github.com/Duosion/twintail/releases/latest) or [build it](#building).

## Usage
Follow the [usage guide](/docs/usage/en.md)
- Follow the [usage guide](/docs/usage/en.md) for a general explanation of how to use twintail.
- Follow the [command reference](/docs/commands/en.md) for a list of commands with examples.

## Building
### Dependencies
Expand Down
110 changes: 110 additions & 0 deletions docs/commands/en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
**| :us: English | :jp: [日本語](./jp.md) |**
# twintail Command List
This guide may not contain usage details for every command.

To view all commands that twintail has, run twintail with the ``help`` flag.
```
twintail --help
```

## App Hash and App Version
The command examples shown below may include ``<app_version>`` and ``<app_hash>``.

These values should be replaced with real game versions and hashes.

For more information on acquiring these values, view the [usage guide](../usage/en.md#app-version-and-app-hash)

## ``fetch ab``
Downloads the game's assets.

### Examples
- Download all assets from the Japan server and save them in a folder called ``bundles``.
```
twintail fetch ab --version <app_version> --hash <app_hash> bundles
```
- Download only assets that contain ``scenario`` in their name from the global server.
```
twintail fetch ab --version <app_version> --hash <app_hash> --filter "scenario" --server global assets
```
- Download assets from the Japan server using an [assetbundle info file](#fetch-ab-info).
```
twintail fetch ab --version <app_version> --hash <app_hash> --info 4.0.5.10.json --no-update bundles
```
- Download only the differences between the latest asset version and an [assetbundle info file](#fetch-ab-info).
```
twintail fetch ab --version <app_version> --hash <app_hash> --info 4.0.5.10.json bundles
```

## ``fetch ab-info``
Saves a list of all of the game's assets as a ``json`` file for later use.

### Examples
- Downloads and saves a list of all of the games assets to ``asset_version.json`` where ``asset_version`` is the latest asset version.
```
fetch ab-info --version <app_version> --hash <app_hash>
```

## ``fetch suite``
Downloads suitemaster files.

### Examples
- Download the suitemaster files from the Japan server and save them in a folder called ``suite``.
```
twintail fetch suite --version <app_version> --hash <app_hash> suite
```
- Download encrypted suitemaster files from the Japan server and save them in a folder called ``suite_encrypted``.
```
twintail fetch suite --encrypt --version <app_version> --hash <app_hash> suite_encrypted
```

## ``encrypt ab``
Encrypts Unity assetbundle files for use with Project SEKAI.

### Examples
- Encrypt a single file in-place
```
twintail encrypt ab files/assetbundle0
```
- Encrypt an entire directory, and put the results into a new directory.
```
twintail encrypt ab ./decrypted_files ./encrypted_files
```

## ``encrypt suite``
Encrypts a suitemaster file.

### Examples
- Encrypt a single file in-place
```
twintail encrypt suite suite/cards.json
```
- Encrypt an entire directory, and put the results into a new directory.
```
twintail encrypt suite ./suite ./encrypted_suite
```

## ``decrypt ab``
Decrypts assetbundles in the game's format for use with other tools.

### Examples
- Decrypt a single file, and put the result into a new file.
```
twintail decrypt ab encrypted_files/assetbundle0 decrypted_files/assetbundle0
```
- Decrypt an entire directory in-place recursively.
```
twintail decrypt ab --recursive ./encrypted_files
```

## ``decrypt suite``
Decrypts suitemaster files.

### Examples
- Decrypt a single file, and put the result into a new directory.
```
twintail decrypt suite suite/00_0m12kmj3k21mvnmx12 decrypted_suite
```
- Decrypt an entire directory into a new directory.
```
twintail decrypt suite ./encrypted ./decrypted
```
110 changes: 110 additions & 0 deletions docs/commands/jp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
**| :us: [English](./en.md) | :jp: 日本語 |**
# twintail コマンド一覧
このガイドには、すべてのコマンドの使用方法の詳細が含まれていない場合があります。

twintailが持つすべてのコマンドを確認するには、``help``フラグを付けて実行してください。
```
twintail --help
```

## アプリハッシュとアプリバージョン
以下に示すコマンド例には、``<app_version>````<app_hash>``が含まれる場合があります。

これらの値は、実際のゲームのバージョンとハッシュに置き換える必要があります。

これらの値の取得方法の詳細については、[使用ガイド](../usage/jp.md#アプリバージョンとアプリハッシュ)をご覧ください。

## ``fetch ab``
ゲームのアセットをダウンロードします。

###
- 日本サーバーからすべてのアセットをダウンロードし、``bundles``というフォルダに保存します。
```
twintail fetch ab --version <app_version> --hash <app_hash> bundles
```
- グローバルサーバーから、名前に``scenario``を含むアセットのみをダウンロードします。
```
twintail fetch ab --version <app_version> --hash <app_hash> --filter "scenario" --server global assets
```
- [アセットバンドル情報ファイル](#fetch-ab-info)を使用して日本サーバーからアセットをダウンロードします。
```
twintail fetch ab --version <app_version> --hash <app_hash> --info 4.0.5.10.json --no-update bundles
```
- 最新のアセットバージョンと[アセットバンドル情報ファイル](#fetch-ab-info)の差分のみをダウンロードします。
```
twintail fetch ab --version <app_version> --hash <app_hash> --info 4.0.5.10.json bundles
```

## ``fetch ab-info``
ゲームの全アセットのリストを``json``ファイルとして保存します。

###
- ゲームの全アセットのリストをダウンロードし、``asset_version.json``として保存します(asset_versionは最新のアセットバージョン)。
```
fetch ab-info --version <app_version> --hash <app_hash>
```

## ``fetch suite``
Suitemasterファイルをダウンロードします。

###
- 日本サーバーからSuitemasterファイルをダウンロードし、``suite``というフォルダに保存します。
```
twintail fetch suite --version <app_version> --hash <app_hash> suite
```
- 日本サーバーから暗号化されたSuitemasterファイルをダウンロードし、``suite_encrypted``というフォルダに保存します。
```
twintail fetch suite --encrypt --version <app_version> --hash <app_hash> suite_encrypted
```

## ``encrypt ab``
Project SEKAIで使用するUnityアセットバンドルファイルを暗号化します。

###
- 単一のファイルをその場で暗号化
```
twintail encrypt ab files/assetbundle0
```
- ディレクトリ全体を暗号化し、結果を新しいディレクトリに出力
```
twintail encrypt ab ./decrypted_files ./encrypted_files
```

## ``encrypt suite``
Suitemasterファイルを暗号化します。

###
- 単一のファイルをその場で暗号化
```
twintail encrypt suite suite/cards.json
```
- ディレクトリ全体を暗号化し、結果を新しいディレクトリに出力
```
twintail encrypt suite ./suite ./encrypted_suite
```

## ``decrypt ab``
他のツールで使用するためにゲーム形式のアセットバンドルを復号化します。

###
- 単一のファイルを復号化し、結果を新しいファイルに出力
```
twintail decrypt ab encrypted_files/assetbundle0 decrypted_files/assetbundle0
```
- ディレクトリ全体をその場で再帰的に復号化
```
twintail decrypt ab --recursive ./encrypted_files
```

## ``decrypt suite``
Suitemasterファイルを復号化します。

###
- 単一のファイルを復号化し、結果を新しいディレクトリに出力
```
twintail decrypt suite suite/00_0m12kmj3k21mvnmx12 decrypted_suite
```
- ディレクトリ全体を新しいディレクトリに復号化
```
twintail decrypt suite ./encrypted ./decrypted
```
11 changes: 6 additions & 5 deletions docs/readme/jp.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
**| :us: [English](/README.md) | :jp: 日本語 |**
**| :us: [English](../../README.md) | :jp: 日本語 |**
# twintail
プロジェクトセカイ カラフルステージ!のゲームアセットをダウンロード、または暗号化・復号化することができる高速なコマンドラインツールです
プロジェクトセカイ カラフルステージ!のゲームアセットをダウンロード、または暗号化・復号化できる高速なコマンドラインツールです

twintailは現在、グローバル版と日本版のサーバーに対応しています。

最新バージョンは[リリースページ](https://github.com/Duosion/twintail/releases/latest)からダウンロードするか、[ビルド](#building)することができます。
最新バージョンは[リリースページ](https://github.com/Duosion/twintail/releases/latest)からダウンロードするか、[ビルド](#ビルド)することができます。

## 使用方法
[使用方法ガイド](/docs/usage/jp.md)をご覧ください。
- twintailの基本的な使い方については[使用ガイド](../usage/jp.md)をご覧ください。
- コマンドの例付きリストについては[コマンドリファレンス](../commands/jp.md)をご覧ください。

## ビルド方法
## ビルド
### 依存関係
- お使いのプラットフォーム向けの[Rust](https://www.rust-lang.org/tools/install)をインストールし、最新の状態であることを確認してください。
```
Expand Down
Loading

0 comments on commit 46dcaa2

Please sign in to comment.