Famous Engine

The Famous Engine is a free and open source JavaScript rendering engine. What makes the Famous Engine unique is its JavaScript rendering engine and 3D physics engine that gives developers the power and tools to build native quality apps and animations using pure JavaScript. It is designed to allow developers the ability to render to both DOM and WebGL in a unified API.

Getting Started

Boilerplate

If you have the Famous Engine included in your project, it is very easy to start getting content rendered to the screen. Below is a short example of how to get HTML content written to the screen.

var FamousEngine = require('famous/core/FamousEngine');
var DOMElement = require('famous/dom-renderables/DOMElement');

FamousEngine.init();
var scene = FamousEngine.createScene();

var node = scene.addChild();
var domEl = new DOMElement(node, {
    content: 'Hello World',
    properties: {
        fontFamily: 'Arial'
    }
});

In this example, we use the Famous Engine to kick off the rendering process and create a scene for our application. From here, we can add nodes to our scene and use components to give them the ability to draw.

Famous CLI

The Famous CLI (Command Line Interface), allows for an easy installation of the Famous seed project which will bootstrap you with a small project containing the Famous Engine. Check out the README in the famous-cli repository on Github to learn how to install and create an account with the CLI.

To get a new project, run the following commands:

famous create
famous create <seed-project-name>

From here, you can run your project to see a Famous application in action.

famous develop

Seed Project

If you are looking for an easy way to get a Famous application up and running, check out our seed project. This includes the FamousEngine, index.html file, preloaded CSS with friendly default values, and some boilerplate to get you started.

npm

The Famous Engine is also available on npm.

npm install famous

This will add the Famous Engine to your node_modules folder to be included into your project.

Contributing

Cloning this repository directly is primarily for those wishing to contribute to our codebase. Check out our contributing instructions to get involved.

Note: cloning only provides the Famo.us folder with all Famo.us code, but it does no application scaffolding. You will additionally need to create your own index.html. Currently we have a dependency on glslify, a browserify transform to compile our glsl shaders.

Documentation

Rendered versions of the source code reference documentation: docs.
Guides and tutorials: guides

Community

If you would like to report a bug, please check the issues section in our contributing instructions.
Please join us on the "famous-community" slack.
- http://slack.famous.org/signup to sign up
- http://slack.famous.org/ to log in
For contributors, read more instructions in CONTRIBUTING.md.

Licensing information

The Famous rendering engine is licensed under the MIT license
Contact licensing@famo.us for further inquiries.

michaelobriena/engine