Resources

hippoWINDOWS User Guide


Welcome to hippoWINDOWS, a powerful tool that allows you to easily configure every aspect of the way the windows in your house look, either with simple chat commands, or at the touch of a button.

Using hippoWINDOWS, you could easily ...

  • Change the texture on every upstairs window, recolour every downstairs window, and make every window transparent inside and solid outside for privacy.

  • Set up different presets --- perhaps for day-time and night-time, or for when you're feeling friendly versus when you want some privacy for more intimate moments.

  • Allow your friends to control your window system if you wish.

  • Define your own list of favourite colours to use.

  • If you're a landlord, you'll be delighted that hippoWINDOWS fully integrates with our popular hippoRENT system. Just connect a hippoWINDOWS controller to a rental box and then the tenant can configure their windows the way they wish.

Here’s what this document describes for you ...

1. Setting up hippoWINDOWS for the first time

2. Controlling your windows

3. Menu commands

4. Advanced '_config' notecard settings (including networking to a hippoRENT box)

5. Defining your own colours

6. Tips and tricks for advanced users

7. Free window textures


1. Setting up hippoWINDOWS for the first time

  1. Begin by rezzing a hippoWINDOWS controller in the house you wish to control the windows in. Position it anywhere you like. Only one is needed per property although you could, for convenience, have multiple controllers in one house). Note that a controller can only effect windows in the same sim.



  2. Right click the controller and choose 'Edit' (then More>>> if only the reduced build dialog box has appeared).


    Now click on the 'Contents' tab and then double click on the '_config' notecard to edit it. You'll see a number of settings (more on these later). For now, just change the WINDOW COMMUNICATION CHANNEL to a nice high random number (negative channel numbers cause a bit less lag). Also change the WINDOW COMMUNICATION PASSWORD to a password of your choice, to protect communication between the controller unit and your windows. So for example, you might have ...



    Once that's done, close the notecard and save it. Close the Second Life build window if it's still open, then click the controller panel (not one of the buttons) and choose "Reset" to reload the changes you've just made.

  3. Now to setup your first window. Right click a window in your home (obviously you need mod rights on it) you wish to control and choose 'Edit' (then More>>> if only the reduced build dialog box has appeared). Then click on the 'Contents' tab and drag to it, from your hippoWINDOWS folder, the 'WindowConfig' and then the 'WindowController' script. (You can also CTRL drag the items from your inventory directly to the window prim; if you do this, you'll need to use 'Set Scripts to Running in Selection' from the Second Life tools menu to activate the script).

  4. Edit the WindowConfig notecard as you did the _Config notecard in step (b) and make sure the WINDOW COMMUNICATION CHANNEL and WINDOW COMMUNICATION PASSWORD match what you put into the controller in step (b) above.

  5. You also need to tell the notecard what prim face represents the inside and outside of the window panes. You can add the 'Side Numbering' script to the prim if you wish to find out face numbers and delete it afterwards. So, for example, you might have ...



    If you're starting from scratch, you might find it easier to just rez the 'Test Window' included in your hippoWINDOWS folder ... that is correctly setup and ready to go.

    For Advanced Users
    You can, if using v1.1 of hippoWINDOWS (free update at the main store for older users), now specify a list of faces, rather than just one. For example:

    INSIDE FACE: 2, 3, 5
    OUTSIDE FACE: 1, 4



  6. Once you're done, close and save the notecard and the window will load it, reporting its progress in hovertext. (If it doesn't, you may have accidentally disabled the WindowManager script when you added it. Just select the window then choose the Second Life Tools menu and 'Set Scripts to Running in Selection').

    Now Repeat steps (c) to (f) for each window you wish to control. You're now ready to play!



2. Controlling your windows

Click the hippo button on the front of your hippoWINDOWS control panel to enter a command (or click the controller panel and choose 'Command' from the menu). Commands are typed in chat and consist of ...

  • The window (or windows) you wish to change
  • A sequence of instructions to the windows

For now, let's just command all windows by using the command ...

ALL WINDOWS COLOUR RED

(Commands are not case sensitive, although texture names, see below, are).

** TIP: Americans can use the word COLOR, that will also work!

You can also specify just an inside or outside face, or combine a command, like this ...

