SaboteurToolset/doc_template.xml at master · PredatorCZ/SaboteurToolset · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version="1.0"?>
<toolset_name>SaboteurToolset</toolset_name>
<toolset_description>Saboteur Toolset is a collection of modding tools and research for Saboteur (2009).

The game itself runs on custom engine (probably called WildStar internally), which uses heavily compiled assets.
There are multiple steps for successful extraction (or possible modification):

- `global_extract` will extract global assets
- `france_extract` will extract assets related to main map, although it doesn't extract map itsef
- `megapack_extract` will extract pack files from any megapack or kilopack files, this tool should be only used on mega0, mega1 and mega2 megapacks, these contain map tiles
  - `tilepack_extract` will extract map tile packages extracted by `megapack_extract` tool

After all of this, following tools can be used:

- `mesh_to_gltf` converts extracted meshes into gltf format
- `dtex_to_dds` converts extracted dtex textures into dds format

All other tools are independent on each other.

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.

## 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 &lt;asset_name&gt;.sig
```</toolset_description>

<global_extract name="GlobalExtract">Extracts global assets.
Input path is a folder, where Saboteur.exe or EBOOT.BIN resides or `DLC/01` folder (tool will extract DLC content as well, so there is no need to provide DLC path).
Tool will look up all necessary files itself and extracts them accordingly.
Just for a detail, these files will be required: loosefiles pack anywhere in subfolders or `global.map`, `animations.pack`, `global/dynamic.megapack` and `global/palettes.megapack`
Similar rules apply to DLC, although most of the stuff is hard-coded due to nature of the engine.</global_extract>

<france_extract name="FranceExtract">Extracts assets that relates to france map iself. Mostly cinematic assets.
This tool is used in a same way as `global_extract` tool.
Just for a detail, these files will be required: loosefiles pack anywhere in subfolders or `france.map`, `cinematics.cinpack`, `animations.pack`, `france/mega0.megapack`.</france_extract>

<megapack_extract name="MegapackExtract">Extracts and megapack or kilopack archives.
This tool should be used on `mega0`, `mega1` and `mega2` megapacks. Other megapacks rely on tools like `global_extract` or `france_extract` because of the way files are indexed.
Kilopacks are in a weird spot, since they have duplicated files across the entire game, so there is no need to extract them at all.</megapack_extract>

<tilepack_extract name="Extract map tiles">Extracts map tiles from packs extracted by `megapack_extract` tool.</tilepack_extract>

<mesh_to_gltf name="Model to GLTF">Converts extracted models into GLTF format.
This tool can process only files extracted by `megapack_extract` + `tilepack_extract` or `global_extract` or `france_extract` tools.</mesh_to_gltf>

<dtex_to_dds name="DTEX to DDS">Converts extracted dtex textures into DDS format.
This tool can process only files extracted by `megapack_extract` + `tilepack_extract` or `global_extract` or `france_extract` tools.</dtex_to_dds>

<anim_extract name="AnimationsExtract">Extracts `animations.pack` package. Extracts hkx files and converts internal FSM/metadata into json file.
There is no way as in current version to convert extracted hkx files because of separated metadata.</anim_extract>

<loosefiles_extract name="LoosefilesExtract">Extracts contents of 'loosefiles' archive.</loosefiles_extract>

<luap_extract name="LUAPExtract">Extracts binary Lua files from `luascripts.luap` archive. Binary lua files can be disassembled by `ChunkSpy.lua`.</luap_extract>

<materials_extract name="MaterialsExtract">Extracts and converts materials into JSON.</materials_extract>

<toolset_footer>## [Latest Release](https://github.com/PredatorCZ/SaboteurToolset/releases)

## License

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

- Spike, Copyright (c) 2016-2023 Lukas Cone (Apache 2)
- zlib, Copyright (C) 1995-2022 Jean-loup Gailly and Mark Adler (Zlib)
</toolset_footer>