Skip to content
WebGL-based voxel viewer and editor
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
coffee
test IO refactor: changes constructor signatures Mar 13, 2016
.codeclimate.yml lint: lint js and css on code climate + add codify badge Feb 9, 2016
.gitattributes added .gitattributes Jan 20, 2016
.gitignore travis: deploy beta build to Github Pages Mar 9, 2016
.travis.yml travis: deploy beta build to Github Pages Mar 9, 2016
LICENSE.txt
README.md Update README.md Jun 8, 2018
appveyor.yml test: fix test on windows Feb 5, 2016
coffeelint.json implement npm start: dev-server using serve module Feb 4, 2016
index.jade Main: use TLS for Trovesaurus shorturl (fixes mixed content error) May 15, 2016
jspm.browser.js migrate to use jspm and system.js Feb 4, 2016
jspm.config.js IO refactor: changes constructor signatures Mar 13, 2016
package.json Update package.json Oct 8, 2018
troxel.js jspm: explicitly specify coffee loader + remove require workaround Mar 11, 2016

README.md

Troxel Travis Build Status (Linux) AppVeyor Build status (Windows) Code Climate devDependency Status Codacy Badge JS.ORG

Troxel is a WebGL-based HTML5-WebApp for viewing and editing voxel models with some additional support for Trove specific features. Visit troxel.js.org to try it out! You can embed Troxel in your own website too with libTroxel.

Features

  • Supported file formats for both import and export
    • Qubicle (.qb): fully supported (multi matrix, compression ...)
    • Magica Voxel (.vox)
    • Zoxel (.zox)
    • Base64 (links): Troxel's own compressed file format for sharing models via links
    • JSON: raw data output
    • some additions for material maps (multi-layer voxel data) used by Trove
  • WebGL-based 3D-Renderer
    • basic support for all material maps
  • Editor
    • simple add and remove voxel functionality
    • rotate, mirror, move and resize voxel model
    • filltool with color noise

How to use

Dependencies:

  • Node.js 4+
  • for hosting static page locally (optionally): ruby with github-pages gem (gem install github-pages)

Installing

git clone git@github.com:chrmoritz/Troxel.git
cd troxel
npm install

Running dev server

npm start

Then open: http://localhost:3000/index.jade

This server will automatically recompile resources after editing them. You only need to reload you page to see your edits live.

Running tests

npm test

Please run this test suite before opening a pull request.

Building a static page

npm run build

The static page will be generated into the dist folder.

Serving the static page via jekyll

npm run serve

The static page will be served by Jekyll (like on GitHub Pages) and grunt will watch for source file changes and automatically recompile these changes and update Jekyll.

Note: You need the github-pages gem installed (gem install github-pages) for this.

Importing Trove's blueprints

Check out troxeljs/trove-blueprints for more information about how to import blueprints.

libTroxel

LibTroxel is a JavaScript library which allows you to embedd voxel models rendered with Troxel into your own website. The project lives now in its own subproject at troxeljs/libtroxel.

You can’t perform that action at this time.