Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/takahirox/tiny-web-metaverse

A web-based 3D virtual space lightweight framework with high flexibility, extensibility, and easy hosting, built on ECS architecture
https://github.com/takahirox/tiny-web-metaverse

3d ecs elixir javascript metaverse threejs typescript web webaudio webrtc websocket

Last synced: 4 days ago
JSON representation

A web-based 3D virtual space lightweight framework with high flexibility, extensibility, and easy hosting, built on ECS architecture

Awesome Lists containing this project

README 

        
# Tiny Web Metaverse



[![Latest NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/client.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/client)



Tiny Web Metaverse is a Web-based multi-user 3D virtual space lightweight

framework with high flexibility and extensibility. It is built on web

standards, making it familiar and easy to use for developers with Web

development experience.



Tiny Web Metaverse adopts an ECS architecture. This architecture makes it

easy to add or modify features without having to modify existing code.



Tiny Web Metaverse uses Docker containers to reduce the overhead of environment

setup.



## Online Demo



[Online Demo](https://tiny-web-metaverse.net)



Click to enter a room, and then share the URL (with `?room_id=xxx`) with your 

friends to meet up with in a room.



Built on this framework, this demo offers the following features:



* 3D Exploration: Walk around and rotate the 3D space

* Collaborative Object Manipulation: Collaborate with remote users to manipulate

  objects in the 3D space

* Audio and Text Chat: Communicate with remote users via audio or text

* Mobile-Friendly: Good support for mobile devices

* VR/AR Experience: Experience the 3D space in a realistic way using VR/AR

  devices

* AI Model Generation: Generate 3D models automatically using generative AI



## Screenshots












## AI Demo videos



One of the features of Tiny Web Metaverse is that it is easy to add features

due to its high extensibility. For example, it is easy to add features that

leverage generative AI, which is rapidly growing recently. I have actually

added some features locally and recorded videos. You can watch them here.



* [Text to 3D model AI + AR/VR](https://twitter.com/superhoge/status/1720274165125840997)

* [AI chatbot](https://twitter.com/superhoge/status/1723184343542317418)

* [Realtime Image to Image AI](https://twitter.com/superhoge/status/1730847570422100179)

* [Realtime texture generation with Text to Texture AI](https://twitter.com/superhoge/status/1735887721644888268)

* [Canvas to Image AI into 3D scene](https://twitter.com/superhoge/status/1736174055315947677)



## What this framework provides



This framework makes it easy to create and deploy multiplayer virtual 3D space

web apps that reflect user ideas in a free way.



The advent of [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API)

and [WebGPU](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API), as

well as JavaScript 3D graphics libraries that use them, has made 3D rendering

easier in browsers. Also, [WebXR](https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API),

[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API), and

[WebRTC](https://webrtc.org/) have made it possible to create web apps with

VR/AR, and real-time network processing.



Many people are interested in developing multiplayer virtual 3D space web apps

that could realize new forms of human interaction, such as open online games

and virtual events.



However, developing them can be surprisingly laborious. You need to develop

both the client and the server, and you need knowledge of hosting and Web APIs.

Network synchronization is especially troublesome. These processes can be

cumbersome.



There are ways to use existing platforms to create custom content, but they can

be restrictive, as custom logic can be difficult to add, and you may need to

register with the platforms.



To address these challenges, I created a framework that is easy to modify, extend,

and self-host.



The framework handles the cumbersome processing of the Web APIs and networking,

so you can focus on your own custom logic and content creation. It is also

built on technologies that are commonly used in web app development, such as

[JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) and

[TypeScript](https://www.typescriptlang.org/), so you can develop with a

familiar development environment and workflow.



## Features



* Extendibility and flexibility with [ECS architecture](https://en.wikipedia.org/wiki/Entity_component_system)

* Easy self-hosting with [Docker](https://www.docker.com/)

* 3D space rendering with [WebGL](https://www.khronos.org/webgl/)

* VR/AR support with [WebXR](https://developer.mozilla.org/en-US/docs/Web/API/WebXR_Device_API)

* Real-time network synchronization with [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)

* Real-time Audio/Video communication with [WebRTC](https://webrtc.org/)

* Audio effects with [WebAudio](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API)

* Support for mobile devices

* Accelerates development with standard Web technologies



## Example use cases



* Multiplay 3D games: Develop online multiplay virtual 3D games.

* Virtual meeting rooms: Host online meetings and conferences in 3D spaces with

avatars and interactive elements.

* Art galleries and museums: Showcase virtual exhibitions and collections for

immersive viewing and interaction.

* Online Music Festivals: Host online music live events in 3D spaces where many

people connect with music lovers.

* Educational simulations: Create virtual environments for learning about

various topics, like history, science, or technology.

* 3D model viewer and builder: Develop a platform for users to create and share

3D models within the virtual 3D platform.

* Collaborative art projects: Create shared spaces where multiple users can

contribute to a virtual artwork or project.



## Architecture overview



[Client:](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/client)



- bieECS resource management

- 3D graphics rendering using WebGL

- VR/AR processing using WebXR, such as positional tracking

- Network synchronization of object states with remote clients using WebSockets

  via State server

- Audio and video communication with remote clients using WebRTC via Stream

  server

- Input handling from input devices such as mouse, keyboard, touchscreen,

  VR headset, and so on



[Stream server:](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/stream_server)



- SFU WebRTC server for client-to-client audio and video communication

- Reduces the burden on the publisher, and also saves the number of WebRTC

  connections



[State server:](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/state_server)



- A Pub/Sub server for synchronizing object state between clients

- Adopts a Pub/Sub architecture, which makes it loosely coupled and scalable



Database:



- Used by the state server to store object state






## Sub-projects



This project consists of the sub projects. See `packages` directory.



* [addons](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/addons): [![Latest addons NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/addons.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/addons) Addons for Client

* [client](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/client): [![Latest client NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/client.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/client) Client

* [demo](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/demo): [![Latest examples NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/examples.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/examples) Demo

* [state_client](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/state_client): [![Latest state_client NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/state_client.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/state_client) Client of State server

* [state_server](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/state_server): State server

* [stream_client](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/stream_client): [![Latest stream_client NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/stream_client.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/stream_client) Client of Stream server

* [stream_server](https://github.com/takahirox/tiny-web-metaverse/tree/main/packages/stream_server): [![Latest stream_server NPM release](https://img.shields.io/npm/v/@tiny-web-metaverse/stream_server.svg)](https://www.npmjs.com/package/@tiny-web-metaverse/stream_server) Stream server



## Documents



* [Getting Started](https://github.com/takahirox/tiny-web-metaverse/blob/main/docs/development/getting_started.md)

* Client

  * [Client Core concept](https://github.com/takahirox/tiny-web-metaverse/blob/main/docs/client/core_concept.md)

  * API and built-in addons

  * Entity State networking internal

  * Streaming

* Addons

  * Addons list

* State server

  * Overview

* Stream server

  * Overview

* Deploy

  * [Deploy Demo to AWS ECS](https://github.com/takahirox/tiny-web-metaverse/blob/main/docs/deploy/aws/Readme.md)

  * [Deploy Demo to Google Cloud](https://github.com/takahirox/tiny-web-metaverse/blob/main/docs/deploy/google_cloud/Readme.md)



We strongly recommend starting with the Getting Started documentation.



## How to build



```sh

$ git clone https://github.com/takahirox/tiny-web-metaverse.git

$ cd tiny-web-metaverse

$ npm run install:all

$ npm run build:all

```



## How to run Demo locally



Prerequirements:



* Install [PostgreSQL](https://www.postgresql.org/)

  * Setup User/Password as postgres/postgres

* Install [Elixir](https://elixir-lang.org/)

* [Build the project](#how-to-build)



```sh

# Terminal 1

$ cd packages/stream_server

$ npm run server



# Terminal 2

$ cd packages/state_server

$ mix deps.get

$ mix deps.compile

$ mix ecto.create

$ mix ecto.migrate

$ mix phx.server



# Terminal 3

$ cd packages/demo

$ npm run server

```



And access http://localhost:8080 on your browser.



## How to run Demo locally with Docker



Prerequirements:



* Install [Docker](https://www.docker.com/)



```sh

$ ./deploy/up.sh

```



And access http://localhost:8080 on your browser.



## Deploy Demo to Cloud servers



Refer to [the documents](#documents).



## How to support the project



* Test and [Report bugs](https://github.com/takahirox/tiny-web-metaverse/issues)

* [Make Pull requests](https://github.com/takahirox/tiny-web-metaverse/pulls) to fix bugs or add new features

* Monthly or one-time support via GitHub sponsors: T.B.D.

* Make a support contract: T.B.D.