Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 3.05 KB

README.md

File metadata and controls

91 lines (65 loc) · 3.05 KB
Raw
Wired Logo

The Wired

🔌 An open and decentralized web-based metaverse platform.

🔥 Features

  • Decentralized identity / social graph using Lens Protocol 🌿
  • Open backend, anyone can run their own servers
  • Custom multi-threaded, glTF-based game engine
  • VRM avatar support
  • Visual editor for creating spaces

📦 What's inside?

This turborepo uses Yarn as a package manager. It includes the following apps / packages:

Apps

  • client: the main website used to access the Wired.
  • host: dockerized server for hosting spaces

Packages

  • engine: a multi-threaded 3D game engine
  • eslint-config-custom: custom eslint config used throughout the repo
  • lens: queries and types for interacting with Lens
  • tsconfig: tsconfigs used throughout the repo

Utilities

🐋 Docker

You can run the Wired locally using Docker. Run the following command to start the server and client in development mode:

docker compose up

⚙️ Development

Install

To install all apps and packages, run the following command:

yarn install

⚠️ If you run into issues installing, it's probably mediasoup. Follow the steps on their installation guide to get it to work (pay attention to the versions very carefully). Mediasoup tends to be easier to install on Linux, so if you're on Windows, consider using Windows Subsystem for Linux (WSL).

Build

To build all apps and packages, run the following command:

yarn build

Develop

To develop all apps and packages, run the following command:

yarn dev