Many documentation ressources are available online:
- API Documentation describing all public methods, interfaces, properties and events.
- JSON reference that explain how to describe your project in the json configuration file.
- Samples that demonstrates how to build your experience in the config.json file.
- Tutorials series that explain how to use some of the ForgeJS features in your project.
- Known issues and limitations.
- Frequently asqued questions.
Get the build
The latest build is avaliable online on our ForgeJS download page
ForgeJS is licensed under Apache 2.0 license.
ForgeJS has the following dependencies:
- three.js r83 (MIT license)
- hammer.js 2.0.8 (MIT license)
- omnitone 0.1.8 (Apache 2.0 license)
- dash.js 2.3.0 (BSD license)
!!! We made a custom build of three.js with some classes concatenated to it. Theses classes are included in the original three.js repository but not concatenated in the main build. We add EffectComposer, RenderPass, ClearPass, MaskPass, ShaderPass, TexturePass and CopyShader in our three.custom.min.js.
Quick Start for users
Quick Start for Developers
Here are a quick resume of differents steps you need to achieve to get ready to code! We will detail these points later.
- Clone the project from GitHub.
- Nodejs and npm installed on your machine.
- Having the grunt-cli npm package installed globaly.
- Install the node dev dependencies of the project.
Run this command to install grunt-cli globally on your machine:
npm install -g grunt-cli
Install dev dependencies
cd to the project repo folder and run the following command to install dependencies:
With all previous requirements completed, you can now run grunt tasks from the project repo folder. Here are a short list of usefull grunt tasks.
Build a non minified build of ForgeJS:
Build a minified build of ForgeJS:
Generate the documentation and the json reference:
Auto watch any changes you made in sources to auto build a non minified build of ForgeJS: