Code Monkey home page Code Monkey logo

cobalt-engine's Introduction

C/C++ CI

cobalt

A 3D general-purpose game engine for Unix distributions, being used in the game Celestine.

System Requirements

To compile and run you need the following:

  • A GPU with OpenGL 4.1 minimum support;
  • CMake 3.10 To generate the documentation, you will need a recent version of Doxygen

Download

Clone with git clone --recurse-submodules https://github.com/teoemeaesse/cobalt-engine.git to include all the depency submodules.

Installation

Before anything else, run the setup script. This will get and install all the necessary dependencies.

./setup.sh

Documentation

This project uses Doxygen to generate HTML docs. There is no hosted documentation (for now), so to generate it locally:

./build_docs.sh

Build

Use the provided build scripts to build the editor.

./build_editor.sh

Tests

You can run the provided script on your machine or use the Docker image.

sudo docker build -t cobalt-tests .
sudo docker run cobalt-tests

Compatibility

Currently compatible with Linux distributions and MacOS on ARM. There are future plans for a Windows version. Mostly untested outside of Ubuntu 23.10 and MacOS Sonoma 14.1.

Engine structure

cobalt is divided into two main parts:

  • core - Core engine library functionality, heavily dependent on GLFW for graphics.
  • engine - cobalt engine code, composed from independent modules that use the core library.
  • editor A game level editor is in development.

cobalt-engine's People

Contributors

teoemeaesse avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.