Skip to content

Commit

Permalink
Update toolset doc
Browse files Browse the repository at this point in the history
  • Loading branch information
PredatorCZ committed Sep 26, 2022
1 parent c44e79c commit e80bb2f
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
44 changes: 44 additions & 0 deletions toolset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This toolset runs on Spike foundation.

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

## ASM2JSON

### Module command: asm_to_json

Converts Animation State Machine graph to JSON.

## BDAT2JSON

### Module command: bdat_to_json
Expand All @@ -23,12 +29,24 @@ Converts BDAT data file or BDAT collection to JSON.

Extract by data entry if possible.

## ARHExtract

### Module command: extract_arh

Extract files from ARH/ARD archive pair.

## SHDExtract

### Module command: extract_shaders

Extract shaders from models, shader bundles or shaders. Converts them into GLSL code and/or shader assembly.

## IM2GLTF

### Module command: im_to_gltf

Convert streamed map instanced meshes to GLTF.

## SARCreate

### Module command: make_sar
Expand All @@ -55,12 +73,33 @@ Create SAR archives from files.

Output platform is big endian.

## MDO2GLTF

### Module command: mdo_to_gltf

Convert models to GLTF.

### Settings

- **fallback-skeleton**

**CLI Long:** ***--fallback-skeleton***\
**CLI Short:** ***-f***

Fallback skeleton file name if none wasn't found.

## SARExtract

### Module command: sar_extract

Exctract files from SAR archives.

## SMExtract

### Module command: sm_extract

Extract contents of streamed maps.

## SMTExtract

### Module command: smt_extract
Expand All @@ -73,3 +112,8 @@ Extract and convert textures from stream files into DDS.

Convert textures or streamed textures into DDS format.

## TM2GLTF

### Module command: tm_to_gltf

Convert streamed map terrain model to GLTF.
6 changes: 6 additions & 0 deletions toolset/doc_template.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,9 @@ Head to this **[Wiki](https://github.com/PredatorCZ/PreCore/wiki/Spike)** for mo
<make_sar>Create SAR archives from files.</make_sar>
<extract_shaders name="SHDExtract">Extract shaders from models, shader bundles or shaders. Converts them into GLSL code and/or shader assembly.</extract_shaders>
<bdat_to_json>Converts BDAT data file or BDAT collection to JSON.</bdat_to_json>
<asm_to_json name="ASM2JSON">Converts Animation State Machine graph to JSON.</asm_to_json>
<extract_arh name="ARHExtract">Extract files from ARH/ARD archive pair.</extract_arh>
<sm_extract name="SMExtract">Extract contents of streamed maps.</sm_extract>
<im_to_gltf name="IM2GLTF">Convert streamed map instanced meshes to GLTF.</im_to_gltf>
<tm_to_gltf name="TM2GLTF">Convert streamed map terrain model to GLTF.</tm_to_gltf>
<mdo_to_gltf>Convert models to GLTF.</mdo_to_gltf>

0 comments on commit e80bb2f

Please sign in to comment.