https://github.com/vircadia/vircadia-world
Vircadia World - fast reactivity layer for games.
https://github.com/vircadia/vircadia-world
Last synced: 5 months ago
JSON representation
Vircadia World - fast reactivity layer for games.
- Host: GitHub
- URL: https://github.com/vircadia/vircadia-world
- Owner: vircadia
- License: apache-2.0
- Created: 2024-11-08T00:32:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-01-21T11:48:00.000Z (5 months ago)
- Last Synced: 2026-01-21T21:56:26.920Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 5.54 MB
- Stars: 35
- Watchers: 5
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
## Get started
:::note
This is a work in progress and is not yet ready for production use until the version becomes 1.0.0 or higher unless you have direct support from the Vircadia team.
:::
### Clone the repository
Be sure to clone recursively:
```sh
git clone https://github.com/vircadia/vircadia-world.git --recursive
```
or if you've already cloned the repo:
```sh
git submodule update --init --recursive
```
Pull any assets with Git LFS:
```sh
git lfs install
git lfs pull
```
### Deploy
Afterward, use the [CLI](./cli/README.mdx) to install and deploy the project.
## Architecture
```mermaid
graph TB
subgraph K8s["Kubernetes (Optional)"]
subgraph DockerCompose["Docker Compose"]
subgraph APIContainer["API Container"]
API["World API Manager
(WebSockets & REST)"]
end
subgraph StateContainer["State Container"]
State["World State Manager
(Ticks & Entity Lifecycle)"]
end
subgraph PGWebContainer["PGWeb Container"]
PGWeb["PGWeb
(Admin Interface)"]
end
subgraph DBContainer["Database Container"]
Postgres[("Postgres Database
(All State & Auth)")]
end
API --> Postgres
State --> Postgres
PGWeb --> Postgres
end
end
CLI["CLI Tooling
(Configure & Deploy)"]
Client["Client
(No Container)"]
CLI -.->|Deploy & Configure| DockerCompose
CLI -.->|Configure & Deploy| Client
Client -->|WebSocket/REST| API
classDef database fill:#e1f5fe
classDef service fill:#f3e5f5
classDef external fill:#fff3e0
classDef container fill:#e8f5e8
classDef containerGroup fill:#f0f8f0
class Postgres database
class API,State,PGWeb service
class CLI,Client external
class APIContainer,StateContainer,PGWebContainer,DBContainer container
class DockerCompose,K8s containerGroup
```
See the main [website](https://vircadia.com) for an alternate overview of the features available.
## Next
The `next` branch is where new updates are merged before being pushed to `master`.