Skip to content
master
Go to file
Code

README.md

Goxel

Version 0.10.6

By Guillaume Chereau guillaume@noctua-software.com

Build Status Snap Status DebianBadge

Official webpage: https://goxel.xyz

About

You can use goxel to create voxel graphics (3D images formed of cubes). It works on Linux, BSD, Windows and macOS.

Download

The last release files can be downloaded from there.

Goxel is also available for iOS and Android.

goxel screenshot 0 Fisherman house, made with Goxel by Thibault Simar

Licence

Goxel is released under the GPL3 licence.

Features

  • 24 bits RGB colors.
  • Unlimited scene size.
  • Unlimited undo buffer.
  • Layers.
  • Marching Cube rendering.
  • Procedural rendering.
  • Export to obj, pyl, png, magica voxel, qubicle.
  • Ray tracing.

Usage

  • Left click: apply selected tool operation.
  • Middle click: rotate the view.
  • right click: pan the view.
  • Left/Right arrow: rotate the view.
  • Mouse wheel: zoom in and out.

Building

The building system uses scons. You can compile in debug with 'scons', and in release with 'scons mode=release'. On Windows, I only tried to build with msys2. The code is in C99, using some gnu extensions, so it does not compile with msvc.

Linux/BSD

Install dependencies using your package manager. On Debian/Ubuntu:

- scons
- pkg-config
- libglfw3-dev
- libgtk-3-dev

Then to build, run the command:

make release

Windows

You need to install msys2 mingw, and the following packages:

pacman -S mingw-w64-x86_64-gcc
pacman -S mingw-w64-x86_64-glfw
pacman -S mingw-w64-x86_64-libtre-git
pacman -S scons
pacman -S make

Then to build:

make release

Contributing

In order for your contribution to Goxel to be accepted, you have to sign the Goxel Contributor License Agreement (CLA). This is mostly to allow me to distribute the mobile branch goxel under a non GPL licence.

Also, please read the contributing document.

You can’t perform that action at this time.