darkomen 0.4.1

Warhammer: Dark Omen library and CLI in Rust
Documentation 
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
76
77
78
79
80
81
82
83
84
85

# Warhammer: Dark Omen library and CLI in Rust

[![Crates.io](https://img.shields.io/crates/v/darkomen.svg)](https://crates.io/crates/darkomen)
[![Docs.rs](https://docs.rs/darkomen/badge.svg)](https://docs.rs/darkomen)
[![CI](https://github.com/mgi388/darkomen/workflows/CI/badge.svg)](https://github.com/mgi388/darkomen/actions)

A Rust library designed to work with the classic game **Warhammer: Dark Omen**. It provides developers with tools to read, manipulate, and write game data, enabling the creation of mods, custom levels, and analysis tools.

## Features

The following table shows the game file support in this library:

| Kind                                                 | File extension(s)      | Read | Write | Notes                                                                   |
| ---------------------------------------------------- | ---------------------- | ---- | ----- | ----------------------------------------------------------------------- |
| [3D models](src/m3d)                                 | .M3D, .M3X             | ✅   | ✅    |                                                                         |
| [Army and save games](src/army)                      | .ARM, .AUD, .ARE, .xxx | ✅   | ✅    | ⚠️ Save games not completely understood                                 |
| [Battle tabletops](src/battle_tabletop)              | .BTB                   | ✅   | ✅    |                                                                         |
| CTL                                                  | .CTL                   | ❌   | ❌    |                                                                         |
| [Cursors](https://github.com/mgi388/bevy-cursor-kit) | .ANI, .CUR             | ✅   | ❌    | 📦 Read support available for Bevy apps through `bevy_cursor_kit` crate |
| Fonts                                                | .FNT                   | ❌   | ❌    |                                                                         |
| [Gameflows](src/gameflow)                            | .DOT                   | ✅   | ✅    |                                                                         |
| [Lights](src/light)                                  | .LIT                   | ✅   | ✅    |                                                                         |
| Movies                                               | .TGQ                   | ❌   | ❌    |                                                                         |
| Particle effects                                     | .PLB, .H               | ❌   | ❌    |                                                                         |
| [Portrait heads](src/portrait/heads)                 | HEADS.DB               | ✅   | ✅    |                                                                         |
| [Portrait keyframes](src/portrait/keyframes)         | .KEY                   | ✅   | ✅    |                                                                         |
| [Portrait sequences](src/portrait/sequences)         | .SEQ                   | ✅   | ✅    | ⚠️ Commands not validated                                               |
| [Projects](src/project)                              | .PRJ                   | ✅   | ✅    |                                                                         |
| [Shadows](src/shadow)                                | .SHD                   | ✅   | ✅    |                                                                         |
| [Sound effects](src/sound/sfx)                       | .H                     | ✅   | ❌    |                                                                         |
| [Sound mono audio](src/sound/mad)                    | .MAD                   | ✅   | ✅    |                                                                         |
| [Sound scripts](src/sound/script)                    | .FSM                   | ✅   | ✅    |                                                                         |
| [Sound stereo audio](src/sound/sad)                  | .SAD                   | ✅   | ✅    |                                                                         |
| [Sprite sheets](src/graphics/sprite_sheet)           | .SPR                   | ✅   | ❌    |                                                                         |

## Installation

### Cargo

- Install the Rust toolchain, which also installs `cargo`, by following the [Install Rust guide](https://www.rust-lang.org/tools/install)
- Run `cargo add darkomen`

#### Cargo features

`darkomen` supports [Bevy Reflection](https://docs.rs/bevy_reflect/latest/bevy_reflect)
through the `bevy_reflect` feature. To enable it, add the following line to
your `Cargo.toml`:

```toml
darkomen = { version = "0.4.1", features = ["bevy_reflect"] }
```

## CLI

Example setting the `--editor` flag on Windows to open the file in Visual Studio
Code and wait for it to close before exiting the command:

```bash
darkomen army edit DARKOMEN/GAMEDATA/1PARM/PLYR_ALL.ARM --editor "cmd /C code --wait"
```

## Important notes

> [!NOTE]
> This library does not ship with any game assets. You must have a copy of the game to get the most from this library.

> [!NOTE]
> This library is not developed by or endorsed by Games Workshop or Electronic Arts.

## License

Licensed under either of

- Apache License, Version 2.0
  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license
  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.