OpenOMF
=======

[![CI](https://github.com/omf2097/openomf/actions/workflows/compilation.yml/badge.svg?branch=master)](https://github.com/omf2097/openomf/actions/workflows/compilation.yml)

![Flail vs Gargoyle](/docs/flail.png)

OpenOMF is an Open Source remake of "One Must Fall 2097" by Diversions
Entertainment. Since the original DOS game from 1994 uses IPX networking and
is a pain to set up, the community needed a better solution to keep playing
the game we love. Together with networking, we try to make it easier to play
One Must Fall in its original glory on multiple platforms (Linux, Mac OSX,
Windows, BSD to name a few).

For more detailed information about the project, please see
[http://www.openomf.org/](http://www.openomf.org).

Installation
------------

### AppImage

1. Download the latest .AppImage executable from https://github.com/omf2097/openomf/releases
2. Run `chmod +x OpenOMF-<version>-x86_64.AppImage`
3. Play the game with `./OpenOMF-<version>-x86_64.AppImage`

### Ubuntu

1. Download the latest .deb package from https://github.com/omf2097/openomf/releases
2. Run `sudo apt install ./openomf_<version>_amd64.deb`

### Windows

1. Download the latest windows package from https://github.com/omf2097/openomf/releases
2. Extract the zip file somewhere

Build
-----
For compiling from sources, please see [BUILD.md](BUILD.md).

License
-------
OpenOMF is developed under the MIT License. Please read [LICENSE](LICENSE)
for more information.

OpenOMF contains pieces of other software, which have licenses of their own:
- resources/gamecontrollerdb.txt is under [zlib license](resources/gamecontrollerdb/LICENSE.gamecontrollerdb)
- src/vendored/argtable3 is under multiple licenses, please see [LICENSE](src/vendored/argtable/LICENSE.argtable3)
- src/vendored/zip and miniz is under the MIT license, please see [LICENSE](src/vendored/zip/LICENSE.zip)

And finally, the icon resources in resources/icons fall under CC-BY 4.0 license; please see 
[LICENSE](resources/icons/LICENSE) and https://creativecommons.org/licenses/by/4.0/ for details.

Contribute
----------
For guidelines on contributing, please see [CONTRIBUTING.md](CONTRIBUTING.md).

Contact
-------
Discord: https://discord.gg/7CPPzab
