diff --git a/README.md b/README.md index 05d46d2..92258bc 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,31 @@ #reflex2q3 -Converts Reflex maps, both version 6 and 8, into id Tech's .map format. +Converts Reflex maps (Version 8 and below) into id Tech map files. A pre-compiled [Windows executable](https://u.teknik.io/eOmo5.zip) is available. -####Requires +####Build Requirements * [Eigen 3, C++ template library](http://eigen.tuxfamily.org/index.php?title=Main_Page) ####Building: +```bash git submodule update --init --recursive - cd ReflexToQ3 make +``` -####Minimum to convert map (geometry only): +####Convert map geometry: +```bash ./reflex2q3 [input].map [output].map +``` -####View complete list of arguments: +####Convert map geometry and entities: +```bash + ./reflex2q3 [input].map [output].map -e [entity file].ent +``` + +We've provided Quake 3 and Xonotic entity conversion files (r2q3.ent and r2xonotic.ent). To create entity files for other games built on the [id Tech 3](https://en.wikipedia.org/wiki/Id_Tech_3) engine or previous [id Tech](https://en.wikipedia.org/wiki/Id_Tech) engines, refer to our [Reflex entity documentation](https://git.teknik.io/scuti/reflex2q3/src/f2b0341da38b82ad4f0a0cf258b0f6e6d8335fda/docs/doc-entities.txt), our sample .ent files, and relevant documentation for your game. + +####List all command line arguments: +```bash ./reflex2q3 --help +``` ####Compiler(s) * mingw-w64, GCC 5.3.0