@@ -32,6 +32,26 @@ SCDV is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_Pyth
As stated above, SCDV uses [Poetry](https://python-poetry.org/) to manage dependencies and requirements. See the `pyproject.toml` file in the repo for what python dependencies are being used in SCDV. During development, however, many changes may actually be done in [scdatatools](https://gitlab.com/scmodding/frameworks/scdatatools). It's recommended to clone both projects, then use `pip install -e` the local version of scdatatools.
### Optional Dependencies
Often these optional dependencies are included in the platform specific release packages.
#### View and Convert textures (dds)
To view or convert textures (.dds*) files, SCDV relies on [texconv](https://github.com/microsoft/DirectXTex/releases) or [compressonator](https://gpuopen.com/compressonator/). Ensure that `texconv` or `compressonatorcli` is installed and in your system `PATH`.
#### Convert Audio Files (wem)
To convert wem files, you must have [ww2ogg](https://github.com/hcs64/ww2ogg) and [revorb](https://cloudflare-ipfs.com/ipfs/QmVgjfU7qgPEtANatrfh7VQJby9t1ojrTbN7X8Ei4djF4e/revorb.exe) in your path. **Both are included in the MSI installer for Windows.**
> **Note for Windows: you must have the Vorbis codecs installed to listen to audio in SCDV. You can download them on [Xiph.org](https://xiph.org/dshow/downloads/)**
#### Convert CryEngine Models (cga/cgf/chr/skin)
scdatatools uses [cgf-converter](https://github.com/Markemp/Cryengine-Converter) to convert CryEngine models to a standard format (Collada/dae)
# Developer Quick Start
While there are many ways to configure your development environment, the following methods are known to work/repeatable.
