skybx

skybx copied to clipboard

SKYBX is an open-source project that brings the power of Blockade Labs' AI-powered skybox generation tool into an immersive WebXR environment. This project enables users to create stunning skyboxes in a 3D world and experience the generated environments as if they were truly inhabiting them.

SKYBX is developed using the Elixr engine, a WebXR-centric framework built on top of Three.js which integrates a robust Entity Component System (ECS) and the high-performance Rapier physics engine.

Features

• 🤖 Tight integration with Blockade Labs' AI-powered skybox generation tool
• 🌐 Immersive experience when creating skyboxes in a 3D environment
• 🌟 Cross-platform compatibility for a wide range of WebXR-supported devices
• 🎨 Friendly and easy-to-use user interface for seamless skybox generation

Local Development

Prerequisites

To run this project locally, ensure you have the following installed:

• Node.js (v14.x or newer)
• npm (v7.x or newer)

Installation

1. Git clone the repository and navigate to the project folder:

$ git clone [email protected]:felixtrz/skybx.git
$ cd skybx

2. Install dependencies:

$ npm install

3. Start the development server:

$ npm run serve

Resources

• Elixr engine documentation and sample code
• Three.js documentation and examples
• Immersive Web Emulator blog post and Chrome web store page

Usage

1. Access SKYBX through a compatible browser on a device that supports WebXR, such as Meta Quest 2 or Pico 4.
2. Use the virtual keyboard to enter a descriptive prompt for the skybox you wish to generate.
3. Point and click the "Generate" button with your controller to create a new skybox based on your prompt.
4. Explore and enjoy the generated world.

API

Please refer to Blockade Client API Docs for full API documentation.

License

This project is co-licensed under the MIT License by Blockade Games, Inc., a Delaware corporation, and Felix Zhang, an individual. See the LICENSE file for details.