DOCSEARCHbyAlgolia
Submit Docs

MUD Foundation Documentation

website·Indexed 33 days ago

https://docs.mud.foundation

Documentation for the MUD ecosystem, featuring XR Creator Studio for building extended reality scenes and XRHUB for managing workspaces, verses, and analytics. Includes a comprehensive scripting API with classes such as XRInput, VideoElement, WaterElement, and HttpRequest, as well as guides on version control, conditional compilation, and deployment.

Tokens
71.7K
Snippets
212
Records
639
Agent score
62%

What's inside MUD

  1. Overview of XR Creator Studio Version Control

    XR Creator Studio features a built-in Version Control system enabled by default for all projects. It uses a commit-based history where every save creates a 'checkpoint' (a snapshot of the project state and changes since the last save). The system separates work into two branches: the User Branch for rapid iteration, drafts, and collaboration, and the Deployment Branch for finalized builds deployed to development or production environments.

  2. Overview of AI Agents in XR Creator Studio

    AI Agents in XR Creator Studio are digital entities powered by language models (such as OpenAI or Azure AI) that interact with users in immersive environments. An agent is defined by three core components: the Model (the AI engine like GPT-4), Memory (volatile for temporary history or persistable for cross-session history), and Interaction Instructions (system prompts defining personality and behavior).

  3. Overview of the Resources Panel asset sources

    The Resources Panel is the central hub for managing assets in an XR scene. It organizes assets into three primary categories:

    • Assets: User-uploaded 3D models, images, PDFs, videos, and audio, organized by project ID.
    • Integrations: External libraries for importing 3D models (Sketchfab) and artworks (Public Domain Art collections).
    • Bundles: Themed curated collections, such as the Architecture Kit and Sound Pack.

  4. Overview of Custom Subdomains in mud.foundation

    A custom subdomain provides a unique, branded URL (e.g., https://your-subdomain.verse.mud.foundation) that serves as a personalized entry point for your public profile and content. It allows you to manage a branded workspace where you can publish Projects, Verses, and Activations, and provide visitors with a personalized Explore page.

  5. Overview of the MUD XR Platform

    The MUD XR Platform is a web-based immersive digital infrastructure that allows artists, educators, and institutions to create XR applications directly in a browser using the WebXR API. It requires no local installations and is compatible with desktop, mobile, and VR headsets. The platform supports 3D content, AI-powered agents, digital galleries, and real-time events.

  6. Overview of the Config Manager

    The Config Manager is a runtime settings component located in the Properties Panel when the root of the project is selected. It allows developers to customize the behavior and UI of a Verse project once published. Users can apply predefined presets (AR, MR, VR, or Minimal UI) or create a fully customized configuration to control UI elements, user access to media tools, security restrictions (chat, avatars, camera), and performance optimizations for AR, MR, or VR.

  7. Overview of the Config Manager

    The Config Manager is a runtime settings component located in the Properties Panel when the root of the project is selected. It is used to customize the behavior and UI of a Verse after publication, including UI elements, user access to media tools, security restrictions (chat/avatars), and performance optimizations for AR, MR, or VR. Users can apply predefined presets (AR, MR, VR, or Minimal UI) or create a fully customized configuration.

  8. Manage activations in the MaaS Dashboard

    The Activations section provides a centralized interface for administrators to oversee the status, visibility, and configuration of scheduled or published experiences (activations) within the Metaverse-as-a-Service (MaaS) system. Administrators can use the search bar to filter activations by name or keyword and view the total count of activations currently listed.

  9. Analyze asset performance using Archive Analytics

    The Asset Analytics dashboard provides data on user interaction. You can filter these metrics using the date selector in the upper-right corner.

    Available Metrics:

    • Overview: Page Views, Active Users, Average Session Duration, Average Engagement Time, and Views from Shares.
    • Share Traffic: Breakdown of visits via QR Code, Share Link, or other methods.
    • Demographics & Tech: Device Category (Desktop, Mobile, Tablet), Top Countries, Operating Systems (Windows, macOS, Android, iOS, Linux), and Browsers (Chrome, Edge, Firefox, Safari).

  10. Monitor platform KPIs using the Analytics Overview tab

    The Overview tab provides a high-level summary of platform health and user engagement. Administrators can use a date filter (e.g., 'Last 7 Days') to adjust the reporting window. Key metrics tracked include:

    • User Growth & Activity: Active Users, New Users (and growth percentage), New Registrations, and New Subscriptions.
    • Engagement: Percentage of Engaged users, Average Session Duration, and Average Engagement Time.
    • Usage Volume: Total Pageviews and Pageviews Per User.
    • Platform Content: New Verses (metaverse spaces/environments) and New Activations.

    Additionally, the tab provides visual distributions for:

    • Device Category: Usage by device type (e.g., Desktop, Mobile).
    • Top Countries: Geographic origin of user activity.
    • Operating System & Browser: Bar charts showing the software used to access the platform for compatibility optimization.

  11. Understand .xrproj project files

    An .xrproj file is a project package used in XR Creator Studio for collaboration, scene management, and backups. It contains the entire project structure, all associated assets and animations, and scene data, allowing the project to be easily imported into another account.

  12. Use curated asset bundles

    The Bundles tab provides themed collections to accelerate scene creation:

    • Architecture Kit: Contains core structural pieces (walls, columns, arches), roofing (tiles, ceilings), details (doors, windows), extras (plants, fences), and utility items (stairs, foundations).
    • Sound Pack: Contains loopable background sounds, environmental effects, and scene transition cues.