FelipeCarlin / CubicSquareCreft

A minecraft clone in c++

Releases | Screenshots | Features | Wiki | Contributing

1. What is CubicSquareCreft

1.1. Description

CubicSquareCreft is a voxel game, focused on playability and being intuitive. The game is inspired in the popular game Minecraft.

CSC objectives are:

• Intuitiveness
• Fun-ness
• Cepibolla

1.2 How is structured

The game is in the cubicsquarecreft folder, inside is a folder with the source, data that the game uses and miscellaneous files.

2. A story through time

2.1. Context

The origin of the project comes from boredom, the need of practice and a lot of coffee.

2.2 What I want to achieve

In reality the game aims:

• Not be complete garbage
• Be a good OpenGL practice
• Have documentation for developers and end-users
• Be a practice for dealing with a mid-term project

3. Features

3.1. Implemented

Things that are no longer in the TODO list:

• None

3.2 TODO list

A list of stuff that should be worked on:

• (insert something later)

4. Building

4.1 Windows

To build the game, you will need to have Visual Studio 2019 installed.

First download the source:

git clone --recursive https://github.com/FelipeCarlin/CubicSquareCreft
cd CubicSquareCreft

Now run build.bat inside the scripts folder. After that the executable should be in a folder called build in the root folder. *Note: The files required for the game to work are in cubicsquarecreft/data, so in order to work, the win32_cubicsquarecreft.exe and cubicsquarecreft.dll files must me copied into this directory, this will be fixed in the future.

5. Details

5.1 Software

• IDE: GNU Emacs(I know, its old, but I'm trying IDEs)
• Compiler: MSVC The Microsoft C/C++ Compiler

5.2. Dependencies

Right now, the game has 0 dependencies :)

5.3 Coding convention

• Interfaces starts by I
• Abstracts starts by A
• Class names: UpperCamelCase
• Public member variables: lowerCamelCase
• Private member variables: m_lowerCamelCase
• Public static variables: UpperCamelCase
• Private static variables: _CAPS_LOCK_WITH_UNDERSCORES
• Function/Method arguments: lowerCamelCase
• Function/Method names: UpperCamelCase
• Class member variables are located on file bottom
• Comment your functions, enums, classes, methods Some coding convention could have been forget while redacting this document, so always refer to the existing code base!

6. Screenshots

There is no screenshots, yet!