ALL WINDOWS COLOUR BLUE INSIDE COLOUR RED OUTSIDE

**TIP: Colour names are kept in the _colours notecard inside the hippoWINDOWS controller, so you can edit the list to suit your needs. Note, colour names in that notecard must NOT contain spaces, so 'Light Gray' won't work, use e.g. Light_Gray instead.

If you prefer, you can use a colour vector rather than a name; so e.g.

ALL WINDOWS COLOR <1, 0, 1> INSIDE

That's the colour command. You can control the transparency of a window using the TINT command (or TRANSPARENCY or ALPHA), followed by a number from 0 (fully transparent) to 100 (fully solid). So for example:

ALL WINDOWS ALPHA 30 INSIDE ALPHA 100 OUTSIDE

... this would give you a nice view from inside, but solid windows outside for privacy. Of course, you can combine colour and tint ...

ALL WINDOWS COLOUR BLUE INSIDE TINT 45 INSIDE COLOR RED OUTSIDE TINT 90 OUTSIDE

** TIP: Remember that the 'INSIDE' or 'OUTSIDE' command word needs to be used with each command (colour, tint, texture etc.) as you can see above

The third command you can use is TEXTURE to apply a texture. You can either supply the name of a texture you've added to the hippoWINDOW Controller's inventory, or the UUID of a texture from your inventory (right-click the texture, choose 'Copy Asset UUID' from the menu). Note you'll need correct permissions on a texture to be able to use it's key like this. So for example ...

ALL WINDOWS TEXTURE "Leaded Glass" INSIDE TEXTURE "Shuttered Windows" OUTSIDE

As you can see, texture names need to be enclosed in quotemarks. And, to repeat, textures must exist in the hippoWINDOW Controller's inventory (CTRL drag them is a quick way to add them from your main inventory, just be sure to add them to the main panel, *not* to one of the five buttons!)

And if you prefer the key method:

ALL WINDOWS TEXTURE "609916c6-e945-03d6-67f5-c1922c2fcec4"

This would apply the texture to both inside and outside, since a side is not specificed.

* TIP: To remove a texture, just use "" ... e.g. ALL WINDOWS TEXTURE "" INSIDE

So what if you want to control *some* but not all windows. Easy, ensure you've named your window prims something meaningful ... you can then address a command to any windows whose names contain the text you use. For example:

Upstairs COLOR RED INSIDE TEXTURE "609916c6-e945-03d6-67f5-c1922c2fcec4" OUTSIDE

This would cause window prims called "Upstairs 1" and "Upstairs 2" for example to carry out the command, but not windows called "Downstairs", "French Windows" etc. etc.

Get the idea? Name your windows sensibly and you've got a very powerful and flexible system.

Two last tricks ...

First, you can send commands to different window sets in one chat command by separating them with a semi-colon ...

UPSTAIRS COLOR RED INSIDE COLOR BLUE OUTSIDE; DOWNSTAIRS TINT 50 INSIDE TINT 70 OUTSIDE

And, if for some reason, you wish to play with the phantom setting of a window (phantom prims can be walked through) use the PHANTOM command to make a window phantom, or SOLID to make it solid again; e.g.

FRENCH WINDOW PHANTOM TINT 60 INSIDE

If using hippoWINDOWS v1.6 or later and you’ve defined some presets in the controller’s ‘_config’ notecard, you can apply one using the word “preset” then its number; e.g.

PRESET 3

Finally, the RESET command tells a window or windows to reset and load its '_configWindow' script afresh; e.g.

ALL WINDOWS RESET


Advanced Commands

Version 1.5 of hippoWINDOWS introduces some advanced commands to control the textures on your windows. You can ...

  • Rotate textures, using e.g. ALL WINDOWS ROTATE 90 INSIDE ROTATE -90 OUTSIDE

  • Offset a texture vertically, using e.g. ALL WINDOWS OFFSET_VERTICAL 0.5

  • Offset a texture horizontally, using e.g. ALL WINDOWS OFFSET_HORIZONTAL 0.5

Please note that advanced commands like these cannot be shared among a group of windows using the “link” method described below.



3. Menu commands

If you touch the panel of the hippoWINDOWS controller (not one of the five buttons) you'll get dialog menu. There are four simple buttons ...

