Vircadia is a metaverse engine and platform based on the principles of open-source and decentralization.
You can download Vircadia from our website.
If you prefer to build from source, you can find the codebase for Vircadia in the project-athena repository.
In this repository you'll find our content projects built for worlds that run on the Vircadia platform. We welcome community contributions if you have created content that you would like to share with the developer community. You can find specific information about where specific content is used in the subdirectory readme files.
All content in this repo is available under free and open licenses. The majority of it will be Apache 2.0, CC0, and CC-BY. Licensing is defined within the package.json files for items.
Our file structure is designed to store projects related to how they are deployed within Vircadia, but recognize that not all content will fit neatly into a specific category.
-
DomainContent: Content that lives within a specific domain in Vircadia, generally one that is open to the public. This repo is not meant for private hosting, but if you build something that we think would be a solid addition to a domain that we host, this is where it can go!
-
Marketplace: Content that is self-contained and is intended for or could be adopted to publish on the Vircadia Marketplace.
-
Shared: A directory for utilities or other pieces of content that is meant to be easily ported across different domains and content pieces
-
Prototyping: For projects that are more experimental in nature
-
Utilities: Projects or code that is meant to extend the Interface functionality or provide other utility function for working in Vircadia
If you find a bug and have a fix, pull requests are welcome. Please follow the guideliness in the Contributing file.
Documentation is available at docs.vircadia.com. If you're just getting started with the platform, check out some of these pages to learn more:
- What is Vircadia?
- Get Started: Installation
- Set up your Domain
- Get Started with Scripting
- Vircadia API Reference
There is also detailed documentation on our coding standards.
Currently, all content in this repository is hosted at https://cdn-1.vircadia.com/us-e-1/. If you intend to rehost some or all of this content, then you will need to do a mass search and replace across the content you are rehosting to change from the Vircadia URL base to yours. e.g. https://cdn-1.vircadia.com/us-e-1/ becomes https://cdn.yourwebsite.com/