Update README to reflect name, add MIT licensing
This commit is contained in:
18
LICENSE
Normal file
18
LICENSE
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
Copyright 2018 Nicholas Thomas <ordoor@ur.gs>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
37
README.md
37
README.md
@@ -1,22 +1,17 @@
|
|||||||
# WH40K: Chaos Gate
|
# Ordoor
|
||||||
|
|
||||||
Re-implementation of the WH40K binary.
|
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**
|
**You must have a copy of the original game data to use this project**
|
||||||
|
|
||||||
WH40K.exe is the existing game engine
|
|
||||||
|
|
||||||
WH40K_TD.exe is the map editor. Allows things to be saved as .MAP or as .SMF
|
|
||||||
("Super Macro File")
|
|
||||||
|
|
||||||
This README is a grab-bag of miscellaneous information about file formats at
|
|
||||||
present. This is being migrated to the [Formats overview](doc/formats/index.md)
|
|
||||||
as a precursor to making this file useful!
|
|
||||||
|
|
||||||
No game yet, nothing even close. I'm in the very early stages of trying to
|
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
|
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!
|
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
|
## Building from source
|
||||||
|
|
||||||
I'm writing code in Go at the moment, so you'll need to have a Go runtime
|
I'm writing code in Go at the moment, so you'll need to have a Go runtime
|
||||||
@@ -28,19 +23,35 @@ go version go1.10 linux/amd64
|
|||||||
```
|
```
|
||||||
|
|
||||||
Clone the source tree to `$GOPATH/src/ur.gs/chaos-gate`. You can then run
|
Clone the source tree to `$GOPATH/src/ur.gs/chaos-gate`. You can then run
|
||||||
`make loader` or `make view-map` to get the two binaries that exist at present.
|
`make all` to get the binaries that exist at present.
|
||||||
|
|
||||||
They're not very interesting :D.
|
They're not very interesting :D.
|
||||||
|
|
||||||
Place your WH40K: Chaos Gate installation in `./orig` to benefit from automatic
|
Place your WH40K: Chaos Gate installation in `./orig` to benefit from automatic
|
||||||
path defaults. Otherwise, point to it with `-game-path`
|
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.
|
||||||
|
|
||||||
|
To run:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ make view-map
|
||||||
|
$ ./view-map -map orig/Maps/Chapter01.MAP -text 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.
|
||||||
|
|
||||||
|
Unlike the game, currently I only render the Z level you're actually on.
|
||||||
|
|
||||||
Dependency management uses `govendor`. Unless you're contributing code you
|
Dependency management uses `govendor`. Unless you're contributing code you
|
||||||
shouldn't have to worry about it.
|
shouldn't have to worry about it.
|
||||||
|
|
||||||
`dep` bug https://github.com/golang/dep/issues/1725 means I can't use it.
|
`dep` bug https://github.com/golang/dep/issues/1725 means I can't use it.
|
||||||
|
|
||||||
## Unmigrated text
|
## Miscellany
|
||||||
|
|
||||||
"Mission Setup" includes information about available squad types
|
"Mission Setup" includes information about available squad types
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user