OLD-CasperLet/Detailed Setup: Difference between revisions

From CasperTech Wiki
Jump to navigation Jump to search
mNo edit summary
 
(65 intermediate revisions by 4 users not shown)
Line 2: Line 2:
   |__TOC__
   |__TOC__
   |}
   |}
= '''<span style="color:#00528c">CasperLet Manual</span>''' =
This is the main manual page for CasperLet. If you need it, the table of contents for this page is to the right.


If you are here to see what's involved with setting up the system before buying it, you might also be interested in seeing the '''[[CasperLet/Feature_List | feature list]]''' and find out '''[[CasperLet/Introduction | whats in the box]]''', in addition to the instructions below.  
{{Warning|If you are a new landlord, or if this is your first web-networked rental system, please use the '''[[CasperLet/Quick_Start | new user quick start]]''' instead where many of these items are explained for users who are new to the concepts involved.}}


<span style="font-size:14px;">'''For fast, step-by-step instructions, see the [[CasperLet/Quick_Start | quick start page]] - however, be sure to check back here later for more detailed information.'''</span>
{{Critical|<b>DO NOT</b> under <b>ANY</b> circumstances give your CasperLet password to another person, even someone that you trust. <b>DO NOT</b> under <b>ANY</b> circumstances log in to a user account which does not belong to you. Doing so may result in your service being suspended without refund.'''}}


= '''<span style="color:#00528c">The Fine Print</span>''' =
= '''<span style="color:#00528c">Prerequisites </span>''' =
=== Prerequisites ===
This version of the manual assumes you are a very experienced SL user that knows how to unpack items, what debit permissions are for, how to put items in the contents of other items, and that you have at least some familiarity already with networked rental systems.
----
This manual assumes the following:
:* That you already have land you want to rent out
:* That you have purchased the paid version of CasperLet (The demo version only accepts payments from the demo owner, not from any tenants.)


=== Terminology ===
=== Rental Unit Versions ===
----
----  
: '''Parcel'''<br />A distinct, continuous (undivided) portion or tract of land.
Documentation on this page expects that all of your rental units are version 1.40 or later. You may see what the current versions are of everything from the '''[[Current_Versions | versions page]]'''.


: '''Tenant'''<br />a person or group that rents and occupies land, a house, an office, or the like, from another for a period of time. The tenant is the customer of the landlord.
CasperLet Rental units version 1.3x and older are '''no longer supported'''. If you have older versions rezzed out, you '''must update''' them to the current version in order to receive technical support. Simply redeliver the CasperLet cate to receive an up-to-date UpgradeBee. Any prior version Bee will not have the current version of the script.


: '''Landlord'''<br />You, the CasperLet user and land owner.
= '''<span style="color:#00528c">Your Account</span>''' =
No, you cannot (currently) use your CasperVend account username/password if you have one - CasperVend and CasperLet are using two different logins.  


= '''<span style="color:#00528c">Your Account</span>''' =
See '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | how to create (or reset) your CasperDNS Account.]]'''
No, you '''cannot''' (currently) use your CasperVend account username/password if you have one - CasperVend and CasperLet are using two different login systems.


=== Security Notes ===
= '''<span style="color:#00528c">About The Units</span>''' =  
----
=== Note on New Units ===
Protect your business by following these tips, and keep your account safe.
 
:* Choose a password which is difficult to guess.
:* Do '''''NOT''''' use your Second Life password.
:* Do '''''NOT''''' use a password you've used with any other Second Life related service, such as other vending systems.
:* Do '''''NOT''''' give your password to anyone!
 
