diff --git a/index.html b/index.html index e66c930..cdeb927 100644 --- a/index.html +++ b/index.html @@ -2,199 +2,204 @@ - + + + + - - - voxel.js * blocks in yo browser - - - - - - + + + voxel.js * blocks in yo browser + + + + + + + - -
-
-
-
voxel.js
- -

an open source voxel game building toolkit for modern web browsers

- - - - -
-
- -
- -

About

-

voxel.js is a collection of projects that make it easier than ever to - create 3D voxel games like Minecraft all in the browser.

-

It was written by @maxogden and @substack, two non-game developers that want to make voxel games easy, fun and modular, but is now collectively maintained by nearly 100 contributors.

- -

Watch

-

Here is a presentation from May 2013 that covers all the exciting stuff that happened in voxel.js land up to that point.

-

Also definitely read this great blog post about Voxel.js in 2014 by @deathcap

-

Contribute

-

All of the code is open source! If you find bugs or have ideas for improvements please open issues for them on the related github project, or better yet send code or write new modules. - -

- - - -
-

Components

-

Instead of making a giant game framework we instead decided to split voxel.js - up into a bunch of small building blocks (modules). Modules can be installed - with npm, the package manager from node.js. - Here are some modules that we have already started working on:

- -

The Core

- -

Add-ons

-
-

There are around 200 addons for voxel.js published on NPM, here are live search results for all the modules on NPM with word 'voxel' in the title/description:

- -
- -
- -
-

Tools & Utilities

- -
- Voxel Builder -
voxel object/creature editor that runs in your browser and lets you save/export/share your creation
-
-
- -
-

Making your first game

-

Making a game from the command line

-

Here is a handy video screencast from @shamakry that will teach you how to get started in under 10 minutes:

- -

If you don't wanna watch a video you can follow these instructions instead:

-

To use the voxel.js modules you will need to install node.js (which - will also install npm) and be able to use your computer's command line.

-

Once node.js is installed, you can install the basic voxel.js npm package in your project directory, and then install a basic texture pack. Make a file called package.json in your project directory and give it these contents:

-
+    
+    
+ + +
+ +

About

+

voxel.js is a collection of projects that make it easier than ever to + create 3D voxel games like Minecraft all in the browser.

+

It was written by @maxogden and @substack, two non-game developers that want to make voxel games easy, fun and modular, but is now collectively maintained by nearly 100 contributors.

+ +

Watch

+

Here is a presentation from May 2013 that covers all the exciting stuff that happened in voxel.js land up to that point.

+

Also definitely read this great blog post about Voxel.js in 2014 by @deathcap

+

Contribute

+

All of the code is open source! If you find bugs or have ideas for improvements please open issues for them on the related github project, or better yet send code or write new modules. + +

+ + + +
+

Components

+

Instead of making a giant game framework we instead decided to split voxel.js + up into a bunch of small building blocks (modules). Modules can be installed + with npm, the package manager from node.js. + Here are some modules that we have already started working on:

+ +

The Core

+
    +
  • voxel-engine +
  • this is the main module for building voxel games - you can plug any voxel module into the engine. read the readme for a great overview of what is possible with voxel.js
  • + +
+

Add-ons

+
+

There are around 200 addons for voxel.js published on NPM, here are live search results for all the modules on NPM with word 'voxel' in the title/description:

+ +
+ +
+ +
+

Tools & Utilities

+ +
+ Voxel Builder +
voxel object/creature editor that runs in your browser and lets you save/export/share your creation
+
+
+ +
+

Making your first game

+

Making a game from the command line

+

Here is a handy video screencast from @shamakry that will teach you how to get started in under 10 minutes:

+ +

If you don't wanna watch a video you can follow these instructions instead:

+

To use the voxel.js modules you will need to install node.js (which + will also install npm) and be able to use your computer's command line.

+

Once node.js is installed, you can install the basic voxel.js npm package in your project directory, and then install a basic texture pack. Make a file called package.json in your project directory and give it these contents:

+
       
 {
   "name": "mygamename",
@@ -204,241 +209,240 @@ 

Making a game from the command line

} }
-

Now you can tell node to install your dependencies:

-
+            

Now you can tell node to install your dependencies:

