CasperLet/Migration Tool

From CasperTech Wiki
Jump to navigation Jump to search

Supported Migrations

Currently this tool only supports migration from HippoRent.

What's in the box?

Inside the CasperLet crate is a box called: 

  Hippo Migration Toolkit

You can - and should - open the this Hippo Migration Toolkit box to your inventory.

Inside the Migration Toolkit box are the following: 

  Script:  Hippo Inquisitor
  Notecard:  HOW TO: Migrate your HippoRent Unit
  Object: Migration Base (DO NOT OPEN)

Do NOT open the "migration base". That particular object needs to stay intact!

Migration Requirements

The migration kit itself doesn't need to connect to the HippoRent website.

However, the HippoRent units that are web-enabled - especially for the web-only version of HippoRent - may need to contact the website in order to retrieve data to feed to the migration script. Thus, on occasions when the HippoRent website is not contactable (such as if they have a site outage), getting data FOR migration is not guaranteed to happen either.

Migration Caution

This tool is unsupported and provided only on an as-is basis, without warranty.

This tool may not move any or all of the available configuration options, if Hippo Technologies blocks any part of its actions, or if you are migrating from the web-only version of HippoRent and their website is not working.

Basically, this tool should work, and should transfer the time remaining, but if it doesn't, it's not CasperTech's responsibility (the migration tool script depends on Hippo Technologies not changing anything in their scripts) - please test it on a single unit to verify that it still works before full-scale use!

Also, be aware that Hippo Technologies may take steps to disable this functionality in future versions of the HippoRent system, as is their right.

Timesaving Tip

In the migration box are a set of textures that - along with the CasperLet script - will become part of the converted CasperLet unit.

If you want to use custom textures you may replace the ones in the Migration Base (DO NOT OPEN) itself, rather than waiting until after conversion and replacing the results one at at time.

How to Migrate Inworld-Only HippoRent

This process will completely replace all HippoRent scripts and textures with the CasperLet script and textures. This also means you will no longer have access to the rental history from the HippoRent rental units. If you want to keep your HippoRent units for archival or historical purposes, remember to "take a copy" FIRST.
  1. Rez the Migration Base somewhere on the same sim as your HippoRent unit
  2. Drop the Hippo Inquisitor script into a rental unit you want to convert
  3. Wait for the process to complete
  4. Run the latest CasperLet UpgradeBee, using the "upgrade" function, to make the CasperLet script current.

NOTE: This will need to be done on a per-unit basis only. This tool cannot migrate an entire sim/region's worth of rental units at one shot.

"Please Wait" message

The "Please wait a moment" message means one of two situations:

  1. The hippo migration base is not yet rezzed.
  2. Or the migration base has been opened/destroyed prior to use.

How to Migrate Web-Connected HippoRent

These are experimental instructions, and may not work in all situations. Always "take a copy" of a unit, then test on THAT unit to be sure the instructions will work!
  1. "Take a copy" of one unit to inventory (as backup in case of failure)
  2. Using the original copy (still rezzed inworld) of THAT unit
  3. Create a "configuration notecard" (See next section below)
  4. Set options in notecard that match the rental unit settings
  5. Edit the rental box and remove these scripts:
    • zht_WebPlugin
    • zht_WebPluginB
  6. Unpack the Migration Toolkit shipping crate
  7. Rez the Migration Base on the same sim as the unit
  8. THEN use the "Hippo Inquisitor" script in the hippo rental unit

Configuration Notecard contents

The only section you need to make adjustments to, to make them match your existing rental configuration, is:

    • Basic Settings section
      • Price per week price
      • Prims limit

The other options do NOT need changing, they are neither transferred nor needed.

Copy the contents of the code block below to a fresh notecard. Name the notecard "Configuration Notecard" and drop it in the Hippo rental unit. 

// Change these settings to configure the rental box. Lines that begin with // are comments. Don't alter text in capitals.

// SERVER

SERVER KEY: [Server's object uuid goes here, without brackets]
PASSWORD: 

PICTURE: Example Picture

// BASIC SETTINGS

NAME: My First Rental Box
PRICE PER WEEK: 50
MIN WEEKS: 1
MAX WEEKS: 6
PRIMS: 25
NOTECARD NAME: Example Description

// COMMUNICATIONS

IM ON PAYMENT: Yes
ALSO IM:
EMAIL ON PAYMENT: No
EMAIL:
SEND RENEWAL NOTICE: Yes
RENEWAL NOTICE DAYS BEFORE: 3
INCLUDE SLURL WITH IMS: Yes

// PAYMENT OPTIONS

PAYMENT BY PROXY: Yes
TERMS AND CONDITIONS: No
REFUNDS: No
REFUND IF DAYS AT LEAST: 6
REFUND SURCHARGE: 10%
EVICT AFTER DAYS IN ARREARS: 2
IN ARREARS OTHERS CAN RENT: No

// HOVERTEXT

HOVERTEXT RENTER NAME: Yes
HOVERTEXT DAYS REMAINING: Yes
HOVERTEXT COLOUR: <1, 1, 0>
AVAILABLE HOVERTEXT: Pay me to rent, click for more info
SHOW PRICE AND PRIMS WHEN AVAILABLE: Yes
HOVERTEXT PRIM COUNT: No

// APPEARANCE

CHANGE SIZE ON RENT: Yes
RENTED SIZE: <0.35, 0.35, 0.35>
CHANGE SHAPE ON RENT: Yes
CHANGE TEXTURE ON RENT: Yes
STANDARD TEXTURE: Rental Texture 1
RENTED TEXTURE: Rental Texture 2
FACE TO CHANGE: -1
PHANTOM ON RENT: No
MOVEMENT ON RENT: <0, 0, 2>
ALPHA ON RENT: 1.0

// PRIM COUNTING

PRIM WARNING IMS: None
PRIM WARNING EVERY: 1
PRIM COUNT: All
PRIMS SUBTRACT: 0
IGNORE PRIMS OWNED BY:

// TERMINOLOGY USED IN MENUS AND MESSAGES

TERMINOLOGY: Landlord, Tenant, Rent, Rental, Plot, Rental box

// ADVANCED USERS CAN, IF THEY WISH, DISABLE THE LISTENER USED FOR IN-SIM COMMUNICATIONS

DISABLE REGION SAY: No

Customising Your Rental Units

Once you are done migrating, if you wish to customise your rental units, see the instructions on this page to ensure proper functionality, including any desired texture changes with rental state changes.

Configurations The Tool Saves

At the time of this writing, this tool supports both web-enabled and non-web-enabled HippoRent boxes.

Configuration migration which is currently supported:

  • Current tenant
  • Current time remaining
  • Current Price (and USD price setting if appropriate)
  • Current Price term (Days, Weeks, Months)
  • Current Prim count / Impact Limit
  • Current "Will not renew" setting
  • Current "Auto Evict" setting
  • Current Hovertext settings
  • Current State changes: size / move / alpha on rent
  • Minimum rental term
  • Maximum rental term
  • Extra prim allowance
  • Profit shares
  • Partners (additional subtenants)

FAQ / Troubleshooting

Q. I migrated my renter information to CasperLet, but it's an older version of the CasperLet script - is this a problem?
A1. There's no harm, just use the UpgradeBee from the current shipping crate to bring them up to date. Casper just hasn't updated the CasperLet script in the migration tool yet.
A2. The CasperLet script in the migration toolkit has been updated as of May 2016 - if yours is older than 1.33, please update to get the newest migration kit.
Retrieved from "https://wiki.casperdns.com/index.php?title=CasperLet/Migration_Tool&oldid=11216"