If you have trouble coming up with a secure password on your own, you can use the '''[https://www.grc.com/passwords.htm Gibson Research High Security Password Generator]''' or if you'd rather, you can try one of the sites in '''[https://www.google.com/search?hl=en&gl=us&tbm=&authuser=0&q=password+generator&oq=password+generator this set of search results]'''.
 
If you need a "password keeper" utility on windows, you can try '''[http://passwordsafe.sourceforge.net/ Password Safe]'''
 
=== Creating Your Account ===
----
See the instructions for '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | creating your CasperDNS.com account.]]'''
 
=== Resetting / Changing Your CasperDNS Password ===
----
See the instructions for '''[[CasperVend_2/Password_Reset#Resetting_Your_CasperDNS_Password | creating your CasperDNS.com account.]]'''
 
= '''<span style="color:#00528c">Upgrading CasperLet</span>''' =
See the '''[[CasperVend_2/Updating | Updating/Upgrading]]''' page for details and instructions.
 
= '''<span style="color:#00528c">Configuring Your Units</span>''' =
=== Brand New Unit: Special Note  ===
----
----
[[File:Price_Adjustment.png|300px|thumb|left|Click to see larger image]]<br /> <br /><br /> <br /><br /> <br />
[[File:Price_Adjustment.png|300px|thumb|left|Click to see larger image]]<br /> <br /><br /> <br /><br /> <br />
Line 61: Line 31:
Most landlords will want to '''leave this UNchecked/UNticked''' when setting out a brand new rental unit.
Most landlords will want to '''leave this UNchecked/UNticked''' when setting out a brand new rental unit.


=== Units & Debit Permissions ===
=== Debit Permissions ===
----
A brand new unit will always ask for debit permissions (the big orange popup window).
 
Once you have granted debit permissions, and picked up a copy of that unit, re-rezzing a copy of THAT unit will '''not''' ask for permissions because it remembers them.
 
If you "hard reset" a unit (that is, you used the viewer's Edit mode and the menu option to "reset scripts in selection") then it will behave like a fresh unit and ask for debit permissions again.
 
For more information about debit permissions in general, see the '''[[Debit_Permissions | Debit Permissions]]''' page.
 
=== Placing Units  ===
----
If you are an estate manager on the sim/region or the owner of the group that owns the mainland parcels you will be able to rez objects on the land even if the rights are otherwise turned off. When placing rental units, it's '''always''' a good idea to turn on "view land owners" and/or "view property lines" to make sure you are placing the unit in an area where scripts will always work, and the renter will not be able to return it. Most residents will behave in this regard, but there's '''always''' going to be someone who will want to test the estate staff.
 
==== How does a unit know which parcel to track?  ====
----
When you are renting parcels on a sim, simply rez the rental unit ON the parcel you want it connected to.
 
Then you can move it off the parcel onto land where the renter can't return the rental unit, or move it to your sim's rental HQ.
 
==== What is the difference between the meter and the box?  ====
----
----
 
See the page on '''[[Debit_Permissions | Debit Permissions]]''' to understand why these are necessary.  
The meter is a flat prim designed to be left out and visible at all times. State changes do NOT include transparency for the meters.
 
The rental box allow transparency to be included in the various state changes.
 
Each type comes in a primary/master version, and a secondary/slave version.
 
There is no functional difference between a primary/master rental meter and a primary/master rental box beyond what is outlined here.
 
There is also no functional difference between a secondary/slave rental meter and a secondary/slave rental box beyond what is outlined here.
 
=== Do Not Re-Rezz A Unit ===
----
The CasperLet system currently tracks rental units by UUID once they are rezzed inworld. Once you re-rezz a rental unit, it gets a NEW UUID from the grid - and thus cannot be automatically connected with any of the information from the originally-rezzed unit on the website.
 
==== If Units Are Accidentally Returned Or Picked Up ====
----
Unfortunately, because the units are currently tracked by UUID on rez, re-rezzing them doesn't pick up old information because the website cannot currently associate the newly rezzed UUID with the old UUID.
 
Thus, if there was a tenant, you'll need to log in to the website and copy the information from the original listing and paste it into the listing for the new rental unit. Or, if there is no old listing available for the tenant, you'll have to piece it together from information in the '''[https://let.casperdns.com/transaction_history.php CasperLet transaction history]''', '''[https://let.casperdns.com/rental_log.php CasperLet Rental log]''', and/or your '''[https://accounts.secondlife.com/transaction_history/?lang=en-US SL transaction history]'''.
 
=== Do Not Edit-Shift-Drag A Copy Of a Unit ===
----
When you do that, the copy that's left behind the one you drag is the new unit - and it doesn't keep any of the configurations, it's a brand new unit (since it's newly rezzed, it has a new UUID) as far as the website is concerned.
 
=== About the Primary/Master and Secondary/Slave Units ===
----
:* Each primary/master unit can have only ONE slave unit connected to it.
:* The slave units pass commands directly to the primary/master unit - there is no separate configuration for slave units vs. primary/master units.
:* Some landlords use them to have a slave unit by the rental parcel, and a primary/master unit in a central rental hub/office type setup.
:* If you are counting prims with the prim counter, the primary/master units AND the slave units can ONLY be on the same sim/region. (Prim counter does not communicate across region boundaries.)
 
=== About the Pay Buttons ===
----
See the '''[[CasperLet/Pay_Buttons | Pay Buttons]]''' page for detailed information on how to set them up properly.
 
If you set a per-month rental rate, you need to be aware that '''not all months are 30 days'''. Rental rates will be pro-rated up or down depending on the actual length of the month in question. Remember that a week is always a week, a day is always a day, but a calendar month can have as few as 28 days, or as many as 31 days.
 
==== Configuring Individual Primary/Master Rental Unit ====
----
:* Rez a rental unit, and grant permissions.
:* Simply click (touch) the rental unit, and select "Config" from the popup menu.
:* Go to the website. '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | Create an account]]''', if necessary. Log in.
:* You will be logged in to the individual unit configuration page.
:* Change options as desired, clicking "SAVE" after '''EACH''' change - otherwise prior changes you've made on the individual unit page will be lost. 
:* If you want to count prims, then rez one prim counter for each land owner. See the '''[[CasperLet/Prim_Counter | prim counter]]''' for details.
 
==== Configuring individual Secondary/slave unit ====
----
The "slave" units can be linked to the actual CasperLet rental units, and will copy whatever the main units do. This is really useful if you want a "central" rental area on the sim/region, as well as payment boxes on each of your rental locations.
 
# Rez a "slave" unit near the actual rental unit you want it linked to.
# Click "yes" when prompted.
# It's now assigned to that rental unit, and will copy the settings and updates of that unit.
# Simply move (do '''not''' pick up!) the "slave" unit '''OR''' the main rental unit to where you want it to be
 
If you do not see particles, check:
:* Are particles on?
:* Are your graphics/particles set too low?
:* Are there a lot of other particle generating things nearby? (particle "starvation")
:* If you've been logged on for a while, your cache may be full - flush your cache and relog.
 
'''Warning:''' Slave boxes and master boxes must be located on the same sim and will not work if the slave (or master) is taken to a different sim.
 
=== Configuring all units in bulk ===
----
:* Rez at least one rental unit, and grant permissions.
:* Click/"touch" any rental unit, and select "config" from the popup menu.
:* Log in, if necessary.
:* Click the "Units" icon at the top of the page.
:* This will take you to the "bulk" units page.
:* Tick the box for each option you are changing, and make the desired change. (If you do not tick the box, the changes will not be saved...)
:* When all changes are made on the bulk page, click "save". 
:* Remember that you must have one prim counter rezzed per sim per land group in order for prim counting to work.  More on that later.
 
=== Configuring states ===
----
Configuring the states of your rental '''BOX''' and '''MESH METER''':
 
# Make sure the unit is available (not rented)
# Move the unit to where it should appear when available
# Resize and set the transparency as desired for the available state.
# Touch/click the unit, select "States" from the popup menu, then "Set Available"
# Move the unit to where it should appear when rented (max 10m distance away)
# Resize and set the transparency as desired for the rented state.
# Touch/click the unit, select "States" from the popup menu, then "Set Rented"
# Touch/click the unit again, and select "reset" on the popup menu. This will tell the rental box to switch to the "available" state, with corresponding location and appearance.
 
Configuring the states of your '''4 PRIM/2 IMPACT, RENTAL METER''':
# Make sure the unit is available (not rented).
# Move the prim where it should appear when available (10m max distance)
# Touch/click the unit, select "States" from the popup menu, then "Set Available"
# Move the prim where you want it to appear when it is rented.
# Touch/click the unit, select "States" from the popup menu, then "Set Rented"
# Touch/click the unit again, and select "reset" on the popup menu. This will tell the rental box to switch to the "available" state, with corresponding location and appearance.
 
If the renter gets evicted, the unit should automatically pick up and use the "available" state setting.
 
==== Known Issues & Limitations ====
----
:* '''ALL rental units:''' The maximum distance a unit can move, between "available" and "rented" states is 10 meters. A ticket is already in the suggestion queue to increase the limit.
:* '''PRIM rental meter:''' Unless you edit linked parts, the prim meter is already the smallest you can go. Grabbing a corner and shrinking won't work since one of the prims is already at the 0.010 smallest size.
:* '''PRIM rental meter:''' Alpha setting persists across states, and will NOT automatically change.
:* '''PRIM rental meter:''' Do '''not''' "fold down" the popup AVAILABLE sign, the meter takes care of that automatically.
 
='''<span style="color:#00528c"> Customising & Renaming Rental Units </span>'''=
See the '''[[CasperLet/Customisation | CasperLet customisation page]]'''.
 
='''<span style="color:#00528c"> Notecard delivery </span>'''=
Units will deliver notecards in different ways depending on which version they are. Please pay attention to this section, so that you don't put notecards in the wrong place.
 
Only you - the system owner - can edit and replace the notecards.
 
== Units From Version 1.19 and earlier ==
By default, these older versions ship with example notecards within the rental units. If you don't change the contents, your prospective renter will get a notecard that just says "this is an example notecard" - which is not exactly something that encourages renting, so PLEASE take the time to put some informational content in them.
:# Place two notecards into the contents of EACH rental unit; the names must end with "-Info" and "-Rented".
:# The "-Info" notecard is given when a user clicks Info in the menu.
:# The "-Rented" notecard is given when a user rents. The user can also click the unit at any time and select "Notecard" from the popup menu to get the "-Rented" notecard again.
 
It is recommended that you include some basic information about your rental, such as:
:* How much per week
:* How many prims / land impact are allowed
:* Any rules you have on rentals, what tenants can and cannot rez out, any overall business theme, etc.
:* Anything else you want to add
 
== DropBoxes From Version 1.20 to current ==
* Place your "info" and "rented" notecards in your DropBox. Under 1.20 and forward, it is no longer required to have "-Info" or "-Rented" after the name (but you can still do that, '''IF''' you want to.)
* Remember, the '''system owner''' - not any managers that may be added - is the '''ONLY''' one who can change, edit, or add notecards to a dropbox used by '''THAT''' copy of CasperLet. The system owner needs to do their best to make sure the notecards are as complete as possible from the start to avoid repetitive changes later.
 
For more information about DropBoxes, and why they need to '''stay''' rezzed out, see the page with '''[[CasperVend_2/DropBoxes | DropBox information]].
 
'''Remember:''' Scripted objects in general will not function if you do not rez them under the proper land group. DropBoxes are no exception.
 
(If you have both CasperVend and CasperLet, it '''is''' normal to see '''all''' of your notecards in the notecard selector box, regardless of whether the DropBox originally came from a CasperVend or CasperLet pack.)
 
='''<span style="color:#00528c"> Scanning Rental Units </span>'''=
See the '''[[CasperLet/Unit_Scanning | page on unit scanning]]''' for details.
 
= '''<span style="color:#00528c">Prim Counting</span>''' =
When selecting the "count prims" option, the units will now give a breakdown of each user included in the prim count so you can see which users are using which amount of prims. However, this is only if there are subtenants, or you have "count all prims" enabled. See the '''[[CasperLet/Prim_Counter | prim counter]]''' page for details and FAQ.
 
=== How To Count Prims ===
----
The landlord / managers simply need to click the rental unit, choose the '''"TENANTS"''' submenu from the first popup menu, then '''"LAND IMPACT"''' on the next popup. (for "Update Prim Count") Admins (landlord/managers) get the admin menu by default, and thus need to click into the tenant menu. Tenants will get the tenant menu by default.
 
Tenants simply click the rental unit and select '''"LAND IMPACT"'''. Tenants are '''NOT''' able to trigger a recount, so the impact they will see is effective as of the last time the prim counter checked the current prims/impact.
 
Parcel must be rented in order to count prims.
 
=== About Prim/Impact Limits ===
----
There are two aspects to prim limits. The first aspect is the prim/impact limit you allow per the terms of the rental. The second aspect is how many prims the parcel can hold. These are '''not''' necessarily the same thing.
 
If you have a shopping mall all in one land group, for example, and the renter exceeds the limit that they have paid for, they are not automatically blocked from rezzing objects. However, they - and you! - are alerted that they are over their prim limit.
 
Because the simulator treats all prims owned by a single entity (individual, group) as a pool of prims that can be used anywhere on the sim it can be difficult in some situations to ensure that your tenants cannot exceed their prim allowances.  On private estates you can subdivide the land and sell parcels to tenants, which limits their prim allowance to the prim capacity of the parcel.  On mainland this is usually impractical and almost always inadvisable.  Subdividing and then '''deeding parcels to different groups''' may be an option.  This is a management decision each landlord must make.


=== Land Notes ===
=== Land Notes ===
----
----
CasperLet doesn't - itself - care about parcels. The "prim consolidation" feature allows you to have multiple rentals on the same parcel (such as malls).
CasperLet doesn't - iteself - care about whether the land is in parcels. The "prim consolidation" feature allows you to have multiple rentals on the same parcel (such as malls or shopping events).  
 
CasperLet does not prevent rezzing - that is what land settings are for. If you need a security orb, CasperTech recommends Thomas Conover's land orb, which has full CasperLet support. A vendor for this may be found on the third floor of Casper's shop.
 
=== Ignoring A Certain Number of Prims ===
----
You need to use the "Extra Allowance" option, in order to "ignore" a certain number of prims. Commonly, you may also want to count ALL prims on a parcel, in which case you also need "Count prims belonging to ANY avatar".


Therefore, commonly you need to use these options in combination:
CasperLet does not prevent rezzing - that is what land settings are for.
# "Extra Allowance"
# "Count prims belonging to ANY avatar"


In any situation, if you want to to actually count the prims, the parcel '''must not''' be sold to the tenant. For example, malls/shopping centres and mainland rentals.
=== Parcels: Multiple or all one parcel? ===
 
'''NOTE:''' If you want to count prims ONLY on a specific parcel, and not the entire sim/region, then "Prim Consolidation" must be turned OFF.
 
= '''<span style="color:#00528c">Rental Management</span>''' =
=== Quickly Finding Tenants ===
----
----
# Log in to CasperLet
# Click '''Units''' tab
# Click '''Tenants''' at the top of the column
# This will sort all tenants in alphabetical order by first name


You can also:
CasperLet doesn't care either way. If you want to leave the land as one big parcel and invite renters to the land group (such as for a shopping mall or shopping event) you can - just drop a rental unit next to each rental location, then configure as usual.
# List the maximum # of tenants per page
# use your web browser's CTL + F (search in the page) function to find a specific name


=== Seeing Rentals-Per-Region ===
=== Placing Units ===
----
----
# Log in to CasperLet
If you are an estate manager on the sim/region or the owner of the group that owns the mainland parcels you will be able to rez objects on the land even if the rights are otherwise turned off. When placing rental units, it's '''always''' a good idea to turn on "view land owners" and/or "view property lines" to make sure you are placing the unit in an area where scripts will always work, and the renter will not be able to return it. Most residents will behave in this regard, but there's '''always''' going to be someone who will want to test the estate staff.
# Click '''Regions''' tab
# On each map tile, you'll see some colored squares
# Hover over each square to see that rental unit's status.
 
There is currently no way to group rental units other than this - however there is a feature request ticket in the queue already for unit grouping.


=== Auto-Evict Note ===
==== Moving a rental unit  ====
----
----
"Auto-Evict after ____ hours" refers to '''after''' the rent is already in arrears.
As of version CasperLet version 1.30, you are now able to pick up and re-rez a rental unit '''without''' the unit losing the current tenant configuration and information. This allows you to simply pick up the unit and then re-rez at the location you want it to be.  


=== Rental Rates Note ===
Because you've already granted debit permissions to that unit, it won't ask again when you re-rez - this is normal.
----
If you set a per-month rental rate, you need to be aware that '''not all months are 30 days'''. Rental rates will be pro-rated up or down depending on the actual length of the month in question. Remember that a week is always a week, a day is always a day, but a calendar month can have as few as 28 days, or as many as 31 days.


=== Floating Text ===
=== Security Orbs ===
----
----
Floating/hover text is turned '''off by default''' on all rental units, on account of many people finding floating text to be unsightly. You are always able to enable it at any time, on a per-unit or global/bulk basis.


Just remember to his "save" when you add or remove the floating text.
If you want/need a security orb, CasperTech now has '''[[CasperSafe_Security_Orb | CasperSafe.]]'''


When the unit is UN-rented, '''and''' floating text is enabled, the price and prim/impact limits are always shown. When rented, the unit does not show price and prim/impact limits.
Alternatively, Thomas Conover makes an excellent product called the "Land Security Orb" which has excellent features and full CasperLet support. It's cheaper than CasperSafe, but is only available with "no copy" permissions. A vendor for Conover's orb is available on the 3rd floor of Casper's shop.


=== Adding a manager ===
=== Difference Between Meters and Boxes?  ===
----
----
Currently, adding a manager can '''only''' be done globally (for all CasperLet units on your CasperLet account, regardless of where on the grid those rental units are located).


See the '''[[CasperLet/Managers | CasperLet Managers]]''' page for details on how to do this '''properly'''.
Both types allow rental state changes - showing whether a unit is available, rented, etc. - but where the box includes transparency functions, the meter does not because it's designed to be left out and visible at all times. As far as tenants are concerned, there are no functional differences between the boxes and the meters. Both will accept payments, both will show state changes.  


=== Rent Paid, But Not Updated  ===
Each type comes in a primary "Main" version and a secondary "Remote"/relay that acts as a command relay. You '''cannot''' use a "remote" unit in place of a main unit - the "remote/relay" units have no "brains" of their own, and exist solely to pass commands and responses back and forth from the primary unit it is linked to.  
----
'''OK on Website, but not inworld:'''  
: If rental payment updated properly on the website, then use '''RESET''' from the popup menu on the meter inworld to force the meter to pick up the data.  


'''You received the money, but the unit AND website never updated:'''
The main unit names are as follows:  
: Add the time manually to the unit via the website.


=== Rent Paid, But Some/All Money Refunded/Never Arrived  ===
  CasperLet Rental Box
----
  CasperLet Rental Meter
Things to check:
  CasperLet Mesh Rental Meter
# Did you set a discount for being paid x-amount of time in advance?
# Did you set profit sharing?
# Do you have fixed payments set, AND the person paying paid a non-fixed amount?
# Were they trying to pay over the maximum rental time?


=== See Time Remaining?  ===
The Remote relay unit names are as follows:
----


There are two ways to see the time remaining on your rental units.
  CasperLet Remote Relay Box
  CasperLet Remote Relay Meter


# On the website: Click "Rentals", then sort the resulting list.
= '''<span style="color:#00528c">Customising Your Rental Units</span>''' =
# To see remaining time inworld: On the website, use the "display remaining time in floating text" option when you configure your rental units.  
To create your custom rental units AND to make sure rental state changes are reflected (or not, as you choose) between rented and available states, see the '''[[CasperLet/Customisation | Rental customisation]]''' page.  


You '''may''' need to resync/reset the rental unit (using the popup menu you get when clicking the vendor) once the options are set on the website.
='''<span style="color:#00528c">Shared Land or Tenant Takes Ownership?</span>'''=


=== Viewing Rental Logs  ===
=== Tenant Takes Ownership ===
----
----
==== Via Inworld Interaction ====
:# Parcels are only "tracked" for prim counting. However, if the tenant is taking ownership of the parcel, prim counting cannot be used.
----
:# No need for prim counter (they can't use more prims than their parcel allows)
# Click rental unit and select "Config" from the popup menu
# On the CasperLet website, you should be taken right to the unit's configuration page
# On the right side, you should see that unit's transaction history


==== Via Website Only ====
=== Shared/Communal Land (Malls, etc.) ===
----
----
# Log in to CasperLet website
:# Rez the rental unit on the parcel
# Find the rental unit who's transaction log you want to check
:# Make sure the tenant's role in land group does NOT allow object return for anyone '''else's''' objects
# Click "edit" on that unit, should take you to the unit's configuration page
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' to keep track of everyone's prim/impact usage
# On the right side of the configuration page, should be that unit's transaction history


=== Sales, discounts, etc. ===
= '''<span style="color:#00528c">Configuring Your Units</span>''' =  
----
:* If all of your rental units will use the same base configuration, follow the instructions in '''[[#Bulk_Setup | "bulk setup"]]''' section.
See the '''[[CasperLet/Discounts | Discounts]]''' page for instructions.
:* If SOME of your rental units will use the same base config, but you will have SOME units with different settings, use the '''[[#Bulk_.2B_Individual_Setup | "Bulk + individual setup"]]''' section.  
:* If all of your rental units will use different configurations, use the '''[[#Individual_Unit_Setup | "individual setup"]]''' section below.  


=== Profit sharing ===
== '''<span style="color:#00528c">Special Notes</span>''' ==
=== No Rental Profiles ===
----
----
You can enable the profit sharing option in the appropriate section on both the "Units" (bulk) page, '''OR''' in the individual unit configuration page.
Currently CasperLet does not support rental profiles. If you have '''two''' or more "base configuration sets" (that are dependent on the rental), you will still need to choose '''one''' as the default, and change the rest individually - this will be using the '''[[#Bulk_.2B_Individual_Setup | bulk + individual]]''' section below.  


Remember that any profit sharing set on the general "units" page will be overwritten by any changes on the individual unit - so be absolutely certain what profit sharing you want to put where.  
A suggestion ticket '''is''' '''[https://bugs.casperdns.com/view.php?id=105 in the queue]''' to add rental profile functionality.


To set up profit sharing:
=== About Pay Buttons ===
:* Locate the profit sharing section on the configuration page
:* Click "Add New" - you'll get a popup
:* Add the percentage to share, and the SL '''legacy name/account name''' of the person to send it to (do '''NOT''' use their display name! Display names are not searchable, thus not payable!)
:* Click "Add"
:* Popup will go away and you'll see the name with the percentage next to it.
 
==== Known Limitations ====
----
----
To understand what goes in the pay buttons in the different unit configurations, see the '''[[CasperLet/Pay_Buttons | Pay Buttons]]''' page.


There are no notifications sent when someone is added or removed from profit sharing. The only way to verify is to purchase an item and check the transaction log.
== '''<span style="color:#00528c">Bulk Setup</span>''' ==
:# Rez one "Main" unit per rental, on the parcel to be tracked
:# If shared land, unit should stay on the parcel to be tracked
:# If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
:# Grant debit permissions
:# If you've customised your units, make sure they'll '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | still show rental state changes.]]'''
:# Go to '''[https://let.casperdns.com/ CasperLet website]''' and log in
:# Set your '''[https://let.casperdns.com/units.php bulk options,]''' remembering to click save on all settings.  


='''<span style="color:#00528c"> Tenant Management </span>'''=
== '''<span style="color:#00528c">Bulk + Individual Setup</span>''' ==
:# Rez one "Main" unit per rental, on the parcel to be tracked
:# If shared land, unit should stay on the parcel to be tracked
:# If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
:# Grant debit permissions
:# If you've customised your units, make sure they'll '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | still show rental state changes.]]'''
:# Go to '''[https://let.casperdns.com/ CasperLet website]''' and log in
:# Set your '''[https://let.casperdns.com/units.php bulk options,]''' remembering to click save on all settings.
:# For each rental unit that will be different from the base configuration, click that unit inworld and use the "config" option on the popup menu to get to THAT unit's configuration settings.
:# Set the individual settings as desired.


=== Maximum Tenants ===
Settings on a per-unit basis will override the global "units" page settings.  
----
There is a limit of 12 tenants (1 primary tenant + 10 additional subtenants) on any rental unit. This is based on the number of buttons on the touch/popup menu you get when clicking the rental unit inworld.


=== Transferring / Copying configuration ===
== '''<span style="color:#00528c">Individual Unit Setup</span>''' ==  
----
:# Rez one "Main" unit per rental, on the parcel to be tracked
To copy or transfer a renter or unit '''configuration''' see the instructions on the '''[[CasperLet/Transfer_Rental | Transfer Rental]]''' page.
:# If shared land, unit should stay on the parcel to be tracked
:# If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
:# Grant debit permissions
:# If you've customised your units, make sure they'll '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | still show rental state changes.]]'''
:# Click one rental unit inworld
:# Select "Config" from the popup menu
:# Log in to the CasperLet website
:# You will arrive at the individual unit configuration options. Set them as desired, and save after each change.


=== Swapping Renters ===
= '''<span style="color:#00528c">Notecard Delivery</span>''' =  
----
Only you - the system owner - can edit and replace the notecards. Managers are not able to do this.


At this time, there is no simple way to just swap renters and have the new renter take over the time remaining. This '''is''' expected to be added into the next major CasperLet release.
Managers may select different notecards from the supply that is '''already''' in the DropBox.  


You'll need to use the following steps:
You are free to name your notecards whatever you like - "information" is used here to simply refer to the notecard sent to prospective tenants before they rent, and "rented" to simply refer to the notecard that gets sent to the tenant after they rent the unit.  
# Record the time remaining on the rental unit for the current renter.
# Evict the current renter.
# Set the new renter on the rental unit.
# Manually add the time remaining back to the rental unit.


=== Physically moving units ===
=== Selecting Notecards ===
----
----
Sometimes your renters want to change parcels, or if you have multiple sims/regions, they want to move to a different sim/region in your estate. You can use the '''[[CasperLet/Transfer_Rental | transfer rental]]''' option to move your renter, or if you want to move your actual rental unit (and thus your tenant) WITHOUT losing configuration just use the following steps:
:# Place your "information" and "rented" notecards in your DropBox.  
 
:# Log in to the CasperLet website
'''''<span style="color:#F00;"> NOTE: This cannot be done with any of the MESH rental units - only with legacy prims and sculpts - this is due to an SL limitation that prevents the "Drop" of mesh items being worn. The legacy prim meter has the same prim/land impact as the mesh meter when set to convex hull.</span>'''''
:# If you have '''one''' notecard for '''all''' rentals, then select the notecard via the bulk '''[https://let.casperdns.com/units.php Units page.]'''
 
:# If you have multiple notecards for different rentals, one may be set on the bulk '''[https://let.casperdns.com/units.php Units page]''', but the rest will have to be set via the individual unit configuration pages.
:1) Right-click on the rental unit
:2) select "wear" (or, "More" then "wear" depending on your viewer) <br />You can attach about a dozen units to your avatar in this manner.
:3) Teleport to the new location
:4) Right-click, then '''"DROP"'''  
:: ''Do not use "detach" - that will detach it to your inventory, and rezzing it out will lose its configuration''
:5) Right-click and then "edit" to move the unit once it is safely dropped
:6) Touch/click the rental box and use the soft reset function from the pop-up menu. This will update the website with the rental unit's new location. 
:7) Make any changes to the rental unit's configuration that you need to for the new location and save them. 
:8) The next time the prim counter runs in the new sim/region, the relocated rental unit's prim use will be updated.
 
