ordoor/README.md

# Ordoor

Portmanteau of Order Door, a remake project for Warhammer 40,000: Chaos Gate,
the game from 1998.

**You must have a copy of the original game data to use this project**

No game yet, nothing even close. I'm in the very early stages of trying to
understand the various file formats. Until then, you can play WH40K: Chaos Gate
in a WinXP VM, disconnected from the internet. It doesn't need 3D rendering!

WH40K.exe is the existing game engine, and WH40K_TD.exe is the map editor.
Allows things to be saved as .MAP or as .SMF ("Super Macro File").

## Building from source

I'm writing code in Go at the moment, so you'll need to have a Go runtime
installed on your system:

```
$ go version
go version go1.10 linux/amd64
```

In addition, you'll also need the following packages installed, at least in
Debian:

```
apt-get install libx11-dev libxcursor-dev mesa-common-dev libxrandr-dev \
  libxinerama-dev libgl1-mesa-dev libxi-dev
```

Clone the source tree to `$GOPATH/src/ur.gs/ordoor`. You can then run
`make all` to get the binaries that exist at present.

They're not very interesting :D.

Place your WH40K: Chaos Gate installation in `./orig` to benefit from automatic
path defaults. Otherwise, point to it with `-game-path`

The `view-map` binary attempts to render a map, and is the current focus of
effort. Once I can render a whole map, including pre-placed characters (cultist
scum), things can start to get more interesting.

Current status: map tiles are rendered at correct offsets. Tiles (four per 
coordinate: floor, centre, left, and right) are rendered, but the pixels for
those tiles are not 100% accurate.

Characters and animations aren't touched at all yet. Rendering performance is
atrocious. No gameplay, no sound, no campaign logic. Interaction with the play
area is minimal and limited to pan, zoom, and click for basic console output.

Still, I'm proud of myself.

To run:

```
$ make view-map
$ ./view-map -map orig/Maps/Chapter01.MAP -txt orig/Maps/Chapter01.TXT
```

Use the arrow keys to scroll around the map, the mouse wheel to zoom, and the
`1` - `7` keys to change Z level.

Dependency management uses `govendor`. Unless you're contributing code you
shouldn't have to worry about it.

`dep` bug https://github.com/golang/dep/issues/1725 means I can't use it.

## Miscellany

"Mission Setup" includes information about available squad types

From EquipDef.cpp Dumo: CEquipment we learn the following object types:

0. DELETED
1. WEAPON
2. GRENADE
3. MEDIPACK
4. SCANNER
5. GENESEED
6. CLIP
7. DOOR KEY
8. DOOR KEY
9. DOOR KEY
10. DOOR KEY

And we learn they can be "on"....

0. CHARACTER
1. VEHICLE
2. CANISTER