README
¶
openvoxel
This project is a work in progress!
openvoxel is an open source voxel game engine.
Experimental demo available here:
- Browser version, with WebGL 2.0
- Windows (64 bits) version, with OpenGL 3.3
- Linux (64 bits) version, with OpenGL 3.3
Development Setup
To start developing, you can use the helper scripts in the scripts/ folder.
You must have already a working Go installation, we tested on Go 1.18 and
newer and be using either Debian/Ubuntu or a debian-based docker container.
After checking out the repository, you can then execute:
export OPENVOXEL_ARCHS=amd64
./scripts/cross-setup.sh
This will install all the OpenGL dependencies for you. To get started testing,
use the go build or go run commands, like:
cd exp/cmd/helloworld
go run main.go
To speed up the testing cycle, run go install once so you can benefit from
cached packages built with CGO:
cd exp/cmd/helloworld
go install
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
webglrun
The `webglrun` command provides a simple tool to rebuild wasm programs using the scripts/make.sh build helper.
|
The `webglrun` command provides a simple tool to rebuild wasm programs using the scripts/make.sh build helper. |
|
exp
|
|
|
cmd/helloworld
This is a simple demonstration of the basic functionality of the Openvoxel Engine.
|
This is a simple demonstration of the basic functionality of the Openvoxel Engine. |
|
package log provides a simple logging facility
|
package log provides a simple logging facility |
|
package render implements OpenGL rendering logic and wrappers.
|
package render implements OpenGL rendering logic and wrappers. |
|
package transform implements several transformations using vectors and matrices.
|
package transform implements several transformations using vectors and matrices. |
Click to show internal directories.
Click to hide internal directories.