'''Moving your rental unit in this fashion means:'''  
:* It reports correct time remaining
:* It remembers the tenant
:* Website sees the new location almost immediately
:* Prim count will initially reflect the OLD location, but ''will'' update once the prim counter in the new sim sees the new unit.  


'''<span style="color:#F00;">Moving your rental unit in ANY OTHER fashion beyond what is described here almost guarantees loss of tenant data, but the basic box configuration should be preserved. Always check afterward to be certain.</span>'''
=== Selecting Landmarks ===
 
=== Why You Shouldn't Re-Rezz A Unit ===
----
----
The CasperLet system currently tracks rental units by UUID once they are rezzed inworld. Once you re-rezz a rental unit, it gets a '''NEW''' UUID from the grid - and thus cannot be connected with any old information.
:# Place your landmark(s) in the Dropbox
:# Log in to the CasperLet website
:# If you have '''one''' landmark to use with '''all''' of your rentals (such as a rental HQ area), then select that landmark via the bulk '''[https://let.casperdns.com/units.php Units page.]'''
:# If you have multiple landmarks for different rentals (for example, if you have one landmark per rental), they will need to be set via the individual unit configuration pages.  


See the '''[[CasperLet/Setup#Do_Not_Re-Rezz_A_Unit | explanation above]]''' for more information.
For more information about DropBoxes, and why they need to '''stay''' rezzed out, see the '''[[CasperVend_2/DropBoxes | DropBoxes page]].  


=== Customer Wants Higher Prim/Impact Limit ===
'''Remember:''' Scripted objects in general will not function if you do not rez them under the proper land group. DropBoxes are no exception.  
----
:* Calculate how much the extra prim/impact count will cost the tenant, in addition to their existing rental
:* Adjust the prim allowance on the rental unit via the website
:* Adjust the price per time period via the website
 
=== Locking Rental Units  ===
----
Sometimes landlords will need to lock rental units to prevent them from being re-rented, or in some cases, to prevent payments at all. This section details these options.
 
==== By Individual Units ====
----
# Log in to the '''[https://let.casperdns.com/ CasperLet website]'''.
# Inworld, click the individual unit you wish to lock, and let it take you to its own configuration page.  
# Under "Lock", change to "Yes" (click the "change" link on that line)


If you wish to also prevent ANY payments, then right under "lock" is the "accept payments" option - change that to "no" prevent anyone from paying on the existing rental.  
(If you have both CasperVend and CasperLet, it '''is''' normal to see '''all''' of your notecards, from both CasperVend and CasperLet, in the notecard selector box; it doesn't matter whether the DropBox originally came from a CasperVend or CasperLet pack.)


==== By Bulk Options ====
= '''<span style="color:#00528c">Prim Counting</span>''' =
----
For information on when and how to use the prim counter, and about scripted prim autoreturn, see the '''[[CasperLet/Prim_Counter | Prim Counter]]''' page.  
# Log in to '''[https://let.casperdns.com/ CasperLet website]'''.
# Under '''[https://let.casperdns.com/units.php Units]''', tick/check the boxes for the units you want to lock
# At the top of the "bulk options" section is a series of buttons.
# Click the buttons as needed to lock, and/or turn off "accept payments".
# Scroll down to the bottom and click the "Update Selected" button.


=== Reserving Rental Units ===
= '''<span style="color:#00528c">Scanning For Rental Units</span>''' =  
----
Learn how to do a rental unit scan - and its limitations - on the '''[[Website_Scans#Scanning_for_Rental_Units | scanning for rental units]]''' page.
# Click the rental unit
# Select "Config" from the popup menu
# Let it take you to the CasperLet site - you should arrive at the unit's configuration page
# Look for the '''Reserved''' line (4th line down as of September 2014)
# Enter the avatar's '''account name''' (not display name) and click "ok"
# Text will change to show that it's reserved for that specific avatar


==== Cancelling a reservation ====
= '''<span style="color:#00528c">Payments</span>''' =  
----
To cancel an existing unit reservation, just look for the "Reserved" line and click "Cancel Reservation" next to the avatar's account name.
 
=== Group Restrictions Workaround  ===
----
Currently, you cannot set CasperLet units to only be rentable by group members.
 
The workaround is:
# Use a bot with your CasperLet system (see '''[[GroupBots]]''' page for bot options)
# Set all land to be under ONE land group
# Make sure the bot is IN that land group, and has appropriate invite/eject capabilities
# Control group access with the bot - utilize the bot's blacklist function, if necessary.
 
If you have the bot set to auto-invite, then people don't need to stay in the land group all the time - they will be able to click the rental unit and select the '''"GRP INVITE"''' option from the menu to get back in the group.
 
= '''<span style="color:#00528c">Group Bots For Invites & Ejects </span>'''=
 
:# Log in to the '''[https://let.casperdns.com/ CasperLet website]'''
:# Click the "Group Bots" icon
:# You will be presented with a "Robot Army" page.
:# This page has sections for '''[[SmartBots]]''', PikkuBots and '''[[METAbolt]]'''.
:# Enter the appropriate information in for the bot system you are currently using
:# Hit save
 
For CasperLet: If the renter accidentally ignores/declines the group invite, just have them click the rental unit and choose '''"GRP INVITE"''' from the popup menu. The rental units will '''only''' invite people who are current renters.
 
=== Unsure Which Bot Option To Use? ===
----
See the '''[[GroupBots | main group bots page]]''' for explanations, comparisons and details.
 
=== Renter Group Role Suggestions ===
----
If the group land you're renting has individual parcels for each renter, be aware most people will want to/need to be able to set and change their parcel media (for radio streams, etc.) Including permission to let them set up radios and TV's in the role you invite renters to will save you some time later. Under "parcel settings" on the roles tab, this would be "change music and media settings".
 
See the '''[[GroupBots | group bots]]''' page for more details and information about the various bot options.
 
==== Group Invite Notes ====
----
If an additional tenant is added to a rental, they will also get a group invite, as long as you have automatic invites (via a bot) set up.
 
If the additional tenant leaves the group, then as long as the rental is still active that they were added to (i.e., the primary tenant hasn't been evicted / hasn't stopped renting) then they can click the rental unit at any time for a fresh group invite.
 
"Additional Tenants" is '''NOT''' the same thing as visitors. ANY person added as an additional tenant will be sent a group invite. If you want to allow renters to add visitors to locked doors, security orbs and such, you will need to utilize (or have scripted for you) a door script or security orb that allows renters to add visitors as they please without having to worry about them being added to the land group.
 
==== Known Limitations ====
----
A bot (any bot) '''cannot''' remove a tenant from the group '''IF''' they have been '''manually''' given any role other than the one they were originally invited to. The bot has no (scripted) way of knowing what additional role(s) they were granted, so there is no (scripted) way for the bot to know that it needs to remove them from the extra role(s).
 
= '''<span style="color:#00528c">Scripted Autoreturn (What Is it?)</span>''' =
See the '''[[CasperLet/Prim_Counter#Scripted_Prim_Auto-Return | scripted autoreturn section]]''' for information.
 
= '''<span style="color:#00528c">Mapper / Map Table</span>''' =
See the page with '''[[CasperLet/Mapping_Table | mapper information]]'''
 
= '''<span style="color:#00528c">Touch/Popup Menu Options</span>''' =
See the page explaining the '''[[CasperLet/Touch_Menus_on_Units | touch menu options]]''' for information about each menu item.


=== Proxy Payments ===
=== Proxy Payments ===
----
----
CasperLet will accept payments from any person, made to any rental box. If someone pays an occupied rental box they will be asked via pop-up menu to verify the payment.  Until the payment is confirmed by the person paying, you (the CasperLet system owner) will see the payment listed as:
The rental units will accept payments from anyone, not just the tenant.  
  '''''"Payment on hold - not the tenant who paid''''''.
If they do not say yes, or the menu times out (which takes roughly 10 minutes), then the person who paid will be refunded.  Time is not credited to the rental box until/unless the paying party confirms the payment.


==== Cannot Restrict By Avatar/Group ====
The units will also (currently) continue to accept payments from anyone even when set to "won't renew".  
----
No, you cannot limit which avatars, or group members, can pay the rental unit at this time.


==== Will Accept Payments Even When Set "Won't Renew" ====
=== Transaction Logs ===
----
----
Currently the CasperLet system is set to accept payments from anyone, regardless of the "won't renew" setting.
Information about transaction logs may be seen on the '''[[CasperLet/Transactions | transactions page.]]'''


There is currently a suggestion ticket in the queue to allow an additional choice of whether or not to allow the rental unit to accept payments from anyone. If you wish to monitor it, that ticket is '''[https://bugs.casperdns.com/view.php?id=1354 #1354]''' - simply log in with your CasperDNS account and click the "Monitor" button.
= '''<span style="color:#00528c">Rental Estate Management</span>''' =
 
=== Notification Messages to Tenants ===
=== Adding a manager ===
----
----
The tenant may turn on or off various notification options. If a tenant has disabled reminders you will see an alert box on the configuration page for THAT specific rental unit. (Not the bulk units page.) Once they leave, and before the unit is rented again, the website will display a yellow message of "the previous tenant has disabled reminders". It will also display this message when the tenant has chosen "won't renew" because that setting also disables reminders. These messages will still be there once the unit becomes available - but once the unit is rented again, those messages will disappear from the website.
Currently, adding a manager can '''only''' be done globally (for all CasperLet units on your CasperLet account, regardless of where on the grid those rental units are located).  


Estate owners and managers should check each rental unit's configuration page on the CasperLet website if they are truly concerned about missing what the tenant will turn off - Estate owners/managers will need to see the unit's management page to see the yellow or red flags the unit sets up on the website (they're not visible on the bulk units page, and not mentioned in the inworld messages).
See the '''[[CasperLet/Managers | CasperLet Managers]]''' page for details on how to do this '''properly'''.


These reminders are sent at fixed intervals, and are not currently configurable. '''These will always be sent - unless the tenant has either turned off notifications, or toggled the "Won't Renew" option.'''
=== Sales, Discounts, etc.===
 
==== Who gets reminders? ====
----
----
:* Primary tenant
See the '''[[CasperLet/Discounts | Discounts]]''' page for instructions.
:* CasperLet System owner
:* Additional staff, if configured


Additional '''tenants''' do not get notifications at this time, as it is the primary tenant that the system considers responsible for the rent.
=== Profit Sharing ===
 
==== Reminders sent before the tenancy ends ====
----
----


:* "Your rental has less than a week remaining."
See the '''[[CasperLet/ProfitSharing | CasperLet Profit Sharing]]''' page.
:* "Your rental has less than three days remaining."
:* "Your rental has less than two days remaining."
:* "Your rental has less than a day remaining. Please stop by soon to pay!"
:* "Your rental has less than six hours remaining. Please stop by soon to pay!"
:* "Your rental has less than two hours remaining. Please stop by soon to pay!"
:* "Your rental has less than an hour remaining. Please stop by soon to pay!"


==== Reminders sent after the tenancy has ended ====
= '''<span style="color:#00528c">Rental Office Setup</span>''' =  
----
If you wish to set up a central rental office for your rental estate, see the '''[[CasperLet/Rental_Office | rental office page.]]'''


:* "Your rental HAS NOW EXPIRED. You need to pay soon to avoid eviction."
= '''<span style="color:#00528c">Group Bots</span>''' =
:* "Your rental is now more than a day overdue. You need to pay soon to avoid eviction."
For information on setting up bots for your rental estate, see the '''[[GroupBots | group bots page.]]'''
:* "Your rental is now more than two days overdue. You need to pay soon to avoid eviction."
:* "Your rental is now more than three days overdue. You need to pay soon to avoid eviction."
:* "YOUR RENTAL IS NOW MORE THAN FOUR DAYS OVERDUE. You need to pay soon to avoid eviction."
:* "YOUR RENTAL IS NOW MORE THAN FIVE DAYS OVERDUE. You need to pay soon to avoid eviction."
:* "YOUR RENTAL IS NOW MORE THAN SIX DAYS OVERDUE. You need to pay soon to avoid eviction."
:* "YOUR RENTAL IS NOW MORE THAN A WEEK OVERDUE. You need to pay soon to avoid eviction."


=== Counting prims ===
= '''<span style="color:#00528c">Tenant Management</span>''' =  
----
The tenant simply needs to click the rental unit, and choose '''"LAND IMPACT"''' on the popup.
For all the details on various aspects of managing your renters, see the '''[[CasperLet/Managing_Tenants | tenant management page.]]'''


= '''<span style="color:#00528c">Rental Office Setup</span>''' =
= '''<span style="color:#00528c">Notification Messages to Tenants</span>''' =
'''NOTE: Rental offices are not officially supported. Consequently, your mileage may vary.'''


=== Prim Counting ===
See the '''[[CasperLet/Notifications | CasperLet Notifications]]''' page.
----
If you want to set up a centralized tier payment station with rental/tier boxes for parcels in other regions you can '''NOT''' use a prim counter (because the prim counter only talks to primary rental units that are in the same region as the prim counter.)


If you have only a single sim/region set up your tier/payment station using master/slave rental units and a deeded prim counter.
= '''<span style="color:#00528c">Mapping Table</span>''' =
See the '''[[CasperLet/Mapping_Table | mapping table page]]''' for information and limitations.
Touch/Popup Menu Options
= '''<span style="color:#00528c">Migrating From HippoRent?</span>''' =
See the '''[[CasperLet/Migration_Tool | Migration Toolkit page]]''' for instructions.  


=== Rental vendors ===
= '''<span style="color:#00528c">DIY  Script Components</span>''' =  
----
{{Critical|Both the door and sign objects (and thus their full perm scripts) are provided "As-Is", as a tool for scripters to use, without warranty, guarantee or support. This also means CasperTech is '''NOT''' under any obligation to add any new features.'''}}
See the page on '''[[CasperLet/Rental_Vendors | rental vendor integration]]''' for details


=== Transporter Integration ===
{{Information|Casper Warden requests that if you use these scripts in a more advanced product and set it up for sale that you let him know, send him a vendor for the final product, and he'll help promote it.}}
----
''Purchase of '''[[Transporter | CasperTech Transporter]]''' required, along with CasperLet, in order to utilize the Transporter integration.''


<span style="color:#F00;">  '''''NOTE: YOU NEED CASPERLET 1.15 OR HIGHER TO USE THIS FUNCTIONALITY.'''''</span>
=== Door & Sign Unsupported Samples ===
----
----


# Set the "casperlet" value in the notecard to YES, and save.
You may '''informally''' ask in the CasperTech support group if you get stuck, of course, but remember that that CasperTech will not be adding new features to these scripts - this is why they're open-source and full perm. Chances are there's a scripter in the group who might be willing to help, or you can see if there's a scripter already on your team.  
# Wait a few seconds until the notecard has finished reading.
# Touch the transporter.
# Touch the primary/main rental unit you want to link the transporter to
# Watch the stream of particles which should now be emitting from your transporter.
# Are they going to the right unit? If so, click "Yes"
# If not, click "No" and start again.
# That's it!  The transporter pad will now work in conjunction with your rental meter.


The CasperLet functionality will let ANYONE use the transporter when the unit is "available" - but ONLY the tenant(s) when it is rented.
Naturally, you're welcome to use them without restriction. To use them as-is (applies to both door and sign):
 
By default, the transporter will ONLY take them to the location of the rental meter, however you can change this by setting "ACCESSCONTROLONLY" to YES.  This will make the transporter behave as normal, except it will use the CasperLet unit to determine who can TP and who cannot. If you like, you can set "acceptpayments" to YES which will allow people to pay the transporter pad to rent the rental unit it's linked to (if it's available).
 
<span style="color:#F00;">  '''''If you have 1.21 or higher:'''''</span> <br />
----
If "acceptpayments" is enabled, the transporter will also duplicate any floating text which appears on the unit. Floating text is all-or-nothing. You can have it, or not, but you cannot limit where the floating text shows beyond simply on or off. 
 
==== Transporter is sold separately ====
----
While you may link up the Transporter with a rental unit, the transporter pack itself is '''NOT''' included in the CasperLet shipping crate. Transporter is a separate purchase.
 
==== One transporter per rental destination ====
----
You will need one transporter pad for each destination, as well as the transporter at your main location where prospective tenants will start from.
 
==== Tenant access only (when connected rental unit is rented) ====
----
# Open the "ACCESSLIST" notecard
# Change '''accesscontrolonly''' to '''YES'''
# Save the notecard
# Repeat steps for every Transporter you have connected to a rental unit
 
==== Known Transporter Issues & Limitations ====
----
: '''Q. Can I lock/pair a transporter unit to a specific rental unit?'''
:: '''A.''' Yes, but.... it will only lock/pair to a '''primary''' rental unit. If you attempt to lock/pair a transporter to a slave unit, it will actually lock/pair to the corresponding primary unit, since the slave just passes that command/click on to the primary unit.
 
: '''Q. Can I sort Transporter destinations into a certain order?'''
:: '''A.''' The Transporter does not support destination sorting at this time. The pads only sort by the order in which the units receive messages from each other.
 
: '''Q. I'm getting the error "llSetPrimitiveParams warning running rule #1 (PRIM_GLOW): PRIM_GLOW disallowed on agent."'''
:: '''A.''' You have an old version of the Transporter. Get the latest version from a handy redelivery terminal. If you use the terminal at the '''[http://maps.secondlife.com/secondlife/Izanagi/184/85/134 CasperTech store]''', it will sort all CasperTech purchases to the top of the list.
 
: '''Q. Can I have only certain destinations listed to the public?'''
:: '''A.''' This is not a feature in the Transporter because of performance issues - as it requires checking every Transporter pad to see if it can be shown to the user clicking, each time the Transporter is clicked. This makes an unacceptable delay before the menu is shown.
 
: '''Q. I've got one rental unit linked to a Transporter pad, but why I can't I link the next one?'''
:: '''A. Casper Warden:''' you can only link one rental unit per transporter
 
= '''<span style="color:#00528c">Hippo Migration Toolkit</span>''' =
Looking to migrate rental configuration information from HippoRent? See the '''[[CasperLet/Migration_Tool | Hippo migration toolkit]]''' page for details!
 
= '''<span style="color:#00528c">DIY Components</span>''' =
=== Door & Sign Samples ===
----
'''BOTH THE SIGN AND DOOR (AND THEIR SCRIPTS) ARE PROVIDED "AS-IS", AS A DEMO TOOL FOR SCRIPTORS TO USE, WITHOUT WARRANTY, GUARANTEE OR SUPPORT. THIS ALSO MEANS NO NEW FEATURES WILL BE ADDED TO THEM.'''
 
You may informally ask in the CasperTech support group if you get stuck, of course, but remember that that CasperTech will not be adding new features to these scripts - this is why they're open-source and full perm. Chances are there's a scripter in the group who might be willing to help, or you can see if there's a scripter already on your team. Naturally, you're welcome to use them without restriction.  
 
To use them as-is (applies to both door and sign):


# Rez a door or sign near a CasperLet unit
# Rez a door or sign near a CasperLet unit
Line 656: Line 248:


The door will still work from within a linkset.  
The door will still work from within a linkset.  
  ''Casper Warden requests that if you use these scripts in a more advanced product<br />and set it up for sale that you let him know, and he'll help promote it.''


==== Changing Sign Texture ====
==== Changing Sign Texture ====
Line 668: Line 258:
# If customer drags the wrong texture, they need to repeat steps 3 and 4 to change the texture.
# If customer drags the wrong texture, they need to repeat steps 3 and 4 to change the texture.


If the message on click changes to '''''"This store is available! If you pay the rental meter below..."''''' then the CasperLet system owner needs to fix.
If the message on click changes to '''''"This store is available! If you pay the rental meter below..."''''' then the CasperLet system owner needs to fix the sign.
 
'''NOTE:''' The sign reads the UUID of the texure, therefore the tenant needs to actually mark the '''next owner''' permissions as copy, modify AND transfer - because while a texture they uploaded is always full perms to themselves, dragging it on to the sign triggers the "next owner" permissions, which are '''not''' full perm by default (and thus prevents getting the UUID.)


=== CasperLet API ===
=== CasperLet API ===

Latest revision as of 01:05, 14 February 2023

If you are a new landlord, or if this is your first web-networked rental system, please use the new user quick start instead where many of these items are explained for users who are new to the concepts involved.
DO NOT under ANY circumstances give your CasperLet password to another person, even someone that you trust. DO NOT under ANY circumstances log in to a user account which does not belong to you. Doing so may result in your service being suspended without refund.

Prerequisites

This version of the manual assumes you are a very experienced SL user that knows how to unpack items, what debit permissions are for, how to put items in the contents of other items, and that you have at least some familiarity already with networked rental systems.

Rental Unit Versions


Documentation on this page expects that all of your rental units are version 1.40 or later. You may see what the current versions are of everything from the versions page.

CasperLet Rental units version 1.3x and older are no longer supported. If you have older versions rezzed out, you must update them to the current version in order to receive technical support. Simply redeliver the CasperLet cate to receive an up-to-date UpgradeBee. Any prior version Bee will not have the current version of the script.

Your Account

No, you cannot (currently) use your CasperVend account username/password if you have one - CasperVend and CasperLet are using two different logins.

See how to create (or reset) your CasperDNS Account.

About The Units

Note on New Units


Click to see larger image







As you can see in this image, when you click "change" to change the rental price, you will also get an additional option:

 Adjust time remaining on unit appropriately

Most landlords will want to leave this UNchecked/UNticked when setting out a brand new rental unit.

Debit Permissions


See the page on Debit Permissions to understand why these are necessary.

Land Notes


CasperLet doesn't - iteself - care about whether the land is in parcels. The "prim consolidation" feature allows you to have multiple rentals on the same parcel (such as malls or shopping events).

CasperLet does not prevent rezzing - that is what land settings are for.

Parcels: Multiple or all one parcel?


CasperLet doesn't care either way. If you want to leave the land as one big parcel and invite renters to the land group (such as for a shopping mall or shopping event) you can - just drop a rental unit next to each rental location, then configure as usual.

Placing Units


If you are an estate manager on the sim/region or the owner of the group that owns the mainland parcels you will be able to rez objects on the land even if the rights are otherwise turned off. When placing rental units, it's always a good idea to turn on "view land owners" and/or "view property lines" to make sure you are placing the unit in an area where scripts will always work, and the renter will not be able to return it. Most residents will behave in this regard, but there's always going to be someone who will want to test the estate staff.

Moving a rental unit


As of version CasperLet version 1.30, you are now able to pick up and re-rez a rental unit without the unit losing the current tenant configuration and information. This allows you to simply pick up the unit and then re-rez at the location you want it to be.

Because you've already granted debit permissions to that unit, it won't ask again when you re-rez - this is normal.

Security Orbs


If you want/need a security orb, CasperTech now has CasperSafe.

Alternatively, Thomas Conover makes an excellent product called the "Land Security Orb" which has excellent features and full CasperLet support. It's cheaper than CasperSafe, but is only available with "no copy" permissions. A vendor for Conover's orb is available on the 3rd floor of Casper's shop.

Difference Between Meters and Boxes?


Both types allow rental state changes - showing whether a unit is available, rented, etc. - but where the box includes transparency functions, the meter does not because it's designed to be left out and visible at all times. As far as tenants are concerned, there are no functional differences between the boxes and the meters. Both will accept payments, both will show state changes.

Each type comes in a primary "Main" version and a secondary "Remote"/relay that acts as a command relay. You cannot use a "remote" unit in place of a main unit - the "remote/relay" units have no "brains" of their own, and exist solely to pass commands and responses back and forth from the primary unit it is linked to.

The main unit names are as follows:

  CasperLet Rental Box 
  CasperLet Rental Meter
  CasperLet Mesh Rental Meter

The Remote relay unit names are as follows:

  CasperLet Remote Relay Box
  CasperLet Remote Relay Meter

Customising Your Rental Units

To create your custom rental units AND to make sure rental state changes are reflected (or not, as you choose) between rented and available states, see the Rental customisation page.

Shared Land or Tenant Takes Ownership?

Tenant Takes Ownership


  1. Parcels are only "tracked" for prim counting. However, if the tenant is taking ownership of the parcel, prim counting cannot be used.
  2. No need for prim counter (they can't use more prims than their parcel allows)

Shared/Communal Land (Malls, etc.)


  1. Rez the rental unit on the parcel
  2. Make sure the tenant's role in land group does NOT allow object return for anyone else's objects
  3. Use a prim counter to keep track of everyone's prim/impact usage

Configuring Your Units

  • If all of your rental units will use the same base configuration, follow the instructions in "bulk setup" section.
  • If SOME of your rental units will use the same base config, but you will have SOME units with different settings, use the "Bulk + individual setup" section.
  • If all of your rental units will use different configurations, use the "individual setup" section below.

Special Notes

No Rental Profiles


Currently CasperLet does not support rental profiles. If you have two or more "base configuration sets" (that are dependent on the rental), you will still need to choose one as the default, and change the rest individually - this will be using the bulk + individual section below.

A suggestion ticket is in the queue to add rental profile functionality.

About Pay Buttons


To understand what goes in the pay buttons in the different unit configurations, see the Pay Buttons page.

Bulk Setup

  1. Rez one "Main" unit per rental, on the parcel to be tracked
  2. If shared land, unit should stay on the parcel to be tracked
  3. If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
  4. Grant debit permissions
  5. If you've customised your units, make sure they'll still show rental state changes.
  6. Go to CasperLet website and log in
  7. Set your bulk options, remembering to click save on all settings.

Bulk + Individual Setup

  1. Rez one "Main" unit per rental, on the parcel to be tracked
  2. If shared land, unit should stay on the parcel to be tracked
  3. If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
  4. Grant debit permissions
  5. If you've customised your units, make sure they'll still show rental state changes.
  6. Go to CasperLet website and log in
  7. Set your bulk options, remembering to click save on all settings.
  8. For each rental unit that will be different from the base configuration, click that unit inworld and use the "config" option on the popup menu to get to THAT unit's configuration settings.
  9. Set the individual settings as desired.

Settings on a per-unit basis will override the global "units" page settings.

Individual Unit Setup

  1. Rez one "Main" unit per rental, on the parcel to be tracked
  2. If shared land, unit should stay on the parcel to be tracked
  3. If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
  4. Grant debit permissions
  5. If you've customised your units, make sure they'll still show rental state changes.
  6. Click one rental unit inworld
  7. Select "Config" from the popup menu
  8. Log in to the CasperLet website
  9. You will arrive at the individual unit configuration options. Set them as desired, and save after each change.

Notecard Delivery

Only you - the system owner - can edit and replace the notecards. Managers are not able to do this.

Managers may select different notecards from the supply that is already in the DropBox.

You are free to name your notecards whatever you like - "information" is used here to simply refer to the notecard sent to prospective tenants before they rent, and "rented" to simply refer to the notecard that gets sent to the tenant after they rent the unit.

Selecting Notecards


  1. Place your "information" and "rented" notecards in your DropBox.
  2. Log in to the CasperLet website
  3. If you have one notecard for all rentals, then select the notecard via the bulk Units page.
  4. If you have multiple notecards for different rentals, one may be set on the bulk Units page, but the rest will have to be set via the individual unit configuration pages.

Selecting Landmarks


  1. Place your landmark(s) in the Dropbox
  2. Log in to the CasperLet website
  3. If you have one landmark to use with all of your rentals (such as a rental HQ area), then select that landmark via the bulk Units page.
  4. If you have multiple landmarks for different rentals (for example, if you have one landmark per rental), they will need to be set via the individual unit configuration pages.

For more information about DropBoxes, and why they need to stay rezzed out, see the DropBoxes page.

Remember: Scripted objects in general will not function if you do not rez them under the proper land group. DropBoxes are no exception.

(If you have both CasperVend and CasperLet, it is normal to see all of your notecards, from both CasperVend and CasperLet, in the notecard selector box; it doesn't matter whether the DropBox originally came from a CasperVend or CasperLet pack.)

Prim Counting

For information on when and how to use the prim counter, and about scripted prim autoreturn, see the Prim Counter page.

Scanning For Rental Units

Learn how to do a rental unit scan - and its limitations - on the scanning for rental units page.

Payments

Proxy Payments


The rental units will accept payments from anyone, not just the tenant.

The units will also (currently) continue to accept payments from anyone even when set to "won't renew".

Transaction Logs


Information about transaction logs may be seen on the transactions page.

Rental Estate Management

Adding a manager


Currently, adding a manager can only be done globally (for all CasperLet units on your CasperLet account, regardless of where on the grid those rental units are located).

See the CasperLet Managers page for details on how to do this properly.

Sales, Discounts, etc.


See the Discounts page for instructions.

Profit Sharing


See the CasperLet Profit Sharing page.

Rental Office Setup

If you wish to set up a central rental office for your rental estate, see the rental office page.

Group Bots

For information on setting up bots for your rental estate, see the group bots page.

Tenant Management

For all the details on various aspects of managing your renters, see the tenant management page.

Notification Messages to Tenants

See the CasperLet Notifications page.

Mapping Table

See the mapping table page for information and limitations. Touch/Popup Menu Options

Migrating From HippoRent?

See the Migration Toolkit page for instructions.

DIY Script Components

Both the door and sign objects (and thus their full perm scripts) are provided "As-Is", as a tool for scripters to use, without warranty, guarantee or support. This also means CasperTech is NOT under any obligation to add any new features.
Casper Warden requests that if you use these scripts in a more advanced product and set it up for sale that you let him know, send him a vendor for the final product, and he'll help promote it.

Door & Sign Unsupported Samples


You may informally ask in the CasperTech support group if you get stuck, of course, but remember that that CasperTech will not be adding new features to these scripts - this is why they're open-source and full perm. Chances are there's a scripter in the group who might be willing to help, or you can see if there's a scripter already on your team.

Naturally, you're welcome to use them without restriction. To use them as-is (applies to both door and sign):

  1. Rez a door or sign near a CasperLet unit
  2. Touch/click it
  3. Click the CasperLet unit you want to link the door and/or sign to
  4. Click "Yes" on the popup menu
  5. Now click the CasperLet unit once more to send the most recent data
  6. The door and/or sign should now function as any door and/or sign would, save that it will automatically restrict itself to the current CasperLet tenant when rented.

The door will still work from within a linkset.

Changing Sign Texture


  1. Link the sign to the rental unit.
  2. Customer pays the rental unit to begin a rental.
  3. Customer clicks sign, gets "Please HOLD DOWN CONTROL and drag the texture..." message.
  4. Customer then CTL + drags the proper texture over to the sign.
  5. If customer drags the wrong texture, they need to repeat steps 3 and 4 to change the texture.

If the message on click changes to "This store is available! If you pay the rental meter below..." then the CasperLet system owner needs to fix the sign.

NOTE: The sign reads the UUID of the texure, therefore the tenant needs to actually mark the next owner permissions as copy, modify AND transfer - because while a texture they uploaded is always full perms to themselves, dragging it on to the sign triggers the "next owner" permissions, which are not full perm by default (and thus prevents getting the UUID.)

CasperLet API


See the CasperLet API page for details.

FAQ / Troubleshooting

See the CasperLet FAQ page.