Chapter 02

Installing Dreamer Pro

Your download holds the same package by two routes. Install one of them, never both. A project that has both ends up with two copies of everything and will not compile.

  • The package zip, for VRChat Creator Companion. This is the recommended route.
  • The .unitypackage, for a plain Unity import, if you would rather not use Creator Companion.

Before you start: VideoTXL#

Dreamer Pro plays your Dream in time with a video, so it needs VideoTXL.

  1. Open VRChat Creator Companion.
  2. Go to Settings, then Packages, and add this repository: https://vrctxl.github.io/VPM/
  3. Open your world project and add TXL - VideoTXL, version 2.5.1 or newer. CommonTXL comes with it automatically.

Install with Creator Companion#

  1. Extract the package zip somewhere you keep local packages. Keep it somewhere permanent. Creator Companion reads it from that folder every time it opens your project, so it is not a temporary file.
  2. In Creator Companion, go to Settings, then Packages.
  3. Under User Packages, add the com.realm.dreamer folder you just extracted.
  4. Go back to Manage Project and add Dreamer Pro.
  5. Open Unity.
  6. If Unity asks about TextMesh Pro Essentials, import them.
  7. In Unity's top menu, choose Dreamer Pro > Add Dreamer Pro to Scene.

Dreamer Pro is now in the Packages folder of your project.

Install with a Unity import#

  1. Open your world project in Unity.
  2. Drag the .unitypackage into the Project window, or use Assets > Import Package > Custom Package.
  3. Leave everything ticked and click Import.
  4. If Unity asks about TextMesh Pro Essentials, import them.
  5. In Unity's top menu, choose Dreamer Pro > Add Dreamer Pro to Scene.

This route puts Dreamer Pro in your Assets folder rather than Packages. That is the only place a Unity import can put anything. Everything works the same. The difference matters only if you later switch routes, in which case delete the old copy first.

What "Add Dreamer Pro to Scene" does#

It places the Dreamer Pro Player in your scene. The player is one object that carries everything a Dream needs in the world: the video player, the player controls, the slide panel, the pin box, the collapse button, and the cards and panels a Dream shows to viewers. Exit prefab editing mode first if you are in it. If a player is already in the scene, Dreamer Pro tells you and offers to open the editor instead of adding a second one.

Opening the editor#

Choose Dreamer Pro > Dream Editor.

Dreamwalker Studio opens beside it in the same tab group, and whichever one you picked from the menu is the one you are looking at.

The Dreamer Pro menu#

  • Add Dreamer Pro to Scene. Places the player in the open scene.
  • Dream Editor. Opens the editor window.
  • Dreamwalker Studio. Opens the performer tools.
  • Export Dream (.dream). Saves one or more Dreams from the scene to .dream files.
  • Import Dream (.dream). Brings a .dream file into the open scene.
  • Rebuild Dream Player. Refreshes the player in your scene so it has every panel and part the current version needs. Run it after updating Dreamer Pro.
  • Rebuild Panel Prefabs. Rebuilds the panel prefabs the player is assembled from.

Dreamwalker Studio and its tools#

Dreamwalker Studio turns a screen recording of a VRChat performance, made with OBS, into a performer you can place on your timeline. Most Dreamwalkers are recorded from a Presence node instead, which needs no Studio at all. See the Dreamwalkers chapter.

The first time you use it, it needs two tools set up. If you have the "Dreamer Pro with Dreamwalker Studio" edition they are already in the download, and a button at the top of the window installs them. It takes a few seconds, there is nothing to download, and it only ever happens once per computer, so every project you make afterwards finds them ready.

If you have the plain Dreamer Pro edition, pressing that button says the tools are not included. Everything else in Dreamer Pro works normally without them.

Updating#

Your Dream lives in your scene, not in the package. Updating Dreamer Pro later does not touch anything you have authored. After an update, run Dreamer Pro > Rebuild Dream Player once so the player in your scene gains any new panel.

Dreamer Pro is licensed for use in your own worlds. See LICENSE.txt in your download.