Metadata-Version: 2.1
Name: wacky
Version: 1.0.1
Summary: Wacca DataTable files loading + dumping
Home-page: https://gitlab.com/Buggyroom/wacky
Author: Stepland
Author-email: 10530295-Buggyroom@users.noreply.gitlab.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=8.0.4,<9.0.0)
Requires-Dist: construct-typing (>=0.5.2,<0.6.0)
Requires-Dist: ruamel.yaml (>=0.17.21,<0.18.0)
Project-URL: Repository, https://gitlab.com/Buggyroom/wacky
Description-Content-Type: text/markdown

# Wacky

Wacca DataTable files loading + dumping lib

Specifically geared towards files :

- created by / for UE 4.19
- split in `.uasset` + `.uexp` pairs
- only containing DataTable exports

## Installing

```shell-session
pip install wacky
```

## Command Line Usage

### Unpacking

```shell-session
$ wacky unpack [OPTIONS] UASSET UEXP
```

This converts the useful data inside `UASSET` and `UEXP` to a yaml (or json) file you can edit and then use to repack

Options:
  - `--json` : Output json instead of yaml
  - `-o FILENAME`, `--output FILENAME` : Output to a specific file (instead of to stdout)
  - `--help`: Show a help message and exit.

### Modifying

Just use a text editor to change the file you've created with the previous command

### Repacking

```shell-session
$ wacky repack [OPTIONS] SRC_UASSET SRC_UEXP NEW_DATA DST_UASSET DST_UEXP
```

This creates new modified `.uasset` and `.uexp` files by using `SRC_UASSET` and `SRC_UEXP` as templates and applying the changes specified by `NEW_DATA`

Options:
  - `--help`: Show a help message and exit.

## Python API

```python
>>> from wacky import load, dump
>>> package = load(uasset=open(..., "rb"), uexp=open(..., "rb"))
>>> ... # Do stuff with `package`
>>> dump(package, uasset=open(..., "wb"), uexp=open(..., "wb"))
```


## Folder Contents

| File / Folder | Description |
|---------------|-------------|
| src/ | Sources |
| tests/ | unit tests, with example `.uasset` and `.uexp` files |
| utils/ | Things worth keeping around |
| .flake8 | [Flake8](https://flake8.pycqa.org/en/latest/) config |
| .gitignore | list of file patterns git ignores |
| CHANGELOG.md | Changelog |
| poetry.lock | Precise info about every dependency or sub-dependency, generated by [poetry](https://python-poetry.org/), don't modify yourself |
| pyproject.toml | Projet description file, mostly managed by [poetry](https://python-poetry.org/) |
| README.md | The file you are reading right now |
| UE4.ksy | Definition of the .uasset + .uexp file structure using [Kaitai Struct](https://kaitai.io/), for documentation and preservation purposes |
