vengi/README.md

34 lines
1.4 KiB
Markdown
Raw Normal View History

2019-09-15 11:19:57 -07:00
[![Actions Status](https://github.com/mgerhardy/engine/workflows/build/badge.svg)](https://github.com/mgerhardy/engine/actions)
2019-10-31 04:07:07 -07:00
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2016-07-12 11:14:51 -07:00
2015-10-15 12:54:01 -07:00
# About
2019-03-09 00:58:15 -08:00
Voxel engine and tools.
2019-09-15 08:42:38 -07:00
# Contact
- [Discord Server](https://discord.gg/AgjCPXy)
2019-03-09 00:58:15 -08:00
# Tools
* [The voxel editor](src/tools/voxedit/README.md)
2019-09-27 00:11:42 -07:00
* [World viewer](src/tools/mapview/README.md)
2019-03-09 00:58:15 -08:00
* [Remote AI Debugger](src/tools/rcon/README.md)
* [Database tool](src/tools/databasetool/README.md)
* [Shader tool](src/tools/shadertool/README.md)
* [Compute Shader tool](src/tools/computeshadertool/README.md)
* [Traze client](src/tests/testtraze/README.md)
# General
* [Dependencies](docs/Dependencies.md)
* [Compilation](docs/Compilation.md)
* [Setup](docs/Setup.md)
2019-11-15 10:23:34 -08:00
* [GameDesign](docs/GameDesign.md)
2016-05-05 13:06:53 -07:00
2017-10-05 04:20:50 -07:00
# Running the tests
The tests need a postgres database named `engine` and a user named `engine` with the password.... `engine` (you can modify them via cvars). If no OpenGL or OpenCL context is available, the related tests are skipped.
2019-10-28 10:15:56 -07:00
You can use the docker-compose files to set up your environment.
2017-10-05 04:20:50 -07:00
2016-05-05 13:06:53 -07:00
# More information
2016-08-29 11:08:32 -07:00
For more information, please check out the [wiki](https://gitlab.com/mgerhardy/engine/wikis/home) or the [doxygen](https://mgerhardy.gitlab.io/engine/) documentation.
You can find some old and most likely outdated videos in my [youtube channel](https://www.youtube.com/channel/UCbnJUW0d4tYvdmsJ-R6iUpA).