Minimal example of using voxel-engine-stackgl
Learn more at http://voxeljs.com
The first time you set up, you should install the required npm packages:
cd voxel-example
npm install
Then run the start script:
npm start
Then point your browser to http://localhost:8081 and have fun!
voxel-example loads two plugins into the engine: voxel-bedrock to register a block, and voxel-flatland to generate flat terrain voxel chunks configured to solely consist of this block. The built-in camera plugin is configured to start the player above the terrain.
For more advanced plugins, see https://github.com/voxel or search npm.
voxel.js modules use browserify for packaging modules together into game bundles. This means that every time you change code in your game you have to build a new bundle in order to test it out. Luckily this is very easy and is automated. When you run the npm start
script, it runs a local server: when the browser requests index.js
, it compiles it serverside and then serves up the compiled version.
The upshot is, as long as you're running the npm start
script in the background, you can save your changes to index.js and reload the game to see the new code in action, without having to have a build step in between. (If you'd like to change the start script, it's contained in the package.json
file in the root directory.)
voxel-example was originally based voxel-hello-world (for the three.js-based voxel-engine), ported to use voxel-engine-stackgl (built on stackgl/ndarray scijs, for more background see voxel/issues#4). It is now a simple yet complete working example of using voxel-engine-stackgl.
For a more sophisticated exeample, see https://github.com/deathcap/voxelmetaverse/.
BSD