Projects
The projects documentation covers how Adamas projects are created, developed, and distributed.
Project Setup
Project setup covers the entry points into an Adamas development workflow. In most cases, developers begin in Project Studio through Adamas Hub, where a new project can be created, an existing project can be opened, and project metadata is initialized in the .adamas directory. Project setup documentation also covers the standalone TypeScript workflow for advanced users who want to work directly with the Adamas API outside the Project Studio editing environment.
For more detail, see Project Setup.
Project Distribution
Project distribution covers how project output is prepared for delivery on the Adamas platform and outside it. It explains the Adamas launch model, the distinction between world projects and regular projects, the build and publish workflow in Project Studio, and the current limitations of outside-platform distribution. This section is the primary reference for developers preparing a project for release, publication, or deployment through a custom distribution workflow.
For more detail, see Project Distribution.
Project Development
Project development in Adamas combines editor-based authoring with TypeScript programming. Developers working on projects should begin with Runtime Concepts, which introduces the platform systems used by project code, including lifecycle, scene structure, rendering, physics, interaction, networking, user state, input, and serialized project data.
For editor workflows, Project Studio covers the windows and interfaces used to build and configure project content, including scene editing, asset inspection, project settings, build, and publish workflows. For scripting, the API reference documents the TypeScript interfaces used by Adamas projects.
For general programming practices when writing Adamas project code, see Coding Guidelines.
Official Samples
Official Adamas VR project samples are available on GitHub at adamas-vr/samples. These sample projects are useful as reference implementations for project structure, platform integration, and development workflows.
Table of Contents
📄️ Overview
The projects documentation covers how Adamas projects are created, developed, and distributed.
📄️ Project Setup
Project setup covers the primary entry points into an Adamas VR development workflow. It explains how to begin work in Project Studio, how existing projects are recognized and opened, and how Adamas projects can also be developed as standard Node.js and TypeScript codebases using the Adamas API directly.
📄️ Project Distribution
Project distribution in Adamas follows a different model from that of a traditional game engine. In conventional engine-based workflows, the project and engine runtime are typically packaged together as a standalone application and distributed through a third-party channel such as Steam or the Meta Quest store. In Adamas, the platform runtime is provided by Adamas itself through the Platform Launcher, and developers distribute only the project content. Users launch the Adamas platform and then remotely load published projects into that runtime environment.
🗃️ Runtime Concepts
7 items
🗃️ Project Studio
10 items
📄️ Coding Guidelines
This document provides general programming guidelines for developing Adamas VR