No description, website, or topics provided.
JavaScript GLSL
Latest commit 68dd034 Jul 30, 2015 @alexanderGugel alexanderGugel v0.7.1
Permalink
Failed to load latest commit information.
components fix: update breaking reference to the node's sizeMode Jul 7, 2015
core Fix: showing child components on hide in Node [#97865428] Jul 20, 2015
dist chore: update build script Jun 4, 2015
dom-renderables fix: dom-element checks for sizeMode onMount Jul 20, 2015
dom-renderers test: Add test-case for man in the middle insertion Jul 20, 2015
math fix: Make math lint and fix chainable bug May 21, 2015
physics doc: fix typos Jun 4, 2015
polyfills docs: Fix @link doc Jun 4, 2015
render-loops docs: Clean up RequestAnimationFrameLoop docs Jun 4, 2015
renderers fix: #396 Jul 20, 2015
scripts chore: update linting Jun 16, 2015
transitions Fix: Correct typos for inline documentation of Curves.js Jun 18, 2015
utilities refact: Reduce redundancy in WebGLRenderer Jul 20, 2015
webgl-geometries fixes #357 - Primitive geometry ignores options Jul 20, 2015
webgl-materials fix: rename time material uniform Jul 9, 2015
webgl-renderables fix: Send draw command upon dismount Jul 21, 2015
webgl-renderers fix: Account for empty registry values Jul 21, 2015
webgl-shaders chore: fix spacing Jun 16, 2015
.eslintrc chore: Remove ESLint rules to make tests lint May 21, 2015
.gitattributes chore: Add .gitattributes May 21, 2015
.gitignore chore: update build script Jun 4, 2015
.travis.yml chore: add lint script to .travis.yml May 21, 2015
AUTHORS.md v0.7.0 Jul 9, 2015
CHANGELOG.md v0.7.1 Jul 29, 2015
CONTRIBUTING.md chore: Fix dead link in CONTRIBUTING [Finished #95852062] Jun 4, 2015
LICENSE chore: update README and supporting doc May 20, 2015
README.md docs: remove famous CLI Jul 24, 2015
index.js fix: renderLoops path for global build May 20, 2015
package.json v0.7.1 Jul 29, 2015

README.md

Famous Engine

Build Status Dependency Status devDependency Status

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

Licensing information

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

Analytics