Home

Welcome to the JBB Wiki! If this is your first time around here, I would recommend to start with the tutorials below. If you are more experienced you might find the other sections more interesting.

If you have any questions you can join our gitter discussion by clicking the link below:

Projects using JBB

• Audio Experiments Exhibition (Greek)

Tutorials

• Encoding & Decoding a Simple Object
• Encoding & Decoding User Objects
• Creating a Simple Source Bundle & Compiling it
• Loading the bundle from the Browser
• Using JBB with THREE.js

Examples

• THREE.js Example 1 - [ source ]
• THREE.js Example 2 - [ source ]
• Loading source and binary bundles - [ source ]

Introduction

• Introduction to JBB - What is JBB and how it can help you
• When to use JBB - When JBB can be an asset for you
• Installing JBB - How to get JBB
• Frequently Asked Questions - For your questions
• JBB file format - How JBB files are structured
• JBB Op-Codes - How JBB encodes it's primitives
• [JBB vs BSON vs MsgPack](JBB Performance) - How JBB compares to BSON and MsgPack
• JBB Benchmarks - Testing JBB performance compared to other solutions

Creating Bundles

• Creating a source bundle - Instructions how to create a .jbbsrc bundle
• bundle.json Loader Classes - All known bundle.json loader classes
• bundle.json Reference - All the parameters available for the bundle specs file
• Compiling a bundle from command-line - How to create a .jbb from command-line
• Compiling a bundle with gulp-jbb - How to integrate jbb compiler in your gulp set-up
• Compiling a bundle with the API - How to create a .jbb binary bundle using the JBB API

Loading Bundles

• Loading from a stand-alone project - How to load a bundle from a stand-alone project
• Loading from a Node.js project - How to load a bundle from a node.js project
• Loading source bundles - How to load .jbbsrc bundles

Profiles

• Introduction to Profiles - What are JBB Profiles
• Profile guidelines - How a JBB profile must be structured
• Creating a profile from scratch - How to create your own profile
• Creating a profile with gulp-jbb-profile - How to simplify the bundle creation
• List of known profiles - What profiles are currently available
• specs.yaml Reference - All the options for the profile specs file

Advanced topics

• Monitoring the loading progress - How to listen for progress events
• Including javascript classes in a bundle - How to include source code in your bundle