Virtual Scenes Help Page

Table of Contents
  1. Quick Installation Guide
  2. Troubleshooting/FAQ
  3. Basic User Features
  4. Basic Customizations
  5. Advanced User Features
  6. Advanced Customizations
  7. Technical Details

I. Quick Installation Guide

To set up Virtual Scenes, one must include the file VS.txt in quest.txt. VS.txt contains inclusion statments which make including any other files directly in quest.txt unnecessary. To accomplish this, you can place this code inside the SCENES section:

#include VS.txt

After that, we must make a modification to devTable91.txt. Find the line starting with Devvers, and replace Soul 2044 with your own Soul ID. If all files were copied correctly, you should now be able to set up links on your world to scenes 2239 (VSIDE, which you use to make Virtual Scenes) and 2242 (VS, which "plays back" the scenes you wrote in the VSIDE).


II. Troubleshooting/FAQ

Q1. My VSIDE scene (2239 by default) is covered with ghouls! What's wrong?

A1. The skins that go along with Virtual Scenes have not been installed properly in your world's monsters folder. Please check to see whether they are in the directory. If not, try copying them or extracting them directly to that folder.


III. Basic User Features

1. VSIDE Features

Preview Scene - You can preview a scene either in the Programming or Console areas by right-clicking the Preview Scene button. Virtual Scenes will then find and go to a VS scene to interpret the scene. After it has completed, Virtual Scenes will return you right to where you left off, so it barely interrupts your work.

Help Menu - The help menu is always present in the IDE, so you can get help with any of the features with only a few clicks.

System Menu - A menu button is ever-present, allowing you to easily switch to Programming or Console mode, and to exit the IDE.

A. Programming Area

Add Command - Right-click this button to add a command to the scene you are programming.

Edit Command - Right-click this button and a command in the list to change its properties.

Insert Command - After right-clicking this, select a command in the list to insert a new command before. Then choose a new command to add and set its properties.

Remove Command - Use this to remove commands from the list by right-clicking them.

Save Scene - Choose one of the 63 slots and save your scene.

Load Scene - Restore a previously saved scene.

Jump to Label - Find a scene label (@label) in the current scene.

Output QUEST - Print out the current scene to copy and paste to notepad. This lets you take a virtual scene and change it to a hardcoded scene to add to your world.

Input QUEST - Directly input QUEST commands. Used for quick entry of commands.

B. Console Area

Saved Scene - Use this to select a scene that has been saved previously.

Current Scene - This will select the scene which has just been programmed during the current session.

Print Local/Remote Selection - Outputs the QUEST commands for either the remote selection or for the local selection.

Upload - Uploads the locally selected scene to the remote selection.

Download - Downloads the remote selection to the local selection.

VS Scene - Selects a standard VS scene to for the remote selection.

LBVS Scene - Selects a map and link for use with a Link-Based VS scene as the remote selection.

2.


IV. Basic Customizations

1. Changing the Scene Number

In order to change the scene number for either the VS scene or the VSIDE scene, you must change several things in its file and in other files.

A. VSIDE Scene Number Change

Open VSgui.txt and change the scene number in the first line. Go to the world editor in Well of Souls and change the link that corresponds to it accordingly.

Open devTable91.txt. In the general settings section (generally at the top of the file), replace the old scene number with the new.

B. VS Scene Number Change

Open VS2242.txt (or the file with the scene number of the VS Scene you want to change). Press Ctrl-H to bring up the Replace dialog box (or use the menus: Edit > Replace...). Type the old scene number (the default is 2242) in at the top input box (Find what:) and put the new scene number at the bottom box (Replace with:). Press Replace All. When it is done, save and close the file. Rename the text file, replacing the old scene number with the new scene number.

Open VS.txt. Replace the old scene-numbered name with the new. Save and close the file.

Open devTable91.txt. In the general settings section (generally at the top of the file), replace the old scene number with the new.

C. VS Functions Scene Number Change

Open the VS file (default VS2242.txt) and press Ctrl-H (or use the menus: Edit > Replace...). Type the old scene number (the default is 2240) in at the top input box (Find what:) and put the new scene number at the bottom box (Replace with:). Press Replace All. When it is done, save and close the file.

Open the VSIDE file (default VSgui.txt) and press Ctrl-H (or use the menus: Edit > Replace...). Type the old scene number (the default is 2240) in at the top input box (Find what:) and put the new scene number at the bottom box (Replace with:). Press Replace All. When it is done, save and close the file.

Open the VS functions file (VSfunctions.txt) and press Ctrl-H (or use the menus: Edit > Replace...). Type the old scene number (the default is 2240) in at the top input box (Find what:) and put the new scene number at the bottom box (Replace with:). Press Replace All. When it is done, save and close the file.

2. Adding a second VS playback scene.

Open VS.txt. Add a new file inclusion just under the existing inclusion (#include VS2242.txt by default), copying the old format (VS<scene number>.txt).

Copy and paste the VS file. The new copy will be named "Copy of VS2242.txt" or something similar. Rename it to use the new scene number, matching the file name used in VS.txt.

Open the new VS file. Press Ctrl-H to bring up the Replace dialog box (or use the menus: Edit > Replace...). Type the old scene number (the default is 2242) in at the top input box (Find what:) and put the new scene number at the bottom box (Replace with:). Press Replace All. When it is done, save and close the file.

Open devTable91.txt. In the general settings section (generally at the top of the file), add the new scene number and type to the end of the VS line. Your new entry will probably look like this, assuming a scene number of 3000:

3000, 1

Add a new link in your world to correspond to the new VS.


V. Advanced User Features

1. VSIDE Features

Terminal Prompt - A limited version of Terminal inside the VSIDE.

The Terminal Prompt feature is available in both the programming and console areas. It supports several commands, which are:

Terminal Prompt Commands
Command Arguments Function
code [command] [commandargs] Inputs commands, similar to Input QUEST button's function.
upload [source: 1... 63|current [label]] [category] [variable] Uploads VS string.
download [destination: 1... 63|current] [category] [variable] Downloads VS string.
console No arguments. Moves to Console Mode.
program No arguments. Moves to Program Mode.