The SOI MultiLoc builder

These are the instructions on how to use Athelon's multi-location room builder.

What you'll need.

Preparing the room.

  1. Create a blank room. You'll need to remember the room name (include the @ tail) to fill it into a setup script later.
  2. Download the multi.js file. Important note: You will need to right-click on the file and choose Save Target As or whatever your browser calls that option.
    Due to a strange quirk, your system may attempt to name this file multi.js.jpg. That is NOT correct. This is a JavaScript file with the extention of .js
    Upload this file to your room.

Setting up the embed points

With the room created, there are four embed points that need to be filled in. Go to the SOI Control Panel, Rooms, then choose the room you are creating.

There are four entries that have to be made here. Most of these can be directly copied from the list below and filled into the correct spot. There are two important changes that must be made. In the Text for Bottom of the Room, the URL (the piece that begins with https must be changed to point to YOUR files. You can get this address from the FTP_FILES section of SOI. The address MUST begin with https. If it begins with http, you'll have to change it yourself.

Location on SOI room configuration page Text to enter
Room Text Left Side Chat Box <div id=chatleft></div><div id=roomlist></div>
Room Text Under Chat Box <div id=underchat></div>
Text for Top Level of Room <div id="roomtop"></div>
Text for Bottom of Room <div id="roombottom"></div>
<script type="text/javascript" src="http://CHANGEME/multi.js"></script>
<script type="text/javascript" src="http://CHANGEME/config.js"></script>

If you want to have additional things that will NOT change with each view, you may also enter them into the room at this time. If you are going to use triples, they must be set up here. Its a limitation of how the system works.

Generating your views

Open the builder up in a separate window or tab.

If you do NOT have a config file

If you do not have a configuration file already, you'll need to create a blank one by pressing the Load Blank Data button.

If you do have a config file

If you do have a configuration file already, you will need to cut-and-paste it into the entry box for on this screen

Once the entry box is filled, press Next>>

Creating the views

Creating the views is very similar to the process of creating rooms at SOI. You can add, remove and edit the views on this screen. If there are no views, enter a view name into the text area field, click the Add radio button then press MakeChange.

This name is only used by the system. It is NOT the name that will show up in the room drop-down list.

If you have an existing view to change, click on the view name

Adding/Editing Views

Editing the view data here is very similar to working with SOI room information.

Press Save when finished.

Setting the defaults

When you have all of your views created, click Finish up to be taken to the last configuration page.

At the bottom of the screen there is a selection which allows to to chose the order that the views will appear in the views list. You can also set which view is the default view.

When finished, click Save.

Copying the file to SOI

The builder does not have the ability to upload the file for you, so you will have to do it manually. Go to the rooms FTP_Files page and create a new file called config.js. (Note, this is the same file name we told the room we would be loading earlier.)

When the new screen comes up, cut-and-paste the information from this window into SOI and click Save

To do, some day

  1. Set up messages as people leave a view or go into one.
  2. Clean up the editor so it just works smoother.
  3. Find the best way to not require refreshes on the room view. "?version=1" might work. Untested.
  4. Make these instructions neater.