diff --git a/README.md b/README.md index 11f1748e..d9b9b3b8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ Doom64EX-Plus ======== +Differences from Kaiser's C++ version on Github. + +* Support for the Nightdive IWAD +* Support for the Lost Levels +* Support for loading PWADS +* Better performance (especially when compared to the official Nightdive version, which is slow as hell) +* Secret notifications +* MAP slots up to MAP40 + +There are a few bugs still present, which I am slowly fixing. This GitHub repo is the same as: https://sourceforge.net/projects/doom64ex-plus/ + +But if any contributors wish to help, then GitHub is a better place for it. + +# Info + Doom64EX-Plus is a reverse-engineering project aimed to recreate Doom64 as close as possible with additional modding features. **NOTE for Linux users:** As of Feb. 24, 2016, the save data is located in `$XDG_DATA_HOME/doom64ex-plus` (typically `~/.local/share/doom64ex-plus`) and not in `~/.doom64ex-plus`. The files can be safely moved to their new home. @@ -15,28 +30,16 @@ Doom64EX-Plus is a reverse-engineering project aimed to recreate Doom64 as close ## Compiling -### Linux and MSYS (Windows) +### Linux, MSYS and cross compilation. Clone this repo $ git clone https://github.com/atsb/Doom64EX-Plus + +For Linux, use the build.sh script. +For cross compilation on Windows, use the build_win_cross.sh -Create a new directory inside the repo root where compilation will take place - - $ mkdir Doom64EX-Plus/temp - $ cd Doom64EX-Plus/temp - -Run cmake and make - - $ cmake .. && make - -(For MSYS) - - $ cmake .. -G "MSYS Makefiles" && make - -Install doom64ex-plus - - # make install +Native Windows does not yet have a script or make approach to build it. This is due to some bugs that appear on 64bit, so the cross compilation is the official way to build it currently. ## Usage @@ -53,16 +56,11 @@ Doom64EX-Plus needs the Doom 64 data to be present in any of the following direc The data files are: -* `doom64ex-plus.wad` (Generated by cmake) +* `doom64ex-plus.wad` * `doom64.wad` * `doomsnd.sf2` -To generate the two latter files, acquire a Doom64 ROM and run: - - $ WadGen.exe (in the wadgen directory) and select your Doom64 ROM. - -This will generate the required files and place them in `$XDG_DATA_DIR/doom64ex-plus`. - After this you can play. $ doom64ex-plus +