Code Monkey home page Code Monkey logo

noa-examples's Introduction

noa-examples

Two small example worlds built on the noa voxel engine.

Live demos:

  • hello-world - a bare minimum world, suitable for building on top of
  • test - a testbed world that minimally implements most engine features

Usage

To build and serve the examples locally:

(clone this repo)
cd noa-examples
npm install
npm start     # runs /src/hello-world
npm test      # runs /src/test

The start and test scripts serve each world via webpack-dev-server, so you should be able to find them at localhost:8080 or thereabouts.

There's also a build script to generate bundles into the docs directories.


Dependency / build notes

Babylon dependency:

Noa uses Babylon.js as its 3D engine, but references it as a peer dependency (so that game worlds can specify their Babylon version/modules). This means game worlds should declare a dependency on @babylonjs/core or similar, rather than loading in a prebuilt babylon script.

noa dependency:

The noa engine is under active development, so this module declares its dependency directly on the source repo's develop branch (github:andyhall/noa#develop), so as to pull in the latest bleeding-edge build. If you want to hack on something stable you may want to change the dependency to noa-engine (to get the current stable build from npm), or a specific noa version/commit/etc.

When hacking on the engine:

If you want to hack on both the engine and a game world side-by-side, just clone the noa repo next to your game client then import it directly:

import Engine from '../../noa' // or wherever

This is preferable to editing your client's package.json or using npm link, as npm behaves weirdly when trying to resolve peer dependencies via path references or symlinks.


Credits

Made by @fenomas, license is ISC.

noa-examples's People

Contributors

fenomas avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.