README
¶
Warhammer: Dark Omen Go library
This library is for developers interested in building tools for working with Dark Omen's assets.
This library does not ship with any Dark Omen assets. You must have a legally purchased copy of Dark Omen in order to get the benefits of this library.
Note: This library is neither developed by nor endorsed by Electronic Arts Inc.
Table of contents
Installation
Use go get to retrieve the library and add it to your project's Go module dependencies.
go get github.com/jonathaningram/dark-omen
Game file support
The following game files are supported by the library.
| Kind | File extension | Read | Write | Known issues? |
|---|---|---|---|---|
| Army and saved games | .ARM | ✅ | ❌ | ⚠️ Yes, experimental and incomplete |
| Dot | .DOT | ✅ | ❌ | ✅ None |
| Font | .FNT | ✅ | ❌ | ⚠️ Yes, height/line-height possibly not correct |
| 3D model | .M3D | ✅ | ❌ | ✅ None |
| Mono audio | .MAD | ✅ | ✅ | ✅ None |
| Project | .PRJ | ✅ | ❌ | ⚠️ None, but untested |
| Stereo audio | .SAD | ✅ | ✅ | ✅ None |
| Sprite | .SPR | ✅ | ❌ | ✅ None |
Tests
To run all tests:
go test -race ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
encoding
|
|
|
dot
Package dot implements decoding of Dark Omen's .DOT path files.
|
Package dot implements decoding of Dark Omen's .DOT path files. |
|
m3d
Package m3d implements decoding of Dark Omen's .M3D 3D model files.
|
Package m3d implements decoding of Dark Omen's .M3D 3D model files. |
|
prj
Package prj implements decoding of Dark Omen's .PRJ project files.
|
Package prj implements decoding of Dark Omen's .PRJ project files. |
|
spr
Package spr implements decoding of Dark Omen's .SPR sprite files.
|
Package spr implements decoding of Dark Omen's .SPR sprite files. |
|
Package engrel provides functions that can access information found in Dark Omen's PRG_ENG/ENGREL.exe executable file.
|
Package engrel provides functions that can access information found in Dark Omen's PRG_ENG/ENGREL.exe executable file. |
|
internal
|
|
|
cstringutil
Package cstringutil contains utility functions for working with C strings.
|
Package cstringutil contains utility functions for working with C strings. |
Click to show internal directories.
Click to hide internal directories.