HELP Directs you to the HTML version of these instructions on the Hippo Technologies website.
COMMAND Enter a window command, just as if you'd clicked the round hippo button.
RESET Resets your unit and reloads the _config and _colours notecard. Use if you've made any changes to those notecards.
STATUS Report the status of the controller unit. Spits out lots of useful information about how your unit is set up.



4. Advanced '_config' notecard settings (including networking to a hippoRENT box)

If you examine the _config card inside your hippoWINDOWS controller you'll see there are a number of settings other than the two (channel and password) that you can edit. Here is a description of what every command does ... Remember to save the notecard and use the 'Reset' command from the controller's menu to load and apply any changes.

OTHER MANAGERS: <list of names>
e.g. OTHER MANAGERS: Fred Flintstone, Philip Linden, Steve Jobs
- If you'd like friends to be able to use your hippoWINDOWS controller, add their names here, separated by commas. Note that their names must be spelt exactly as they appear in Second Life, so "albert einstein" is not the same as "Albert Einstein".

ALLOW GROUP USE: <Yes/No>
e.g. ALLOW GROUP USE: No
- If you turn this on (ALLOW GROUP USE: Yes) then anybody wearing the same group tag as the controller is set to can use it. Useful for common buildings on group land.

PRESET 1: <command>
e.g. PRESET 1: all windows color red tint 50 inside tint 100 outside
- The preset commands control what function the four preset buttons on the front of your hippoWINDOWS control panel will issue. You can thus easily put your favourite configuration settings into the notecard and change your windows to them with just one mouse click.

PRESET 2
PRESET 3
PRESET 4

- See above

(Note, if using hippoWINDOWS v1.6 or above, presets can also be applied by typing the PRESET <x> command after clicking the round Hippo logo on the front of your controller; e.g. PRESET 3).

NETWORKING CHANNEL:
NETWORKING PASSPHRASE:

- These two commands are used if you wish to connect your hippoWINDOWS system to a rental box, so that tenants can use it. To this, begin by adding the ‘PLUGIN_windows’ script that can be found in your hippoWINDOWS folder to the rental box. (Right click the rental box, choose “Edit” from the Second Life menu, then More>>> if it is showing, then click on the contents tab, then drag the script to the box’s inventory.) Double click on the script in the box’s inventory to edit it (it comes with full permissions) and change the network_channel and passphrase variables at the top to a channel number of your choice (a large negative number is good) and a passphrase to protect communications (I use a random jumble of letters myself).

Save the script and ensure that “Running” is checked at the bottom of the script window before you close it. If everything is okay, the rental box will say “Plugin Active” when you save it.

Once you've done that, change these two commands in the hippoWINDOWS controller's_config card so that the CHANNEL and PASSPHRASE match what you put in the script. Reset your hippoWINDOWS controller then reset the rental box, to ensure it transmits its latest data. (You can check whether the hippoWINDOWS unit knows about a tenant, partner or rental box managers by clicking it and choosing 'Status').

Once you have successfully set this up, any changes made to the rental box (tenants renting or leaving) will be transmitted to the hippoWINDOWS unit automatically.

Next there is this command ...

TENANT LIMITED TO PRESETS: <Yes/No>
e.g. TENANT LIMITED TO PRESETS: Yes
- If you set this command to 'Yes', the tenant (and their partner, if there is one) will only be able to use the preset buttons on the front of the hippoWINDOWS controller, not issue their own window commands. This allows you to easily pre-program your rental homes with a set of window options, but not permit the tenant to madly texture and colour things in totally psychadelic fashion! Of course, if you trust them, just use TENANT LIMITED TO PRESETS: No and they can use every function.

Note: when resetting a hippoWINDOWS controller any tenant it knows about will get forgotten; however the rental box will communicate every two hours with any linked controller and send the details afresh.

If using v1.1 or greater, you can tell hippoWINDOWS to apply a specific preset (see above) when a new tenancy starts, or when a tenancy ends.

WHEN TENANCY ENDS APPLY PRESET: <1, 2, 3 or 4>
e.g. WHEN TENANCY ENDS APPLY PRESET: 1

WHEN TENANCY BEGINS APPLY PRESET: <1, 2, 3, or 4>
e.g. WHEN TENANCY BEGINS APPLY PRESET: 2

