darkomen
| Crates.io | darkomen |
| lib.rs | darkomen |
| version | 0.3.6 |
| source | src |
| created_at | 2024-06-23 02:48:25.027889 |
| updated_at | 2024-10-30 23:19:01.521088 |
| description | Warhammer: Dark Omen library and CLI in Rust |
| homepage | |
| repository | https://github.com/mgi388/darkomen |
| max_upload_size | |
| id | 1280932 |
| size | 440,021 |
(mgi388)
documentation
README
Warhammer: Dark Omen library and CLI in Rust
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 | Known issues? |
|---|---|---|---|---|
| 3D models | .M3D | ✅ | ❌ | |
| Army and save games | .ARM | ✅ | ✅ | ⚠️ Save games not completely understood |
| Battle blueprints | .BTB | ✅ | ❌ | |
| CTL | .CTL | ❌ | ❌ | |
| Cursors | .ANI | ❌ | ❌ | |
| Fonts | .FNT | ❌ | ❌ | |
| Game flows | .DOT | ❌ | ❌ | |
| Lights | .LIT | ✅ | ✅ | |
| Movies | .TGQ | ❌ | ❌ | |
| Particle effects | .PLB, .H | ❌ | ❌ | |
| Portrait scripts | .KEY, .SEQ | ❌ | ❌ | |
| Projects | .PRJ | ✅ | ✅ | |
| Shadows | .SHD | ✅ | ✅ | |
| Sound effects | .H | ✅ | ❌ | |
| Sound mono audio | .MAD | ✅ | ✅ | |
| Sound scripts | .FSM | ✅ | ✅ | |
| Sound stereo audio | .SAD | ✅ | ✅ | |
| Sprite sheets | .SPR | ✅ | ❌ |
Installation
Cargo
- Install the Rust toolchain, which also installs
cargo, by following the Install Rust guide - Run
cargo add darkomen
Cargo features
darkomen supports Bevy Reflection
through the bevy_reflect feature. To enable it, add the following line to
your Cargo.toml:
darkomen = { version = "0.3.6", features = ["bevy_reflect"] }
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 or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (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.