README

Table of content

1. Overview
2. Built With
3. Projects using CNEngine
4. Prerequisites
5. How to build
   • Windows using MSYS
   • Windows using WSL
   • Linux
   • MacOS
6. Contributors
7. License
8. FAQ
9. Contact

Overview

This project is a complete game engine programmed in C that allow 2d rendering, 3d rendering, GUI rendering.

Higly configurable on the back technology allow the usage of multiple graphics api (via SDL surface, SDL renderer, OpenGL context, ...) and to render using CPU or GPU.

Built with

Projects using CNEngine

Name	Description	By	Website
Alice - Gunz & Arrests	Still in developement	CNStudio™	Not avaiable until end of developement of the game and the engine itself

Prerequisites

• CMake
• Make
• GCC (mingw for Windows)
• LIBC
• LIBM
• python-jinja (jinja2)

How to build

Before installing make sure you have every prerequisites installed (libm, libc are most of the time install with the mingw / gcc package).

Windows using MSYS

git clone https://github.com/Goldenapple3619/CNEngine.git && cd CNEngine
 
# if you're executing outside of MSYS (make sure binaries are exposed in $PATH):
cmd.exe /c scripts\build_windows-${ARCH}.bat
 
# or if you're inside of MSYS
sh scripts/build_windows-${ARCH}.sh

Windows using WSL

git clone https://github.com/Goldenapple3619/CNEngine.git && cd CNEngine
 
sh scripts/build_wsl-${ARCH}.sh

Linux

git clone https://github.com/Goldenapple3619/CNEngine.git && cd CNEngine
 
sh scripts/build_linux-${ARCH}.sh

MacOS

git clone https://github.com/Goldenapple3619/CNEngine.git && cd CNEngine
 
sh scripts/build_macos-${ARCH}.sh

Documentation

Code documentation available via the doxygen at https://Goldenapple3619.github.io/CNEngine or by compiling the doc with:

doxygen doc/doxygen/doxydoc

Contributors

License

See LICENSE for more information.

FAQ

• Can I use this engine to release commercial products?

  ‍No.

• Can I experiment using the engine and build personal project with it?

  ‍Yes, but credit the engine and keep the license.

• Can I read the code to inspire when building my own engine?

  ‍Yes, but don't do a copy/paste of the codebase itself.

• Can I contribute to this repo by doing a PR?

  ‍If you're reading the FAQ section, there's 99.99% of chance that the anwser is no, but you can still give suggestion / report bugs.

Contact

For more infos check our website https://cnstudio.dev and join the Discord server.