# Fibbo

> Fibbo is a web-based game engine, built on top of Three.js, Rapier and PixiJS. It offers a unified object-oriented API and modern web-like DX in the context of making games.

## Table of Contents

### Getting Started

- [Installation](https://fibbo.dev/getting-started/installation.md)
- [Introduction](https://fibbo.dev/getting-started/introduction.md)

### Guide

- [Fundamentals](https://fibbo.dev/guide/fundamentals.md)

#### Core

- [Assets](https://fibbo.dev/guide/core/assets.md)
- [Cameras](https://fibbo.dev/guide/core/cameras.md)
- [Components](https://fibbo.dev/guide/core/components.md)
- [Controllers](https://fibbo.dev/guide/core/controllers.md)
- [Lights](https://fibbo.dev/guide/core/lights.md)
- [Scene](https://fibbo.dev/guide/core/scene.md)
- [Transforms](https://fibbo.dev/guide/core/transforms.md)

#### 2D

- [Container](https://fibbo.dev/guide/2d/container.md)
- [Polygons](https://fibbo.dev/guide/2d/polygons.md)
- [Sprites](https://fibbo.dev/guide/2d/sprites.md)

#### 3D

- [Mesh](https://fibbo.dev/guide/3d/mesh.md)
- [Models](https://fibbo.dev/guide/3d/models.md)
- [Polyhedrons](https://fibbo.dev/guide/3d/polyhedrons.md)

#### Physics

- [Colliders](https://fibbo.dev/guide/physics/colliders.md)
- [Introduction](https://fibbo.dev/guide/physics/introduction.md)
- [Joints](https://fibbo.dev/guide/physics/joints.md)
- [RigidBody](https://fibbo.dev/guide/physics/rigidbody.md)

#### Events

- [Collisions](https://fibbo.dev/guide/events/collisions.md)
- [Keyboard](https://fibbo.dev/guide/events/keyboard.md)

#### Audio

- [Audio](https://fibbo.dev/guide/audio/introduction.md)

### More

- [Contributing](https://fibbo.dev/more/contributing.md)
- [Deployment](https://fibbo.dev/more/deployment.md)
- [Devtools](https://fibbo.dev/more/devtools.md)
- [Extending Fibbo](https://fibbo.dev/more/extending-fibbo.md)

#### Recipes

- [Character controller](https://fibbo.dev/more/recipes/character-controller.md)

### API Reference

#### 2d

##### Camera

- [Class: `abstract` FCamera](https://fibbo.dev/api/2d/classes/FCamera.md)
- [Class: FAttachedCamera](https://fibbo.dev/api/2d/classes/FAttachedCamera.md)
- [Class: FFixedCamera](https://fibbo.dev/api/2d/classes/FFixedCamera.md)
- [Class: FFreeCamera](https://fibbo.dev/api/2d/classes/FFreeCamera.md)

##### Controller

- [Class: `abstract` FCharacterController](https://fibbo.dev/api/2d/classes/FCharacterController.md)
- [Class: `abstract` FCharacterControllerK](https://fibbo.dev/api/2d/classes/FCharacterControllerK.md)
- [Class: FCharacterControllerD](https://fibbo.dev/api/2d/classes/FCharacterControllerD.md)
- [Class: FCharacterControllerKP](https://fibbo.dev/api/2d/classes/FCharacterControllerKP.md)
- [Class: FCharacterControllerKV](https://fibbo.dev/api/2d/classes/FCharacterControllerKV.md)

##### Core

- [Class: `abstract` FComponent](https://fibbo.dev/api/2d/classes/FComponent.md)
- [Class: FCollider](https://fibbo.dev/api/2d/classes/FCollider.md)
- [Class: FComponentEmpty](https://fibbo.dev/api/2d/classes/FComponentEmpty.md)
- [Class: FRigidBody](https://fibbo.dev/api/2d/classes/FRigidBody.md)
- [Class: FScene](https://fibbo.dev/api/2d/classes/FScene.md)
- [Class: FTransform](https://fibbo.dev/api/2d/classes/FTransform.md)

##### Light

- [Class: `abstract` FLight](https://fibbo.dev/api/2d/classes/FLight.md)

##### Polygons

- [Class: `abstract` FPolygon](https://fibbo.dev/api/2d/classes/FPolygon.md)
- [Class: FCircle](https://fibbo.dev/api/2d/classes/FCircle.md)
- [Class: FRectangle](https://fibbo.dev/api/2d/classes/FRectangle.md)

##### Sprite

- [Class: FSprite](https://fibbo.dev/api/2d/classes/FSprite.md)

##### Enumerations

- [Enumeration: FRigidBodyType](https://fibbo.dev/api/2d/enumerations/FRigidBodyType.md)
- [Enumeration: FShapes](https://fibbo.dev/api/2d/enumerations/FShapes.md)

##### Interfaces

- [Interface: FAttachedCameraOptions](https://fibbo.dev/api/2d/interfaces/FAttachedCameraOptions.md)
- [Interface: FCameraOptions](https://fibbo.dev/api/2d/interfaces/FCameraOptions.md)
- [Interface: FCharacterControllerOptions](https://fibbo.dev/api/2d/interfaces/FCharacterControllerOptions.md)
- [Interface: FColliderOptions](https://fibbo.dev/api/2d/interfaces/FColliderOptions.md)
- [Interface: FComponentOptions](https://fibbo.dev/api/2d/interfaces/FComponentOptions.md)
- [Interface: FControllerOptions](https://fibbo.dev/api/2d/interfaces/FControllerOptions.md)
- [Interface: FLightOptions](https://fibbo.dev/api/2d/interfaces/FLightOptions.md)
- [Interface: FPolygonOptions](https://fibbo.dev/api/2d/interfaces/FPolygonOptions.md)
- [Interface: FRigidBodyOptions](https://fibbo.dev/api/2d/interfaces/FRigidBodyOptions.md)
- [Interface: FSceneOptions](https://fibbo.dev/api/2d/interfaces/FSceneOptions.md)
- [Interface: FSpriteOptions](https://fibbo.dev/api/2d/interfaces/FSpriteOptions.md)
- [Interface: FTransformOptions](https://fibbo.dev/api/2d/interfaces/FTransformOptions.md)
- [Interface: GradientStep](https://fibbo.dev/api/2d/interfaces/GradientStep.md)

#### 3d

##### Camera

- [Class: `abstract` FCamera](https://fibbo.dev/api/3d/classes/FCamera.md)
- [Class: FAttachedCamera](https://fibbo.dev/api/3d/classes/FAttachedCamera.md)
- [Class: FFixedCamera](https://fibbo.dev/api/3d/classes/FFixedCamera.md)
- [Class: FGameCamera](https://fibbo.dev/api/3d/classes/FGameCamera.md)
- [Class: FOrbitCamera](https://fibbo.dev/api/3d/classes/FOrbitCamera.md)
- [Class: FPointerLockCamera](https://fibbo.dev/api/3d/classes/FPointerLockCamera.md)

##### Controller

- [Class: `abstract` FCharacterController](https://fibbo.dev/api/3d/classes/FCharacterController.md)
- [Class: `abstract` FCharacterControllerK](https://fibbo.dev/api/3d/classes/FCharacterControllerK.md)
- [Class: FCharacterControllerD](https://fibbo.dev/api/3d/classes/FCharacterControllerD.md)
- [Class: FCharacterControllerKP](https://fibbo.dev/api/3d/classes/FCharacterControllerKP.md)
- [Class: FCharacterControllerKV](https://fibbo.dev/api/3d/classes/FCharacterControllerKV.md)

##### Core

- [Class: `abstract` FComponent](https://fibbo.dev/api/3d/classes/FComponent.md)
- [Class: FCollider](https://fibbo.dev/api/3d/classes/FCollider.md)
- [Class: FComponentEmpty](https://fibbo.dev/api/3d/classes/FComponentEmpty.md)
- [Class: FRigidBody](https://fibbo.dev/api/3d/classes/FRigidBody.md)
- [Class: FScene](https://fibbo.dev/api/3d/classes/FScene.md)
- [Class: FSensor](https://fibbo.dev/api/3d/classes/FSensor.md)
- [Class: FTransform](https://fibbo.dev/api/3d/classes/FTransform.md)

##### Light

- [Class: `abstract` FLight](https://fibbo.dev/api/3d/classes/FLight.md)
- [Class: FAmbientLight](https://fibbo.dev/api/3d/classes/FAmbientLight.md)
- [Class: FDirectionalLight](https://fibbo.dev/api/3d/classes/FDirectionalLight.md)
- [Class: FHemisphereLight](https://fibbo.dev/api/3d/classes/FHemisphereLight.md)
- [Class: FLightProbe](https://fibbo.dev/api/3d/classes/FLightProbe.md)
- [Class: FPointLight](https://fibbo.dev/api/3d/classes/FPointLight.md)
- [Class: FSpotLight](https://fibbo.dev/api/3d/classes/FSpotLight.md)

##### Model

- [Class: `abstract` FModel](https://fibbo.dev/api/3d/classes/FModel.md)
- [Class: FFBX](https://fibbo.dev/api/3d/classes/FFBX.md)
- [Class: FGLB](https://fibbo.dev/api/3d/classes/FGLB.md)
- [Class: FGLTF](https://fibbo.dev/api/3d/classes/FGLTF.md)
- [Class: FOBJ](https://fibbo.dev/api/3d/classes/FOBJ.md)

##### Polyhedrons

- [Class: `abstract` FPolyhedron](https://fibbo.dev/api/3d/classes/FPolyhedron.md)
- [Class: FCapsule](https://fibbo.dev/api/3d/classes/FCapsule.md)
- [Class: FCuboid](https://fibbo.dev/api/3d/classes/FCuboid.md)
- [Class: FSphere](https://fibbo.dev/api/3d/classes/FSphere.md)

##### Enumerations

- [Enumeration: FRigidBodyType](https://fibbo.dev/api/3d/enumerations/FRigidBodyType.md)
- [Enumeration: FShapes](https://fibbo.dev/api/3d/enumerations/FShapes.md)

##### Interfaces

- [Interface: FAttachedCameraOptions](https://fibbo.dev/api/3d/interfaces/FAttachedCameraOptions.md)
- [Interface: FCameraOptions](https://fibbo.dev/api/3d/interfaces/FCameraOptions.md)
- [Interface: FCharacterControllerOptions](https://fibbo.dev/api/3d/interfaces/FCharacterControllerOptions.md)
- [Interface: FColliderOptions](https://fibbo.dev/api/3d/interfaces/FColliderOptions.md)
- [Interface: FComponentOptions](https://fibbo.dev/api/3d/interfaces/FComponentOptions.md)
- [Interface: FControllerOptions](https://fibbo.dev/api/3d/interfaces/FControllerOptions.md)
- [Interface: FHemisphereLightOptions](https://fibbo.dev/api/3d/interfaces/FHemisphereLightOptions.md)
- [Interface: FLightOptions](https://fibbo.dev/api/3d/interfaces/FLightOptions.md)
- [Interface: FLightProbeOptions](https://fibbo.dev/api/3d/interfaces/FLightProbeOptions.md)
- [Interface: FModelOptions](https://fibbo.dev/api/3d/interfaces/FModelOptions.md)
- [Interface: FPolyhedronOptions](https://fibbo.dev/api/3d/interfaces/FPolyhedronOptions.md)
- [Interface: FRigidBodyOptions](https://fibbo.dev/api/3d/interfaces/FRigidBodyOptions.md)
- [Interface: FSceneOptions](https://fibbo.dev/api/3d/interfaces/FSceneOptions.md)
- [Interface: FSpotLightOptions](https://fibbo.dev/api/3d/interfaces/FSpotLightOptions.md)
- [Interface: FTransformOptions](https://fibbo.dev/api/3d/interfaces/FTransformOptions.md)

#### core

##### Core

- [Class: `abstract` FCamera](https://fibbo.dev/api/core/classes/FCamera.md)
- [Class: `abstract` FComponent](https://fibbo.dev/api/core/classes/FComponent.md)
- [Class: `abstract` FController](https://fibbo.dev/api/core/classes/FController.md)
- [Class: `abstract` FLight](https://fibbo.dev/api/core/classes/FLight.md)
- [Class: `abstract` FScene](https://fibbo.dev/api/core/classes/FScene.md)
- [Class: ~~`abstract` FGroup~~](https://fibbo.dev/api/core/classes/FGroup.md)
- [Class: PipelineManager](https://fibbo.dev/api/core/classes/PipelineManager.md)

##### Pipeline

- [Class: `abstract` IntervalPipeline](https://fibbo.dev/api/core/classes/IntervalPipeline.md)
- [Class: `abstract` Pipeline](https://fibbo.dev/api/core/classes/Pipeline.md)
- [Class: `abstract` StandardPipeline](https://fibbo.dev/api/core/classes/StandardPipeline.md)
- [Class: `abstract` ThrottledPipeline](https://fibbo.dev/api/core/classes/ThrottledPipeline.md)

##### Enumerations

- [Enumeration: PipelineCommands](https://fibbo.dev/api/core/enumerations/PipelineCommands.md)
- [Enumeration: PipelineState](https://fibbo.dev/api/core/enumerations/PipelineState.md)

##### Interfaces

- [Interface: FCameraOptions](https://fibbo.dev/api/core/interfaces/FCameraOptions.md)
- [Interface: FComponentOptions](https://fibbo.dev/api/core/interfaces/FComponentOptions.md)
- [Interface: FControllerOptions](https://fibbo.dev/api/core/interfaces/FControllerOptions.md)
- [Interface: FLightOptions](https://fibbo.dev/api/core/interfaces/FLightOptions.md)
- [Interface: FSceneOptions](https://fibbo.dev/api/core/interfaces/FSceneOptions.md)
- [Interface: FVector2](https://fibbo.dev/api/core/interfaces/FVector2.md)
- [Interface: FVector3](https://fibbo.dev/api/core/interfaces/FVector3.md)
- [Interface: FVector4](https://fibbo.dev/api/core/interfaces/FVector4.md)
- [Interface: OnCollisionWithData](https://fibbo.dev/api/core/interfaces/OnCollisionWithData.md)
- [Interface: PipelineManagerOptions](https://fibbo.dev/api/core/interfaces/PipelineManagerOptions.md)

#### event

##### Event

- [Class: FKeyboard](https://fibbo.dev/api/event/classes/FKeyboard.md)

##### Interfaces

#### util

##### Core

- [Class: FAssetUtil](https://fibbo.dev/api/util/classes/FAssetUtil.md)
- [Class: FMathUtil](https://fibbo.dev/api/util/classes/FMathUtil.md)

### Other

- [Class: `abstract` FController](https://fibbo.dev/api/2d/classes/FController.md)
- [Class: `abstract` FController](https://fibbo.dev/api/3d/classes/FController.md)
- [fibbojs](https://fibbo.dev/api/index.md)
- [Untitled](https://fibbo.dev/index.md)