2020-07-06 19:18:29 +00:00
|
|
|
# Univerxel <!-- omit in toc -->
|
|
|
|
|
|
2020-09-22 20:37:09 +00:00
|
|
|
Work in progress galaxy down to atom (mostly centimeter) online voxel game
|
2020-07-06 19:18:29 +00:00
|
|
|
|
|
|
|
|
## Table of Contents <!-- omit in toc -->
|
|
|
|
|
|
|
|
|
|
- [About The Project](#about-the-project)
|
|
|
|
|
- [Built With](#built-with)
|
|
|
|
|
- [Getting Started](#getting-started)
|
|
|
|
|
- [Prerequisites](#prerequisites)
|
2020-09-13 09:30:48 +00:00
|
|
|
- [Build](#build)
|
2020-07-18 12:54:07 +00:00
|
|
|
- [Optionally](#optionally)
|
2020-07-06 19:18:29 +00:00
|
|
|
- [Installation](#installation)
|
|
|
|
|
- [Usage](#usage)
|
|
|
|
|
- [RoadMap](#roadmap)
|
|
|
|
|
- [License](#license)
|
|
|
|
|
- [Contact](#contact)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
|
|
|
## About The Project
|
|
|
|
|
|
2020-09-10 15:42:10 +00:00
|
|
|
Experimental project using OpenGL and Vulkan.
|
2020-07-06 19:18:29 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
### Built With
|
|
|
|
|
|
|
|
|
|
* C++
|
|
|
|
|
* OpenGL
|
2020-09-10 15:42:10 +00:00
|
|
|
* Vulkan
|
2020-07-06 19:18:29 +00:00
|
|
|
* ImGui
|
2020-09-22 20:37:09 +00:00
|
|
|
* ENet
|
2020-07-06 19:18:29 +00:00
|
|
|
* FasNoiseSIMD
|
|
|
|
|
* Love and insomnia
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- GETTING STARTED -->
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
|
|
|
|
To get a local copy up and running, follow these simple steps.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
2020-09-10 15:42:10 +00:00
|
|
|
* OpenGL or Vulkan driver
|
2020-07-06 19:18:29 +00:00
|
|
|
|
2020-09-10 15:42:10 +00:00
|
|
|
#### Build
|
|
|
|
|
|
|
|
|
|
* C++17
|
|
|
|
|
* CMake 3.11
|
2020-09-24 12:11:04 +00:00
|
|
|
* System window headers *(xorg-dev)*
|
2020-09-10 15:42:10 +00:00
|
|
|
|
2020-07-18 12:54:07 +00:00
|
|
|
#### Optionally
|
|
|
|
|
|
|
|
|
|
* Python: utility scripts
|
2020-09-13 13:12:04 +00:00
|
|
|
* Tracy v0.7: profiling
|
2020-09-26 22:05:43 +00:00
|
|
|
* glslc: compile vk shaders
|
2020-07-06 19:18:29 +00:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
1. Clone the project repo
|
|
|
|
|
```sh
|
2020-09-10 15:42:10 +00:00
|
|
|
git lfs clone --recursive https://git.wadza.fr/me/univerxel.git
|
2020-07-06 19:18:29 +00:00
|
|
|
```
|
|
|
|
|
2. Create build folder and move
|
|
|
|
|
```sh
|
|
|
|
|
mkdir build && cd build
|
|
|
|
|
```
|
|
|
|
|
3. Build CMake
|
|
|
|
|
```sh
|
|
|
|
|
cmake ..
|
|
|
|
|
```
|
|
|
|
|
4. Build Make
|
|
|
|
|
```sh
|
|
|
|
|
make
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- USAGE EXAMPLES -->
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
./univerxel
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Profit !
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ROADMAP -->
|
|
|
|
|
## RoadMap
|
|
|
|
|
|
|
|
|
|
See [Features](TODO.md)
|
|
|
|
|
|
|
|
|
|
<!-- LICENSE -->
|
|
|
|
|
## License
|
|
|
|
|
|
2020-07-25 16:45:03 +00:00
|
|
|
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
|
2020-07-06 19:18:29 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- CONTACT -->
|
|
|
|
|
## Contact
|
|
|
|
|
|
|
|
|
|
Maelys Bois - [/me](https://git.wadza.fr/me) - me@wadza.fr
|
|
|
|
|
|
2020-07-25 16:45:03 +00:00
|
|
|
Project Link: [https://git.wadza.fr/me/univerxel](https://git.wadza.fr/me/univerxel)
|
