Keyserver

The keyserver is a script that allows you to control the access to your lights, window tints, Radio TV and doors centrally. This can be placed in any prim in your house – a door, a switch – or you can use the sample prim which is a wall-hanging picture of a key.

To Set Up
~~~~~~~~
1> Edit the ‘keyserver setup’ notecard and change the channel numbers to match the channels of your doors, lights, Radio TV and windows etc. If in doubt, check the notecards for your doors, lights, TV and windows, and check the ‘channel’ entry. Typically your doors, lights, TV and windows will be on different channels to one another. You may have configured groups of doors and lights, using different channels, to simplify locking and unlocking doors. Add as many ‘channel’ lines as you need, each with a different channel number.

For example:-
channel=3622
channel=2080
channel=1010
channel=7910
channel=6821

2> Add the keyholders you want to the ‘keyserver setup’ notecard. You can (optionally) delete the names from the individual doors and other scripts – they only need to be in the keyserver.

If you use the special keyholder keyword ‘mygroup’, anyone in the same group as the keyserver belongs to will be able to operate it. The keyserver does not have to be deeded to the group, merely set to it. The person must have the group active – IE, with the group tag showing over their head. As an example, add this to the keyserver’s config:
keyholder=mygroup

The Keyserver will detect when you save the notecard and restart.

The Menu
~~~~~~~~
When touched, the Keyserver will present a menu. The options that appear can be renamed (or removed) by the keyserver owner using the options described in the “Notecard Options” section below.

The default menu items are:

Tints
– Select a tint level for the windows, by default these are “Light”, “Medium”, “Dark”.

Presets
– Three preset combinations of Door lock status, window tint level and lighting level. By default these are:
Not Home – Doors locked, window tint level 1, lights off
Evening – Doors unlocked, window tint level 2, lights high
Night – Doors locked, window tint level 3, lights low

Admin
– Add, remove and list names in the keyserver.
– Resend the list to the scripts (used if a script is restarted and needs to pick up the list of authorised users again)
– Reload the Keyserver config (only available to the keyserver owner)

Doors
– Lock or Unlock doors (Doors must be v4.2 or higher)

Lights
– Set the lights to high, low, or turn the lights off.

The Admin Menu — Further Explained
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Adding a keyholder
~~~~~~~~~~~~~~~
Touch the keyserver to pull up the menu, then select Add. The keyserver will prompt you to type names. Type each name into chat, one name per line. The keyserver will keep adding the names you type until you type the word ‘done’ on a blank line of chat.

It will only listen to you – the person who put it into “add” mode. If you type something that can’t be a name in SL, for example a single word, or more than two words on a line, your entry will be rejected. If you try to add someone who’s already on the list, you’ll be told that person’s already a keyholder. If you don’t make a valid entry in 60 seconds, the keyserver will timeout, broadcast the list entered so far, and go back to ‘idle’ mode.

Removing a keyholder
~~~~~~~~~~~~~~~~~
Touch the keyserver to pull up the menu, then select Remove. The keyserver will list all the current keyholders, preceeding each with an index number. Type the index number of the name you’d like to remove. The keyserver will remove that name from the list, and re-list the names. Continue until you’ve removed all the names you want, then type ‘done’ on a blank line of chat.

If you don’t make a valid entry in 60 seconds, the keyserver will timeout, broadcast the current list of keyholders, and go back to ‘idle’ mode.

Listing the keyholders
~~~~~~~~~~~~~~~~~~
Touch the keyserver to pull up the menu, then select List. The keyserver will list the current keyholders.

Restoring the original keyholders
~~~~~~~~~~~~~~~~~~~~~~~~~~
Touch the keyserver to pull up the menu, then select Reload. The keyserver will reload the list of keyholders from its notecard, and remove all the ones manually entered through chat. Note, so that rental tenants don’t hit Reload and get themselves removed from the access list, this option is available only to the Keyserver’s Owner.

Resending the Keyholders
~~~~~~~~~~~~~~~~~~~~~
Sometimes you will reset the script of a door or other device, and want to resend the keyholder list out from the keyserver without changing it. Use the Resend button to do this.

Notecard Options
~~~~~~~~~~~~~~
These options can be configured in the ‘keyserver setup’ notecard inside the Keyserver.

‘channel’
As per the “To Set Up” section above, the ‘channel=xxx’ lines list all the channels you want the keyserver to talk to. You may have separated the lights in the house into zones, or you may use slave doors on different channels. It’s not unusual for a house to use 10 different channels for the scripts to communicate. You can add as many channels to the keyserver as you need.

‘doormenu’
This option allows you to rename the ‘Doors’ button in the Keyserver, or to remove the ‘Doors’ menu if you do not want to control doors with the Keyserver.

Examples:
doormenu=none
– This would remove the ‘Doors’ button from the Keyserver menu.
doormenu=Access
– This would rename the ‘Doors’ button to ‘Access’.

‘lightmenu’
This option allows you to rename the ‘Lights’ button in the Keyserver in the same way as the ‘doormenu’ option above. Setting the lightmenu option to ‘none’ will remove the button.

‘lightlow’, ‘lighthigh’, ‘lightoff’
These options allow you to rename the Low, High and Off buttons in the light menu.

Examples:
lightlow=Dim
lighthigh=Bright
lightoff=Nitelite
…. would rename the buttons to Dim, Bright and Nitelite. You would have set up corresponding lighting levels in your light scripts to match these descriptions.

‘tintmenu’
As per the lightmenu and doormenu options, this setting allows you to rename the Tint menu, or to turn it off with tintmenu=none.

‘tint1′, ‘tint2′, ‘tint3′
As for the lightlow/high/off options, these options will rename the Tint level buttons on the Tint menu. There is one special option – tint3 may be set to ‘none’ to remove the third tint level option (as the Window script has the option to use only two settings.)

Examples:
tint1=Clear
tint2=Solid
tint3=One Way
…. would rename the buttons to Clear, Solid and One Way. You would have set up the appropriate corresponding options in the tint script to match.

‘presetmenu’
As per the other menu options, this option allows you to change or remove the ‘presets’ button. Use presetmenu=none to turn off the Presets menu.

‘preset1doors’, ‘preset2doors’, ‘preset3doors’
For each of the presets there’s a corresponding option that determines whether the doors should be locked or unlocked when that preset is selected.

Examples:
preset1doors=locked
preset2doors=unlocked
preset3doors=locked

‘preset1tint’, ‘preset2tint’, ‘preset3tint’
For each of the presets there’s a corresponding option that determines the tint level set for that preset. The levels are always referred to simply as 1, 2 or 3 for the purposes of this option.

Examples:
preset1tint=1
preset2tint=3
preset3tint=2
…. Would set the first tint when Preset 1 was selected, the third tint when preset 2 was selected, and so on.

‘preset1lights’, ‘preset2lights’, ‘preset3lights’
For each of the presets there’s a corresponding option that determines the lighting level set for that preset. The levels are always referred to as “off”, “low” and “high” for the purposes of this option.

Examples:
preset1lights=off
preset2lights=low
preset3lights=high

‘regionsay’
By default the keyserver has a 100m range. This is sufficient for most houses, and helps to ensure that your keyserver doesn’t interfere with others if you use the default channels. In some circumstances it’s desirable to increase the range of the keyserver, and setting regionsay=on will extend the keyservers range to cover the entire sim it’s in. Be sure to select your own personal channel(s) if you’re using this option.

‘keyholder’
See “To Set Up” section for information about adding keyholders directly to the keyserver setup file