Updated README.md

This commit is contained in:
JackCarterSmith 2020-09-09 02:21:27 +02:00
parent 43d08752fa
commit 1b111664b0
No known key found for this signature in database
GPG Key ID: B05F75E5934B1D7F
2 changed files with 31 additions and 11 deletions

14
.gitignore vendored
View File

@ -60,3 +60,17 @@ Release/
.cproject
.project
*.launch
# CMake files
build/
CMakeLists.txt.user
CMakeCache.txt
CMakeFiles
CMakeScripts
Testing
Makefile
cmake_install.cmake
install_manifest.txt
compile_commands.json
CTestTestfile.cmake
_deps

View File

@ -1,17 +1,17 @@
# RogueSquadron Data Extractor - TEXTURE module
# RogueSquadron Extractor - TEXTURE module
Inspired by the work of **dpethes** (https://github.com/dpethes/rerogue)
Inspired by the work of **dpethes** (https://github.com/dpethes/rerogue) :clap:
This set of git repos are a compilation of tools coded in C to make RS modding far more than a dream!
The collection consist of few independants modules, each of them deals with specific data like sound, textures, heightmaps, etc...
All modules are independants. This is the **'TEXTURE'** module.
**CAUTION! Master branch is ugly for now and should not be used, please take only released versions.**
:exclamation: **Master branch is ugly for now and should not be used, please take only released versions.** :exclamation:
## TEXTURE MODULE
It's extract texture datas from Rogue Squadron 3D (PC) game files (DAT).
It's extract texture datas from Rogue Squadron 3D (PC) game textures files (HMT).
This module can do:
- Extract textures inside HMT files to PNG format,
@ -22,7 +22,9 @@ This module can do:
### Using
`RSE-Texture_"version" [options] <hmt files...>` or you can
`RSE-Texture_"version" [options] <hmt files...>` or you can simply drag&drop hmt files on it.
Some textures samples can be found here (https://bit.ly/2DGjtng). A futur main program can extract all HMT files directly from DAT file.
### Options
@ -32,18 +34,22 @@ This module can do:
### Dependencies
Necessary libs for running (provided in release) and for compiling.
Necessary libs (provided only in windows release) for running and for compiling.
- zlib (1.2.11)
- libpng (1.6.37)
### Compiling
You can compile on both Windows (MinGW) or native Linux system, you only need to adjust your dependencies.
You can compile on both Windows (MinGW) or native Linux system thanks to CMake, you only need to adjust your dependencies on Windows.
zlib (zlib1g) and libpng16 distrib packages can be used on debian/ubuntu.
zlib and libpng16 distrib packages can be used.
To compile, just type on linux: `make`
To compile, just clone and launch cmake:
### TODO
```shell
cmake .
make
make install
```
[ ] Cmake integration
On Windows system, you will probably need to specify the dependency flags for CMake.