Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Blume committed Sep 21, 2023
1 parent f35d1bf commit f103bb4
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
20 changes: 17 additions & 3 deletions docs/soundmodding.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,23 @@ This can now be loaded into the game (copy it into the/68335/72352/ZZ\_1.dat) an
Only because you reference a new file here, the game will not automatically load it, in the cluster*.ndfbin files there is a list of loaded files.
This is only necessary for **new** files though, in this case we replace existing files, which get referenced in the cluster of the main game.

### Loops

Some files use loops, especially weapon sounds. These can be set using Audacity the encode\_ess tool.

To mark an area as a loop, open your sound file in Audacity and create [a label track](https://manual.audacityteam.org/man/label_tracks.html).

Add a label from Selection and call this label "loop".

You can export the Labels in Audacity in File -> Export -> Export Labels. This will produce a txt file, for example "labels.txt".

Now when using encode\_ess, you can use the -l parameter for supplying the labels.txt:

``` bash
encode_ess.exe test.wav -l labels.txt -o test.ess
```

The generate\_sformat tool will also understand this.

### Limitations

Expand All @@ -103,9 +120,6 @@ There are a few unknowns in the sformat file:
- 2, 4, 44, 112, 176, 736, 4096
- the tool just assumes unk4 = 2

- essUnk2:
- This is probably the loopStart?

- data:
- This is probably the amplitude envelope?

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors = [
{name = "End", email = "[email protected]"},
]
description="Tools for working with the xml files generated by wgrd_cons_parsers for modding the game Wargame: Red Dragon."
version = "0.2.9"
version = "0.2.10"
requires-python = ">=3.10"
dependencies = [
"dingsda",
Expand Down
2 changes: 1 addition & 1 deletion src/wgrd_cons_tools/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version_string = "0.2.9"
version_string = "0.2.10"

0 comments on commit f103bb4

Please sign in to comment.