Miata Engine is a modernized version of the id Tech 2
(formerly Quake/Quake2)
engine with merged NQ/QW/Q2 codebase (the way it actually should have always been)
The engine is (will be) able to run both Quake and Quake 2 using either QC progs code or a game (dll) module. It provides all the features original engines does in addition to
upgraded code which was (is currently being) ported to Modern C++ and OOP architecture (along with tools code).
It might end up supporting some additional features but that's currently not in a high priority
The primary reason of modernizing the codebase is mostly for fun. Another reason is to let future generations use the engine in their learning process. The original code is more than 20 years old at this stage (2019) and is a subject to software rot which makes it more and more harder to maintain over time. There are lot of other forks out there that supports alot more features than this one, but the two distinct directions of this specific one are to upgrade the code to modern standards and keep its original features. There will be a bunch of notable changes though mostly related to modern games requirements and reduce of maintenance cost achieved by using benefits of software modularity
The codebase will require a compiler with C++17 (or higher) standard support so make sure that the compiler type you're using does support it. Additionaly, you might need a Quake/Quake 2 game distribution in order to (play)test the engine. You can aquire them either from Steam or download their shareware versions
The primary building system of the repo is CMake so you'll feel youself comfortable if you familiar with it. It is advised to use its GUI application to configure/customize the build if you need to
The supported compilers are (will be) the latest versions of Visual Studio (Build Tools), GCC/MinGW and Clang. Some older versions should work too but there's no guarantee of that and you should check for yourself
Feel free to contribute to the project if you like. It definitely will be appreciated. Make sure to use a branch with latest available changes (dev or master) and base your work above it by creating your own branch with a name that reflects the type of changes you're about to make ("feature", "bugfix", "hotfix", etc)