mirror of
https://github.com/overte-org/overte.git
synced 2025-09-02 09:02:03 +02:00
95 lines
5 KiB
Markdown
95 lines
5 KiB
Markdown
<!--
|
|
Copyright 2013-2019 High Fidelity, Inc.
|
|
Copyright 2019-2021 Vircadia contributors
|
|
Copyright 2021-2025 Overte e.V.
|
|
SPDX-License-Identifier: Apache-2.0
|
|
-->
|
|
|
|
<p align="center"><a href="https://overte.org/"><picture><source srcset="interface/resources/images/brand-banner.svg" alt="Overte" width="350" media="(prefers-color-scheme: dark)"><img src="interface/resources/images/brand-banner-black.svg" alt="Overte" width="350"></picture></a></p>
|
|
|
|
<h3 align="center"><a href="https://overte.org/">Website</a> | <a href="https://matrix.to/#/#overte:matrix.org">Matrix</a> | <a href="https://overte.org/downloads.html">Download</a></h3>
|
|
<p align="center">
|
|
<a href="https://docs.overte.org/en/latest/contribute.html"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/overte-org/overte"></a>
|
|
<a href="https://github.com/overte-org/overte/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/overte-org/overte"></a>
|
|
<a href="https://github.com/overte-org/overte/network"><img alt="GitHub forks" src="https://img.shields.io/github/forks/overte-org/overte"></a>
|
|
<a href="https://www.apache.org/licenses/LICENSE-2.0"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache--2.0-%230A7BBB?style=flat"></a>
|
|
<a href="https://matrix.to/#/#overte:matrix.org"><img alt="Matrix" src="https://img.shields.io/matrix/overte:matrix.org?label=Matrix%20chat"></a>
|
|
<a href="https://depot.dev/?utm_source=Overte"><img alt="Built with Depot" src="https://depot.dev/badges/built-with-depot.svg"></a>
|
|
</p>
|
|
<h3 align="center">Build Status</h3>
|
|
<p align="center">
|
|
<a href="https://github.com/overte-org/overte/actions/workflows/nightly_build.yml"><img alt="Nightly CI Build" src="https://github.com/overte-org/overte/actions/workflows/nightly_build.yml/badge.svg"></a>
|
|
<a href="https://github.com/overte-org/overte/actions/workflows/master_deploy_apidocs.yml"><img alt="API-docs CI Build & Deploy" src="https://github.com/overte-org/overte/actions/workflows/master_deploy_apidocs.yml/badge.svg"></a>
|
|
<a href="https://github.com/overte-org/overte/actions/workflows/master_deploy_doxygen.yml"><img alt="Doxygen CI Build & Deploy" src="https://github.com/overte-org/overte/actions/workflows/master_deploy_doxygen.yml/badge.svg"></a>
|
|
</p>
|
|
|
|
### What is this?
|
|
|
|
Overte is a free and open source 3D social virtual worlds software.
|
|
|
|
* Desktop and VR use
|
|
* Hundreds of users simultaneously
|
|
* Collaborative in-world creation
|
|
* Full-body avatars
|
|
* FBX, glTF, and OBJ support
|
|
* JavaScript scripting engine
|
|
* 256km²/4096km³ world space in a server
|
|
* Fully self-hosted
|
|
* Apache 2.0
|
|
|
|
### Releases
|
|
|
|
[View Releases (and pre-releases) here](https://github.com/overte-org/overte/releases/)
|
|
|
|
### How to deploy a Server
|
|
|
|
- [For Windows and Linux](https://docs.overte.org/en/latest/host.html)
|
|
|
|
### Building
|
|
|
|
#### How to build the Interface
|
|
|
|
- [For Windows](https://github.com/overte-org/overte/blob/master/BUILD_WIN.md)
|
|
- [For Mac](https://github.com/overte-org/overte/blob/master/BUILD_OSX.md)
|
|
- [For Linux](https://github.com/overte-org/overte/blob/master/BUILD_LINUX.md)
|
|
- [For Linux - Overte Builder](https://github.com/overte-org/overte-builder)
|
|
|
|
#### How to build a Server
|
|
|
|
- [For Windows](https://github.com/overte-org/overte/blob/master/BUILD_WIN.md)
|
|
- [For Linux](https://github.com/overte-org/overte/blob/master/BUILD_LINUX.md)
|
|
- [For Linux - Overte Builder](https://github.com/overte-org/overte-builder)
|
|
|
|
#### How to generate an Installer
|
|
|
|
- [For Windows - Interface & Server](https://github.com/overte-org/overte/blob/master/INSTALLER.md)
|
|
- [For Mac - Interface](https://github.com/overte-org/overte/blob/master/INSTALLER.md)
|
|
- [For Linux - Interface AppImage & Server .deb/.rpm - Overte Builder](https://github.com/overte-org/overte/blob/master/INSTALLER.md)
|
|
|
|
### Mission statement
|
|
|
|
Overte aims to provide social virtual worlds experiences with entirely free and open source infrastructure.
|
|
|
|
### Technical details
|
|
|
|
Overte consists of many projects and codebases with its unifying structure's goal being free and open source self-hosted virtual worlds.
|
|
|
|
- The Interface - You are here!
|
|
- The Server - You are also here!
|
|
- [The Directory Server (Codename Iamus)](https://github.com/overte-org/overte-metaverse/)
|
|
- [The Directory Server Dashboard (Codename Iamus)](https://github.com/overte-org/metaverse-dashboard/)
|
|
- [Our downstream Conan recipies](https://github.com/overte-org/overte-conan-recipes)
|
|
|
|
#### Tools
|
|
- [Overte Builder for Linux](https://github.com/overte-org/overte-builder/)
|
|
|
|
#### Documentation
|
|
- [User Documentation](https://github.com/overte-org/overte-docs-sphinx/)
|
|
- [API Documentation (JavaScript)](https://apidocs.overte.org/) - Generated using JSDoc [here](https://github.com/overte-org/overte/tree/master/tools/jsdoc).
|
|
- [Doxygen (C++)](https://doxygen.overte.org/)
|
|
|
|
### Contribution
|
|
|
|
There are many contributors to Overte.
|
|
Code writers, reviewers, testers, documentation writers, modellers, and general supporters of the project are all integral to its development and success towards its goals.
|
|
Find out how you can [contribute](https://docs.overte.org/en/latest/contribute.html)!
|