README.md

CubicUniverse

A voxel game based on Minecraft, coded in C with OpenGL.
Explore the docs »

Our Project Web Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

We rebuilt some of the iconic game Minecraft.

(back to top)

Built With

• C
• OpenGL

(back to top)

Getting Started

Prerequisites

List prerequisites here

• In order to be able to compile the project, you must install the following dependencies:

  sudo apt-get install libglfw3
  sudo apt-get install libglfw3-dev
  sudo apt-get install libglew-dev
  sudo apt-get install freeglut3
  sudo apt-get install freeglut3-dev

• Moreover, regarding the unit-tests part of the project, you must install Criterion. You can get it from the github repository Criterion. This project uses Meson buildsystem to generate the executable along with Ninja, therefore you must also install the following dependencies:

  sudo apt-get install meson
  sudo apt-get install ninja

Installation

1. Go on https://lucmahoux.github.io
2. Clone the repo

   git clone https://github.com/lucmahoux/CubicUniverse.git

3. To build the project, you simply have to go to the root of the project and run :

   ./compile

   if you want to build & run the project.

   ./compile debug

   if you want to build & run the test-suite.

(back to top)

Usage

HOW TO PLAY CUBICUNIVERSE - Run it & gaze at the beauty of a skybox & some blocks :)

(back to top)