1# MAXR 2 3## Introduction 4 5Mechanized Assault & eXploration Reloaded 6 7A turn based strategy game based on M.A.X. created by fans as a community to make it's unique multiplayer experience possible on modern networks and systems. It is licensed under the GPL v2 and CC BY-SA 3.0 and is as such a free open source game written for the operating systems Linux, Mac and Windows. 8 9## Licence 10 11MAXR is dual licensed. While the game itself, including source and most assets, are released under the GPL v2 some files are not. 12 13For GPL v2 see `data/COPYING` 14 15For files unter CC BY-SA 3.0 see `data/COPYING.README ` 16 17# Building MAXR 18 19## Supported Platforms 20 21* Mac OS X 22* MS Windows 23* Linux 24 25Other UNIX-like operating systems may work too out of the box. Chances are huge if there's a build of SDL2 and CMake for the system. 26 27## Building MAXR with CMake 28 29MAXR is distributed with a `CMakeLists.txt` file for CMake. 30Consequently, if you are building from source, you will have to 31set up your Makefiles with `cmake`, before you can run `make` 32from the projects root folder: 33 34```shell 35mkdir build 36cd build 37cmake .. 38make 39``` 40 41### Change between Debug and Release build: 42 43Use the options `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` when running `cmake`: 44 45`cmake -DCMAKE_BUILD_TYPE=Release ..` 46 47### Build the dedicated server of maxr: 48 49Use the options `-DMAXR_BUILD_DEDICATED_SERVER=ON` in another 50cmake build folder, because the binary will overwrite any 51existing maxr binary. From the projects root folder: 52 53```shell 54mkdir build-dedicated 55cd build-dedicated 56cmake --DMAXR_BUILD_DEDICATED_SERVER=ON .. 57``` 58 59### Build and install MAXR on Linux 60 61Compiles the maxr binary and installs it along with the game data to the default prefix which is probably /usr/local. 62 63```shell 64mkdir build 65cd build 66cmake .. 67make install 68``` 69 70After installing you can start maxr executing 'maxr' 71 72Use `make DESTDIR=/foo/bar install` to make use of destdir. 73 74If you just want to start maxr without installing simply 75override the data path MAXRDATA after running `make` in your 76build dir: `MAXRDATA=../cp data/ ./maxr` 77 78## Additional important files 79 80Please find additional files in `./data`: 81 82ABOUT `data/ABOUT` 83 84AUTHORS `data/AUTHORS` 85 86INSTALL `data/INSTALL` 87 88MANUAL `data/MANUAL` 89