📚
DimX Bonfire & Sparks
  • 👋Welcome to Bonfire
  • đŸŽŸī¸Fundamentals
    • đŸ› ī¸Getting Started
      • 📘Bonfire Tutorial Videos
      • ⚡Supercharge Your Workflow with ChatGPT for Bonfire
      • đŸ“ĻInstallation Instructions
      • đŸ‘ĒAccount Setup
      • 🚀The Bonfire Launcher
      • 🎮Interface Guide and Controls
      • 🧱Core Concepts
      • âŦ‡ī¸Downloading Spark Content
      • đŸ–Ĩī¸Platform Support
      • 📖Bonfire Lite vs Pro
    • 🔨Builder
      • 🧰Start Building
      • 📖Menu
      • 🔧The Toolbar
      • đŸĒŸPanels
      • đŸ§™â€â™‚ī¸Built-in Content
      • đŸ§™â€â™‚ī¸User-Generated Content
      • 🏃Behavior Nodes
      • â„šī¸Traits
      • đŸ—’ī¸Presets
    • â–ļī¸Player
    • đŸ—ēī¸Mapifier
    • đŸŒŠī¸Sparkifier
    • ⚡Sparks
  • đŸ”ĨEmber
    • Base API
    • Extended API
      • Intrinsics
        • InvokeOutput
        • Mod
        • SparkRef
      • Return Types
        • Spark (ValMap)
          • Traits (ValMap)
    • Important Notes and Best Practices
  • â›ī¸Diving Deeper
    • Bonfire Best Practices
    • Workarounds
    • Tips and Tricks
  • Release Notes
    • Bonfire v1.18.8.1
    • Bonfire v1.18.7.3
    • Bonfire v1.18.6
    • Bonfire v1.18.5
    • Bonfire v1.18.4
    • Bonfire v1.18.3
    • Bonfire v1.18.2
    • Bonfire v1.18.1
    • Bonfire v1.18.0
    • Bonfire v1.17.0
    • Bonfire v1.16.0
    • Bonfire v1.15.0
  • Links
    • Support Site
    • Bonfire Tutorial Videos Playlist
Powered by GitBook
On this page
  • Bonfire Player: Domain Selection & Mode Explanation
  • Domain Selection in Bonfire Player
  • Mode Selection: Debug vs. Release
  • IMPORTANT NOTE
  • Bonfire Player: Choose an Avatar & Choose a Book
  • Step 1: Create Your Avatar in Ready Player Me
  • Step 2: Add Your Custom Avatar in Bonfire Player
  • Adding a Book in Bonfire Player
  • Bonfire Player: Pause Menu Explained
  • How to Access the Pause Menu

Was this helpful?

  1. Fundamentals

Player

PreviousPresetsNextMapifier

Last updated 3 months ago

Was this helpful?

Details

  • Books can be ‘published’ at any time. Each time the Book’s Share Code is entered into the Player, Experience updates are downloaded from the CDN to the Player.

  • Players can be configured to download a queue of several large modules simultaneously. For support, please contact info@dimx.dev.

  • The Player will only run the Book once the entire download is complete.

Bonfire Player: Domain Selection & Mode Explanation

Bonfire Player allows users to connect to different server environments based on their needs. The domain selection and mode selection (Debug/Release) help developers and users choose the appropriate environment for testing or production use.

Domain Selection in Bonfire Player

The domain selection in Bonfire Player allows users to connect to different server environments, typically for development, testing, or production use.

1. Domain: https://bonfire.dimx.app

  • This is the main URL used to connect to Bonfire services.

  • It serves as the entry point for accessing Bonfire experiences, such as playing published Books and testing Sparks.

Mode Selection: Debug vs. Release

Debug Mode: Designed for developers and testers. Release Mode: Designed for general users and final production use

IMPORTANT NOTE

It is important to note that the user must choose the same Domain and Mode in the Player as the one used by the creator when publishing the book in Bonfire Builder.

Otherwise, the book won’t show up on the Player side.

Bonfire Player: Choose an Avatar & Choose a Book

After selecting the domain and mode in Bonfire Player, users are presented with two main options:

1. Choose an Avatar

  • This option allows users to select their in-game character.

  • Avatars are customizable and can represent the user inside Bonfire experiences.

  • The selected avatar will be used when interacting with the virtual environment.

  • Some Books may support different avatar styles, including pre-made avatars or custom uploads.

2. Choose a Book

  • Books are interactive experiences in Bonfire, similar to virtual worlds or levels.

  • Selecting this option lets users load a specific Book by entering a share code or choosing from available Books.

  • A Book may contain different environments, objects, interactions, and scripts that define the experience.

  • Books can be created using Bonfire Builder and published for others to explore.

Step 1: Create Your Avatar in Ready Player Me

  1. Click "Create Avatar" and customize your avatar as you like.

  2. Once finished, copy the avatar URL by:

    • Clicking Share or Save Avatar

    • Copying the generated URL (e.g., https://models.readyplayer.me/12345)


Step 2: Add Your Custom Avatar in Bonfire Player

  1. Launch Bonfire Player and proceed to the "Choose an Avatar" screen.

  2. Look for an option to enter a custom avatar URL (this may appear as a text field or button).

  3. Paste the Ready Player Me URL into the field.

  4. Click Confirm or Load Avatar.

Adding a Book in Bonfire Player

To add and play a Book in Bonfire Player, follow these steps:

  1. Launch Bonfire Player and proceed to the "Choose a Book" screen.

  2. You will have options to:

    1. Enter a Share Code (if you have one)

    2. Select from Available Books (including default Books and previously accessed ones)

  3. If using a Share Code, enter it in the provided field and click Load.

  4. The Book will download and load into Bonfire Player, allowing you to explore the interactive experience.

Bonfire Player: Pause Menu Explained

The Pause Menu in Bonfire Player provides essential controls and settings for managing the gameplay experience. It allows users to adjust camera views, change keybindings, exit the Book, and modify mouse sensitivity.

How to Access the Pause Menu

  • Press the Esc key (on keyboard) or use the in-game menu button (on supported devices).

  • The Pause Menu will appear, allowing you to modify settings or exit the current Book.

Go to Ready Player Me ()

đŸŽŸī¸
â–ļī¸
https://readyplayer.me