Fibbo

Fibbo is a free and open-source web-based game engine that allows you to create interactive experiences using JavaScript, right in your browser.

It is designed to be simple to use, extensible, and flexible. You can use it to create games, simulations, visualizations, and more.

Fibbo exposes a simple object-oriented API that allows you to create and manipulate objects in a scene, both in 2D or 3D. You can add objects to the scene, move them around, rotate them, and much more.

• 🏡 Documentation
• 🧪 Test Report
• 🎮 2D Playground
• 🎮 3D Playground

Installation

See the installation guide for more information.

Tech stack

• Game stuff
  • Three.js for 3D rendering
  • Rapier for physics
  • PixiJS for 2D rendering
  • Vue for the devtools
• Tooling
  • Nx for monorepo management
  • unbuild for building the packages
  • Vite for the playgrounds + building the devtools
  • VitePress for the documentation
  • Vitest for testing
  • TypeDoc for the API Reference part of the documentation
  • ESLint for linting

Development

• Install dependencies

npm install

• To develop on the 3D package, run the 3D playground :

npm run dev:3d
# or on Windows :
npm run dev:3d:windows

You can now open your browser and navigate to http://localhost:5173/fibbo/playground-3d.

• To develop on the 2D package, run the 2D playground :

npm run dev:2d
# or on Windows :
npm run dev:2d:windows

You can now open your browser and navigate to http://localhost:5173/fibbo/playground-2d.

Documentation

The documentation is using VitePress. You can run the documentation locally by running:

npm run docs:dev

Also, the API Reference part is generated using TypeDoc. You can generate it by running:

npm run docs:generate

You can now open your browser and navigate to http://localhost:5173/fibbo.

Contributing

See the contributing guide for more information.

Credits

3D models and sprites used for development purpose are from Kenney and glTF-Sample-Assets.