[.Shuggles.] Shuicraft Portal Version 0.50

The Shuicraft Portal script implements a self-organizing grid-wide ad-hoc portal network.
It uses keys with different roles and access permissions to allow or deny certain portals
being used. The portals keep a list of known portals: all the portals in the same region
and the ones the user keys send to them when a user teleports. Users are teleported to
the selected destination in the correct position and orientation.

The package includes a TP (teleport) script that needs to go into an attachment that all
portal users have to wear. This script will ask permission to teleport only once and then
remembers it, so the portals can teleport the user without asking again. It will also
remember the last 10 portals it has been to (plus the current one), based on their name,
and update other portals it visits with the stored destinations.

Please note, there is currently no deletion of portals that have been removed. If you
want to delete obsolete portals from the list, you currently need to reset the scripts.
Also, if a portal is moved or rotated, first time the user lands on the old position
before it updates its information.

To setup, put the Shuicraft Portal script into your portal object and the TP script into
a key object, which can be a HUD or any other attachment. The package comes with simple
examples - you should make your own portals and keys, though. The name of the portal goes
into its description field, the keys go into the description field of the key object.
The region name is automatically added to the portal name. You can also add prims to the
portal that serve as buttons for the following actions:

If the button is named "Key" and has "key_name" in its description field, it will hand
out a key object from its inventory called "key_name". If you omit "key_name", it will
give the first object it finds. This only makes sense for public keys.
If the button is named "Dest" and has "dest_name" (destination portal name) in its
description field, it will set the destination. If you omit "dest_name", it will show
a menu with all destinations (using Greek letters on the menu buttons).
Button names are case-insensitive, key and destination names are case-sensitive.

To obtain the keys, let the user select a destination (for public keys, you can do that
yourself) and be within 10m of the portal. It will output a list of keys in local chat
to the owner, separated by dashes, for example:

PFXXDwJY-plRRXXIP-RAQXX1EH-rgBSUXXQ-MAQOXxFR

- 1st key, starting with P, is a user-bound private key for just this destination
- 2nd key, starting with p, is a public key for just this destination
- 3rd key, starting with R, is a user-bound private key for all portals in the region
- 4th key, starting with r, is a public key for all portals in the region
- 5th key, starting with M, is a user-bound private master key for all public portals

Public portals are portals whose names do not start with a dot. Public keys (not user-
bound) can still be used for non-public portals, e.g. to allow portals to hand out keys
to a group of users that are allowed access. Only master keys cannot be used for them.

Please note, these keys do not prevent access to a target destination, just like a normal
teleport via landmark is also possible. So if you want to completely limit access, you
still need to use other means like land permissions or security orbs.

You can put one or more keys into the description field of the key object you give to
the user, also separated by dashes. A public key can be used by all users, the others
are user-bound. The master key should be reserved for you, but of course it depends on
your use case. Only users with a correct key can teleport to the destination portal.

The Shuicraft Portal script is copy only. The TP script is copy and transfer to allow
giving keys away. They're licensed under the BSD license with the addition that they must
not be resold or otherwise given away standalone in parts or as whole. They can be used
in your creations as long as these license conditions are met. The TP script should be
changed to copy only, so that your users can't give the keys away, unless you want that.

To update or redeliver a product, wear the included Updater and follow the instructions.
Store policies and info about custom scripting at my MP store and the inworld terminals.

• Grid-wide portal network
• Ad-hoc and self-organizing
• Public and user-bound keys
• Individual portals, region-wide or all
• Copy and partly trans, BSD license