Metadata-Version: 2.1
Name: dvplc
Version: 0.1.2
Summary: CLI app to convert Dava SmartDLC .dvpl files used in Wargaming.net's World of Tanks Bliz MMO game
Author-email: Jylpah <Jylpah@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/Jylpah/dvplc
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lz4
Requires-Dist: aiofiles
Requires-Dist: aioconsole
Requires-Dist: importlib-metadata

# NAME

`dvplc` - encode/decode/verify Dava game engine's SmartDLC DVPL files. 

# STATUS

Tested on Linux & Working :-) 

## TODO

* Test on other platforms 

# Installation 

*Python 3.10+ is required*

My recommendation is to use `git` as your *package manager*.
```
# Clone repo
git clone --recurse-submodules https://github.com/Jylpah/dvplc.git

# Install required Python modules with Python pip
cd dvplc
pip install -r requirements.txt
```

**If** you forgot to add the `--recurse-submodules` option to `git clone` you can run `git submodule update --init` after cloning the repository. 

## Update

```
git pull --recurse-submodules
```

# SYNOPSIS

`dvplc [OPTIONS] MODE FILE | DIR [FILE | DIR] ...`

# DESCRIPTION

## MODE

`encode` - Encode source files to DVPL format

`decode` - Decode DVPL files to source files

`verify` - Verify DVPL files

## GENERAL OPTIONS

`--verbose` Verbose logging messages

`--debug` Show debug logging messages 

`--silent` Silence logging messages

`--force` Overwrite files, default is `False`

`--threads` `INT` Number of worker threads. By default the number of threads are defined automatically. 

`--keep` Place converted files to the same directory as source files (default)

`--replace` Delete source files after conversion

`--mirror` `DIR` Mirror source tree structure to DIR and place converted files there. All source files have to be under working dir. 

## `encode` OPTIONS

`--compression` `lz4` | `lz4_hc` | `rfc1951` | `none`

# DVPL File format

*Credits [Maddoxkkm](https://github.com/Maddoxkkm)*

UINT32LE compression Type

0: no compression (format used in all uncompressed .dvpl files from SmartDLC)

1: LZ4 (not observed but handled by this decompressor)

2: LZ4_HC (format used in all compressed .dvpl files from SmartDLC)

3: RFC1951 (not implemented in this decompressor since it's not observed)
=======
UINT32LE compression Type:
* 0: no compression (format used in all uncompressed .dvpl files from SmartDLC)
* 1: LZ4 (not observed but handled by this decompressor)
* 2: LZ4_HC (format used in all compressed .dvpl files from SmartDLC)
* 3: RFC1951 (not implemented in this decompressor since it's not observed)
