• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

cmake-scripts/H10-Jan-2016-6354

doc/H10-Jan-2016-1,9561,433

include/shadowdive/H10-Jan-2016-3,7561,092

resources/H10-Jan-2016-223203

src/H10-Jan-2016-5,6324,533

testing/H03-May-2022-3,4163,211

.gitignoreH A D10-Jan-201654 87

.travis.ymlH A D10-Jan-2016569 2116

LICENSEH A D10-Jan-20161.1 KiB2016

README.mdH A D10-Jan-20162.1 KiB6749

README.md

1libShadowDive
2=============
3
4[![Build Status](https://travis-ci.org/omf2097/libShadowDive.png?branch=master)](https://travis-ci.org/omf2097/libShadowDive)
5
6Overview
7--------
8libShadowDive is a library for reading and writing One Must Fall 2097 datafiles. Note! Because we don't yet know everything about OMF2097 file formats and therefore the library keeps changing all the time, libShadowDive is meant to be statically linked to OpenOMF and Omf2097-tools projects by pulling a certain version of it as a git submodule. Dynamic linking could be made to work, but there is not much point to it currently.
9
10Features:
11* HAR Data files (*.AF)
12* Arena/background data files (*.BK)
13* Language files (ENGLISH.DAT,GERMAN.DAT)
14* Sound data file (SOUNDS.DAT)
15* Characters for both big and small fonts (GRAPHCHR.DAT, CHARSMAL.DAT)
16* Score file (SCORES.DAT)
17* Pilot image files (*.PIC)
18* Tournament data files (*.TRN)
19* Character save files (*.CHR)
20* Match record files (*.REC)
21* Alternate palette file (ALTPALS.DAT)
22
23Other files:
24* OMF music files are in PSM module format, and can be opened with libdumb.
25
26Dependencies
27---------------
28
29CMake is required for building this package. LibPNG is required for importing and exporting
30image data. Compiling should be possible with any C99 capable C compiler (GCC and CLANG tested).
31
32Note! GCC 4.8.x series has bugs that may prevent compiling in debug mode!
33
34Some common package manager commands for receiving the dependencies:
35
36Debian:
37```
38apt-get install cmake libpng-dev
39```
40
41Compiling
42---------
43
44To compile:
45
46```
47$ mkdir -p build
48$ cd build
49$ cmake -DCMAKE_RELEASE_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
50$ make
51```
52
53Documentation
54-------------
55
56Documentation can be found at [https://katajakasa.fi/projects/openomf/sd_doc/](https://katajakasa.fi/projects/openomf/sd_doc/).
57
58You can also generate the documentation yourself by running doc/Doxyfile through doxygen (```doxygen Doxyfile```).
59
60License
61-------
62MIT. Please see LICENSE file for details.
63
64Contact
65-------
66Join us on [#omf](http://webchat.freenode.net?channels=omf) on [irc.freenode.net](irc://chat.freenode.net/omf) if you want to get in contact with us.
67