Univerxel

Work in progress galaxy down to atom (mostly centimeter) online voxel game

Table of Contents

• About The Project
  • Built With
• Run it
  • Prerequisites
  • Usage
• Build
  • Prerequisites
    • Optionally
  • Installation
    • Additionally
• RoadMap
• License
• Contact

About The Project

Experimental project using OpenGL and Vulkan.

Built With

• C++
• OpenGL
• Vulkan
• ImGui
• PicoQUIC
• FasNoiseSIMD
• Love and insomnia

Run it

Get a release compatible with your system window library and processor capabilities, or build it

Prerequisites

• OpenGL or Vulkan driver
• OpenSSL 1.1+

Usage

./univerxel

Edit config.toml

Profit !

Build

To get a local copy up and running, follow these simple steps.

Prerequisites

• C++17
• CMake 3.11
• System window headers (xorg-dev)
• OpenGL, Vulkan and OpenSSL headers

Optionally

• Python: utility scripts
• Tracy v0.7: profiling
• glslc: build vk shaders
• Imagemagick: build textures (convert jpg to png)
• Compressonator: build textures (compress dds)
• Doxygen: API docs
• Sphinx rtd_theme Breathe: sphinx pages

Installation

1. Clone the project repo

git lfs clone --recursive https://framagit.org/univerxel/univerxel.git

2. Create build folder and move

mkdir build && cd build

3. Build CMake

cmake <options> ..

CMake options: -DKEY=VAL

Key	Usage	Default
SIMD_LEVEL	SIMD processor acceleration (sse2, sse4.1, avx2, avx512f)	avx2
USE_FMA	Fast math	1
CMAKE_BUILD_TYPE	Level of optimization	Release
PROFILING	Tracy profiling	0
LOG_DEBUG	Debug logs	0
LOG_TRACE	Trace logs	0

1. Build Make

make -j<process count> <target>

Target	Description
univerxel	All in one
univerxel-server	Standalone server
univerxel-client	Light client
docs	Doxygen documentation
pages	Sphinx pages

Additionally

5. Recompile Vulkan shaders

cd resource/shaders-src
./compile.sh # Use glslc
GLSL="glslValidator -V" ./compile.sh # Other glslang compiler

6. Rebuild textures

cd resource/textures-src
./compile.sh # Build all texture dds
./merge.py <args> # Combine grey images to RGB

RoadMap

See Features

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Shu - /me - me@wadza.fr

Public releases - Working repo