View source for CasperLet/Migration Tool

{|align=right
  |__TOC__
  |}
   
== '''<span style="color:#00528c">Supported Migrations</span>''' ==
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!

== '''<span style="color:#00528c">Migration Requirements</span>''' ==

The migration kit '''itself''' doesn't need to connect to the &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; website. 

However, the &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; '''units''' that are web-only versions will need to contact the website '''unless you use the workaround below'''. 

=== Migration Caution ===
----
{{Critical|This tool is ''unsupported'' and provided only on an as-is basis, without warranty. <br /><br />

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 &#072;&#105;&#112;&#112;&#111;&#032;&#084;&#101;&#099;&#104;&#110;&#111;&#108;&#111;&#103;&#105;&#101;&#115; 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 &#072;&#105;&#112;&#112;&#111;&#032;&#084;&#101;&#099;&#104;&#110;&#111;&#108;&#111;&#103;&#105;&#101;&#115; may take steps to disable this functionality in future versions of the &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; system, as is their right.

== '''<span style="color:#00528c">Timesaving Tip</span>''' ==
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 '''[[CasperLet/Customisation#Customising_Existing_Textures | 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.

== '''<span style="color:#00528c">How to Migrate Inworld-Only &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; </span>''' ==

{{Warning|This process will completely replace all &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; scripts and textures with the CasperLet script and textures. This also means you will no longer have access to the rental history from the &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; rental units. If you want to keep your HippoRent units for archival or historical purposes, remember to "take a copy" FIRST.}}

# Rez the Migration Base somewhere on the same sim as your &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; unit
# Drop the Hippo Inquisitor script into a rental unit you want to convert
# Wait for the process to complete
# 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: 

:# The hippo migration '''base''' is not yet rezzed.
:# Or the migration base has been opened/destroyed prior to use.

== '''<span style="color:#00528c">How to Migrate Web-Only &#072;&#105;&#112;&#112;&#111;&#082;&#101;&#110;&#116; </span>''' ==
{{Critical|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!'''}} 

=== Remove the web-only scripts ===
----

#"Take a copy" of one unit to inventory (as backup in case of failure)
#Using the '''original''' copy (still rezzed inworld) of THAT unit
#Edit the rental box and remove these scripts: 
#* zht_WebPlugin 
#* zht_WebPluginB
# Create a HippoRent configuration notecard (see next section)
# Then customise the configuration notecard with information specific to YOUR rental(s).

=== Create the Notecard ===
----
:# Copy the contents of the code block below to a fresh notecard in your inventory, and save it. 
:# Rename the notecard "'''Configuration Notecard'''" 
:# (Instructions continue below the code block)

 <nowiki>
// 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
</nowiki>

=== Adjust For Your Rental Information ===
----

You will need to make the appropriate changes to the "Configuration Notecard" you just created depending on what YOUR rental configuration was changed to for regular use. 

Here is what the 2.0 version of the "Hippo Inquisitor" script actually looks for (If yours is older, please redeliver your CasperLet pack for an updated version! It will save you headaches!):

Tenant Information: 
:* Name of tenant (if rented)
:* Avatar key of tenant (if rented)
:* Time remaining on rental (if rented)

Rental Information
:* Name of rental unit
:* Price per week
:* Prim Limit
:* Minimum Rental Term
:* Maximum Rental Term
:* Autoevict after....
:* Prim Allowance

State Changes
:* Unrented size
:* Size on rent
:* Movement on rent
:* Alpha on rent
:* Original Size

== '''<span style="color:#00528c">Customising Your Rental Units</span>''' ==

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

== '''<span style="color:#00528c">Configurations The Tool Saves</span>''' ==

At the time of this writing, this tool supports both inworld '''and''' web-only HippoRent boxes, as long as you've made the '''[[CasperLet/Migration_Tool#Remove_the_web-only_scripts | necessary modifications]]''' to the web-only 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)

== '''<span style="color:#00528c">FAQ / Troubleshooting</span>''' ==
: '''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.