This README documents whatever steps are necessary to get project up and running.
What is this repository for?
This repository is contains the latest source code, along with some other stuff like timely screenshots, of the UNDONE Engine, which is primarily another game engine, but what the engine is for might change in the future. The engine is currently only compatible with the Windows operating system, but it is designed in a way so that all system specific code is nicely abstracted away under its own little place, and to port it into other operating systems is fairly easy to do.
The engine is able to access the graphics hardware to use fully accelerated hardware.
It can load 3d models of many supported and widely used formats such as
Can load up all majorly available image formats.
Has a component based architecture which makes using the engine easy.
A customized memory management module.
How do I get set up?
To set up the project, it is prefered that you fork it and check for the following dependancies:
- The Open Asset Import Library (AssImp).
- FreeImage library.
- FreeType library.
- The GL Extention Wrangler (GLEW)
- The GL Maths library headers (GLM)
The source code does not have a MakeFile or any project generation in it. It only has a Visual Studio Project file.
###How To Contribute### In case you have something to contribute to the functionality of UNDONE, I would be more than pleased to know
There are several ways you can contribute to this repository. Any way you choose, you want to be making a fork of this repo and making changs there, and then sending me a pull request when done to get your contribution accepted and done on the source code.
Make Bug Fixes
- You can check the Issues page on the repository and serach for the Issues taged Bug to find known bugs in the engine.
Help Make New Features
- You can check the Issues Page regularly for new proposed features, and impliment them on your fork, and after complete testing, create a pull request.
Propose new features
Alternatively, if you have an idea but don't know how to impliment it, you can just create a new issue or let me know through an email.
You can similarly use the Issues page to notify of any undiscovered bugs. Please Tag that issue as a bug when you do so.
Credit for Contribution
PLEASE READ THE ACCOMPANIED LICENSE PLACED IN THE REPOSITORY WITH THE CODE
Who do I talk to?
- Repo owner or admin : Anurup Dey
- E-mail: email@example.com