Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@PredatorCZ
PredatorCZ committed Apr 17, 2024
1 parent 318be93 commit 0583fe0
Show file tree
Hide file tree
Showing 3 changed files with 159 additions and 51 deletions.
65 changes: 44 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,56 @@
# RevilLib

[![build](https://github.com/PredatorCZ/RevilLib/actions/workflows/cmake.yml/badge.svg)](https://github.com/PredatorCZ/RevilLib/actions/workflows/cmake.yml)
[![Coverage Status](https://coveralls.io/repos/github/PredatorCZ/RevilLib/badge.svg?branch=master)](https://coveralls.io/github/PredatorCZ/RevilLib?branch=master)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

<h1 align="center">RevilLib</h1>

<p align="center">
<a href="https://github.com/PredatorCZ/RevilLib/actions/workflows/cmake.yml"></a>
<img src="https://github.com/PredatorCZ/RevilLib/actions/workflows/cmake.yml/badge.svg" alt="build">
<a href="https://coveralls.io/github/PredatorCZ/RevilLib?branch=master"></a>
<img src="https://coveralls.io/repos/github/PredatorCZ/RevilLib/badge.svg?branch=master" alt="Coverage Status">
<a href="https://www.gnu.org/licenses/gpl-3.0"></a>
<img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3">
</p>

<p align="center">
RevilLib is an independent library for various formats, used by RE Engine and MT Framework.
</p>

<p align="center">
Library is written for C++20/23 and compilable under GCC 12+ and Clang 13+.
</p>

## Toolset
<h2>Toolset</h2>

Toolset can be found in [Toolset folder](https://github.com/PredatorCZ/RevilLib/tree/master/toolset)
<p>
Toolset can be found in
<a href="https://github.com/PredatorCZ/RevilLib/tree/master/toolse">
Toolset folder
</a>
</p>

[Toolset releases](https://github.com/PredatorCZ/RevilLib/releases)
<a href="https://github.com/PredatorCZ/RevilLib/releases">
Toolset releases
</a>

## Supported titles/formats
<h2>Supported titles/formats</h2>

* RE 7: motlist.60, mot.43 (PC only tested)
* REMake 2: motlist.85, mot.65 (PC only tested)
* REMake 3/Resistance: motlist.99, mot.78 (PC only tested)
* MT Framework: LMT, MOD, TEX, XFS, ARC (Cross platform, Multiversion)
<ul>
<li>RE 7: motlist.60, mot.43 (PC only tested)</li>
<li>REMake 2: motlist.85, mot.65 (PC only tested)</li>
<li>REMake 3/Resistance: motlist.99, mot.78 (PC only tested)</li>
<li>MT Framework: LMT, MOD, TEX, XFS, ARC (Cross platform, Multiversion)</li>
</ul>

## License

<h2>License</h2>
<p>
This library is available under GPL v3 license. (See LICENSE)

</p>
<p>
This library uses following libraries:

* Spike, Copyright (c) 2016-2023 Lukas Cone (Apache 2)
* libmspack, Copyright (c) 2003-2016 Stuart Caie (LGPLv2)
* zlib, Copyright (c) 1995-2022 Jean-loup Gailly and Mark Adler (Zlib)
* PoverVR Core, Copyright (c) Imagination Technologies Limited (MIT)
</p>

<ul>
<li>Spike, Copyright (c) 2016-2023 Lukas Cone (Apache 2)</li>
<li>libmspack, Copyright (c) 2003-2016 Stuart Caie (LGPLv2)</li>
<li>zlib, Copyright (c) 1995-2022 Jean-loup Gailly and Mark Adler (Zlib)</li>
<li>PoverVR Core, Copyright (c) Imagination Technologies Limited (MIT)</li>
</ul>
115 changes: 93 additions & 22 deletions toolset/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,49 @@
# RevilToolset

Revil Toolset is a collection of modding tools for RE Engine/MT Framework titles.

This toolset runs on Spike foundation.

Head to this **[Wiki](https://github.com/PredatorCZ/Spike/wiki/Spike)** for more information on how to effectively use it.

**[Latest Release](https://github.com/PredatorCZ/RevilLib/releases)**

## Release authenticity

Every release asset will contain corresponding `.sig` file, together with [Sign Key](sign_key.asc) can be used to verify asset via gpg.

Simple usage:

```bash
gpg --import sign_key.asc # Required only once
gpg --verify <asset_name>.sig
```

## Encrypt/Decrypt DDON SNGW
<h1 align="center">Revil Toolset</h1>

<p align="center">
Revil Toolset is a collection of modding tools for RE Engine/MT Framework titles.
</p>

<p align="center">
This toolset runs on Spike foundation.
</p>

<p align="center">
Head to this
<b><a href="https://github.com/PredatorCZ/Spike/wiki/Spike">Wiki</a></b>
for more information on how to effectively use it.
</p>

<p align="center">
<b><a href="https://github.com/PredatorCZ/RevilLib/releases">Latest Release</a></b>
</p><h2>Module list</h2>
<ul>
<li><a href="#Encrypt-or-Decrypt-DDON-SNGW">Encrypt or Decrypt DDON SNGW</a></li>
<li><a href="#ARC-Extract">ARC Extract</a></li>
<li><a href="#LMT-to-GLTF">LMT to GLTF</a></li>
<li><a href="#ARC-Create">ARC Create</a></li>
<li><a href="#MOD-to-GLTF">MOD to GLTF</a></li>
<li><a href="#MTF-TEX-to-DDS">MTF TEX to DDS</a></li>
<li><a href="#OBB-Extract">OBB Extract</a></li>
<li><a href="#RE-TEX-to-DDS">RE TEX to DDS</a></li>
<li><a href="#REAsset-to-GLTF">REAsset to GLTF</a></li>
<li><a href="#SDL-to-XML">SDL to XML</a></li>
<li><a href="#SPAC-Extract">SPAC Extract</a></li>
<li><a href="#UDAS-Extract">UDAS Extract</a></li>
<li><a href="#ValidateVFS">ValidateVFS</a></li>
<li><a href="#XFS-to-XML">XFS to XML</a></li>
<li><a href="#XML-to-SDL">XML to SDL</a></li>
</ul>

## Encrypt or Decrypt DDON SNGW

### Module command: ddon_sngw

Encrypts or decrypts `.sngw` sounds/music files from Dragons Dogma Online.

### Input file patterns: `.sngw$`

### Settings

- **encrypt**
Expand All @@ -36,12 +55,16 @@ Encrypts or decrypts `.sngw` sounds/music files from Dragons Dogma Online.

Switch between encrypt or decrypt only.

### Input file patterns: `.dwm$`

## ARC Extract

### Module command: extract_arc

Extract MT Framework ARC archives.

### Input file patterns: `.arc$`

### Settings

- **title**
Expand All @@ -62,6 +85,24 @@ Extract MT Framework ARC archives.

Set platform for correct archive handling.

- **class-whitelist**

**CLI Long:** ***--class-whitelist***\
Extract only specified (comma separated) classes. Extract all if empty.

## LMT to GLTF

### Module command: lmt_to_gltf

Converts MT Framework `.lmt` motion list into GLTF format.

> [!NOTE]
> The following file patterns apply to `batch.json` which is described [HERE](https://github.com/PredatorCZ/Spike/wiki/Spike---Batching)
### Main file patterns: `.glb$`, `.gltf$`

### Secondary file patterns: `.lmt$`, `.bin$`

## ARC Create

### Module command: make_arc
Expand Down Expand Up @@ -103,12 +144,16 @@ Create MT Framework ARC archives.

Converts MT Framework `.mod` model into GLTF format.

### Input file patterns: `.mod$`, `.dom$`

## MTF TEX to DDS

### Module command: mtf_tex_to_dds

Converts MT Framework `.tex` texture into DDS format.

### Input file patterns: `.tex$`

### Settings

- **legacy-dds**
Expand Down Expand Up @@ -155,12 +200,16 @@ Converts MT Framework `.tex` texture into DDS format.

Extract Android .obb archives for Monster Hunter Stories.

### Input file patterns: `.obb$`

## RE TEX to DDS

### Module command: re_tex_to_dds

Converts RE Engine `.tex` texture into DDS format.

### Input file patterns: `.tex$`

### Settings

- **legacy-dds**
Expand Down Expand Up @@ -197,6 +246,16 @@ Converts RE Engine `.tex` texture into DDS format.
Converts RE Engine various assets into GLTF format.
Currently only supports animations.

### Input file patterns: `.mot.43$`, `.mot.65$`, `.mot.78$`, `.mot.458$`, `.motlist.60$`, `.motlist.85$`, `.motlist.99$`, `.motlist.486$`

## SDL to XML

### Module command: sdl_to_xml

Converts MT Framework `.sdl` scheduler into XML format.

### Input file patterns: `.sdl$`

## SPAC Extract

### Module command: spac_conv
Expand All @@ -209,12 +268,16 @@ Extracts MT Framework `.spc` sound containers.
- MSF, Various formats (16bit PCM, AT3, ...), PS3
- RIFF WAVE, Various formats (MS IMA ADPCM mostly), PC

### Input file patterns: `.spc$`

## UDAS Extract

### Module command: udas_extract

Extract udas/das archives from RE4.

### Input file patterns: `.udas.lfs$`

## XFS to XML

### Module command: xfs_to_xml
Expand All @@ -241,9 +304,17 @@ Converts MT Framework generic binary data table format into XML.

Save data.

## XML to SDL

### Module command: xml_to_sdl

Converts XML format back to MT Framework `.sdl` scheduler.

### Input file patterns: `.xml$`

## License

This toolset is available under GPL v3 license. (See LICENSE.md)\
This toolset uses following libraries:

- RevilLib, Copyright (c) 2017-2022 Lukas Cone
- RevilLib, Copyright (c) 2017-2024 Lukas Cone
30 changes: 22 additions & 8 deletions toolset/doc_template.xml
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
<?xml version="1.0"?>
<toolset_name>RevilToolset</toolset_name>
<toolset_description>Revil Toolset is a collection of modding tools for RE Engine/MT Framework titles.
<toolset_description><![CDATA[
<h1 align="center">Revil Toolset</h1>
This toolset runs on Spike foundation.
<p align="center">
Revil Toolset is a collection of modding tools for RE Engine/MT Framework titles.
</p>
Head to this **[Wiki](https://github.com/PredatorCZ/Spike/wiki/Spike)** for more information on how to effectively use it.
<p align="center">
This toolset runs on Spike foundation.
</p>
**[Latest Release](https://github.com/PredatorCZ/RevilLib/releases)**
<p align="center">
Head to this
<b><a href="https://github.com/PredatorCZ/Spike/wiki/Spike">Wiki</a></b>
for more information on how to effectively use it.
</p>
<p align="center">
<b><a href="https://github.com/PredatorCZ/RevilLib/releases">Latest Release</a></b>
</p>]]>

## Release authenticity

Expand All @@ -18,9 +29,12 @@ Simple usage:
gpg --import sign_key.asc # Required only once
gpg --verify &lt;asset_name&gt;.sig
```</toolset_description>
<ddon_sngw name="Encrypt/Decrypt DDON SNGW">Encrypts or decrypts `.sngw` sounds/music files from Dragons Dogma Online.</ddon_sngw>
<ddon_sngw name="Encrypt or Decrypt DDON SNGW">Encrypts or decrypts `.sngw` sounds/music files from Dragons Dogma Online.</ddon_sngw>
<mod_to_gltf name="MOD to GLTF">Converts MT Framework `.mod` model into GLTF format.</mod_to_gltf>
<lmt_to_gltf name="LMT to GLTF">Converts MT Framework `.lmt` motion list into GLTF format.</lmt_to_gltf>
<mtf_tex_to_dds name="MTF TEX to DDS">Converts MT Framework `.tex` texture into DDS format.</mtf_tex_to_dds>
<sdl_to_xml name="SDL to XML">Converts MT Framework `.sdl` scheduler into XML format.</sdl_to_xml>
<xml_to_sdl name="XML to SDL">Converts XML format back to MT Framework `.sdl` scheduler.</xml_to_sdl>
<re_tex_to_dds name="RE TEX to DDS">Converts RE Engine `.tex` texture into DDS format.</re_tex_to_dds>
<reasset_to_gltf name="REAsset to GLTF">Converts RE Engine various assets into GLTF format.
Currently only supports animations.</reasset_to_gltf>
Expand All @@ -41,5 +55,5 @@ Currently only supports animations.</reasset_to_gltf>
This toolset is available under GPL v3 license. (See LICENSE.md)\
This toolset uses following libraries:

- RevilLib, Copyright (c) 2017-2022 Lukas Cone
- RevilLib, Copyright (c) 2017-2024 Lukas Cone
</toolset_footer>

0 comments on commit 0583fe0

Please sign in to comment.