famous

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

We have several guides & tutorials on our site to help you get up and running with Famous, such as Hello Famous. Here's a quick boilerplate example.

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. For more, here are some deeper dives on scene graph and components.

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 [e-mail] for further inquiries.

Changelog

0.7.1

Bug Fixes

• Account for empty registry values a5d7fd552505c0f2d40c4a86aa0a61950736ff16
• Send draw command upon dismount 884f082df8453f372ff97fba53e518c91850b18e
• Correctly mount and dismount mesh 85060e458e4bbbbe515f9ac9dc0620fc43ea38fd
• showing child components on hide in Node [#97865428] 3ccd502b91dd4ba54feb82d54558a9ce9612e65e
• #396 6f8336f94eef456c87893c2387d63625ba51df9c
• dom-element checks for sizeMode onMount 28a9bbdcfb9e9d7db87a8f69f45dcfe113d1448f
• Correctly request Mesh update 46ea658aab939794ab9cb51095554c6a60a9f7fe
• Only update mesh when node is mounted 6718be9445a326030acdb7064a04d3a6571a7199
• Fix FamousEngine#addScene 3e34f91a56f5b595a5430d8a09af7453236f6141
• mounting bug 3c0004063eb08add7b01f2c93db9d61a8454cd23

Testing and Tooling

• Add test-case for man in the middle insertion 216ed5f444717c301661d92d9b41099600b68b64
• Add naive test cases for WebGLRenderer 45c9b2c3cb8a53ea3fbfd391e364660a9139d41f