+
       
 $ npm install
     
-

Next, create mygame.js and put the following code in it:

-
+            

Next, create mygame.js and put the following code in it:

+
       
 var createGame = require('voxel-hello-world')
 var game = createGame()
     
-

Then to build your game you use browserify:

-
+            

Then to build your game you use browserify:

+
       
 $ npm install browserify -g
 $ browserify mygame.js -o builtgame.js
     
-

Load builtgame.js into a web page:

-
<!doctype html>
+            

Load builtgame.js into a web page:

+
<!doctype html>
 <html>
   <body>
     <script src="builtgame.js"></script>
   </body>
 </html>
-

Now you should be able to play your game by opening up index.html in your browser.

-

There are API docs in the voxel-engine readme

-
-
-

Get Involved

-

Here are some ways to learn and/or get involved with voxel.js:

-

- Resources

-
+
+

Get Involved

+

Here are some ways to learn and/or get involved with voxel.js:

+

+ Resources

+ -

- Repositories you can hack on

+ + +

+ Repositories you can hack on

-
-
-

Fan Art

-

Here are some of the wonderful things users have made with their voxel worlds. Tweet @voxeljs or email max@maxogden.com your photo to submit your art!

-
- - by @jllord -
- -
- - voxeljs logos, BSD licensed by @jllord -
-
- -
- + +
  • Voxel walk animation: https://github.com/flyswatter/voxel-walk + +
  • +
  • Load a minecraft world: https://github.com/maxogden/mca2js + +
  • +
  • Minecraft items: https://github.com/maxogden/minecraft-blockinfo + +
  • +
  • Store voxel worlds in IndexedDB: https://github.com/maxogden/voxel-level + +
  • +
  • Voxel virus (with a minimal voxel water demo): https://github.com/shama/voxel-virus + +
  • +
  • Voxel 3D bulk selections: https://github.com/maxogden/voxel-select + +
  • +
  • https://github.com/maxogden/gifblocks +
  • +
  • Voxel GIF animation studio: https://github.com/maxogden/gifblocks + +
  • +
  • Implement a voxel monster loader for: https://github.com/maxogden/voxel-mobs + +
  • +
  • 3D City Loader: https://github.com/maxogden/voxel-city + +
  • +
  • Player physics and movement (needs some tweaking): https://github.com/maxogden/voxel-physical, + https://github.com/maxogden/kb-controls, https://github.com/maxogden/voxel-player and + https://github.com/chrisdickinson/voxel-control/blob/master/index.js +
  • +
  • Voxel drone: https://github.com/shama/voxel-drone + +
  • +
  • Voxel script gun: https://github.com/maxogden/voxel-script-gun + +
  • +
  • Mobile/touch controls: https://github.com/voxel/issues/issues/2 + +
  • +
  • Voxel world function: https://github.com/maxogden/voxel-world-function + +
  • +
  • Real Voxel Physics: https://github.com/timoxley/voxel-real-physics + +
  • +
  • Minecraft Multiplayer Bot Visualizer: https://github.com/vogonistic/mineflayer-voxel + +
  • +
  • Voxel color post processors: http://hughsk.github.io/voxel-colorist/demo/ + +
  • +
  • Day/Night/Moon cycles: https://github.com/shama/voxel-sky + +
  • +
  • Portal Gun: https://github.com/shama/voxel-portal-gun + +
  • + +

    + New Project Ideas

    + + +

    + For more modules check out these voxel.js contributors on NPM

    + + +

    More!

    +

    The 0fps blog posts on voxel meshing by @mikolalysenko are the reason voxel.js exists. Highly recommended reading! Definitely check out the meshing toolbox.

    +

    mr. doob and three.js are what voxel.js is built on top of.

    +

    webgl-meincraft is a great tech demo that showed a lot of this can be done in a browser

    +

    Jonas Wagner made a killer demo and gave a great talk about Voxel Worlds on the web that helped to inspire this project.

    + +
    +
    +

    Fan Art

    +

    Here are some of the wonderful things users have made with their voxel worlds. Tweet @voxeljs or email max@maxogden.com your photo to submit your art!

    +
    + + by @jllord +
    + +
    + + voxeljs logos, BSD licensed by @jllord +
    +
    + +
    + +