This allows you to have a building's windows revert to a "default" look after a tenant leaves, for example.

Finally, version v1.6 or greater of hippoWINDOWS allows you to have your windows automatically change depending on the Second Life time. This combined, for example, with judicious use of textures, could create the appearance of curtains that close at night. Setting up automatic changing is easy and uses this command:

AUTOCHANGE: BETWEEN <hour> AND <hour> <command to apply>

Looks complicated? Not really, here are some examples ...

AUTOCHANGE: BETWEEN 10 AND 11 ALL WINDOWS COLOUR RED

AUTOCHANGE: BETWEEN 14 AND 18 PRESET 3

AUTOCHANGE: BETWEEN 22 AND 3 ALL WINDOWS ALPHA 30 INSIDE ALPHA 100 OUTSIDE WINDOWS TEXTURE

Some useful things to bear in mind ...

  • The hour specified must be in 24 hour format (so 2 is 2am; 14 is 2pm).

  • The clock used is the Second Life clock.

  • The command will be applied if the current time is after the start time and before the end time; so, in the first example above, the colour red would be applied from 10:00:01 until 10:59:59.

  • The command is smart enough to “wrap” past midnight; see the third example above, which would be applied from 22:00:01 until 02:59:59 the next morning.

  • When using autochanging, a timer runs in the controller (so a tiny amount of extra sim script resources are consumed).

  • The timer checks the Second Life time every 60 seconds; so there may be a short delay before any change is applied.

  • You can define up to 12 different autochange commands in one ‘_config’ notecard. They will be checked in order and the first that matches will be applied; so for example if you defined the following ...

    AUTOCHANGE: BETWEEN 1 AND 4 ALL WINDOWS COLOUR RED
    AUTOCHANGE: BETWEEN 3 AND 6 ALL WINDOWS COLOUR BLUE

    ... then the first would be applied until 3:59:59, after which the second would be applied until 5:59:59.



5. Defining your own colours

By editing this notecard you can define your own colours. Each line should consist of a colour name (no spaces allowed, so don't have e.g. 'Light Gray', use 'Light_Gray' or maybe be imaginative and try 'Seal'), then a space, then the vector for that colour; e.g.

Red <1,0,0>

To read up on how colour vectors work, see http://lslwiki.net/lslwiki/wakka.php?wakka=color

Remember to reset the hippoWINDOWS controller after any changes to load and apply them.



6. Tips and tricks for advanced users

  • You can pass a windows command to the hippoWINDOWS controller's parser by sending it in a linked message with num = 9000.

  • Want to add more preset buttons? The hippoWINDOWS controller (version 1.5 or higher) supports up to 8 preset buttons ...

    • You’ll find textures for buttons 5 to 8 on the backs of buttons 1 to 4.

    • To add four extra buttons, you’d just add four prims called presetButton_5, presetButton_6, presetButton_7 and presetButton_8 to the controller (ensure the root prim remains the root!) Then you’d add four new commands to the '_config' notecard ... PRESET 5: <command>, PRESET 6: <command>, PRESET 7: <command> and PRESET 7: <command>. Once that's done, just reset the controller and you're ready to go!n.

  • You can set EFFECT REST OF LINKSET to 'Yes' in a window's '_configWindow' notecard. Any commands that window gets will then be applied to every linked prim in the linkset (in other words, link all your windows together and have one WindowController script drive them all). Remember to ensure you've built things correctly so the inside and outside prim faces on each window are the same face number, or you may get some odd effects. (And note that the advanced texture commands introduced in v1.5 of hippoWINDOWS won’t work if you use the linkset control method).

  • Turn off listens entirely by changing COMMS MODE: Chat to COMMS MODE: Link on the bottom of the _config card for the controller and windows units. This will mean that rather than use chat-listen to communicate, the controller will send a linked message (with the integer value set to the channel number) with the window command in it. Any window prims in the linkset with controller scripts in will thus be able to respond.



7. Free window textures!

Want some free textures for your windows? Visit the hippoWINDOWS display in the main Hippo Technologies Store and click the texture giver; it'll give you a folder full of a few free window textures we've accumulated over the years. Feel free to pass these on to others, provided you make no charge for them (we got them free).





<< Back