OLD-CasperLet/Detailed Setup: Difference between revisions

From CasperTech Wiki
Jump to navigation Jump to search
(→‎Configuring all rental units in bulk: - This is just wrong :) hehe)
mNo edit summary
 
(249 intermediate revisions by 4 users not shown)
Line 3: Line 3:
   |}
   |}


= '''<span style="color:#00528c">Introduction</span>''' =
{{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.}}
The goal of this system is to provide you with a feature rich, stable, good looking rental network with very low resource usage. You'll be able to use this system to rent your stores, parcels, streams, or anything else you like! It's so fast and SO EASY you'll be up and running in no time. With only 1 SCRIPT per rental unit, by switching to CasperVend you're guaranteed to have a much less laggy sim!


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


= '''<span style="color:#00528c">Getting Started: Overview</span>''' =
= '''<span style="color:#00528c">Prerequisites </span>''' =
:* Rez a rental unit.
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.
:* Touch/click the unit. You'll get a popup menu.
:* 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.
:* Set the various configuration options such as rate, prim/impact limits, etc. on the individual page for that rental unit.
:* Click "save" after each change.
:* If you want to count prims, then rez one prim counter for each land owner. See the [[CasperLet/Prim_Counter | prim counter]] page for specific process.


= '''<span style="color:#00528c">What's In The Crate?</span>''' =
=== Rental Unit Versions ===
For details on what comes in the shipping crate, see the [[CasperLet/Introduction | Introduction]] page.
----
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]]'''.


= '''<span style="color:#00528c">Creating An Account</span>''' =
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.
See how to [[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | create an account on CasperDNS]] as well as reset your password.


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


'''NOTE:''' If you expect to be physically moving your units at any point, see the '''[[CasperLet/Setup#Physically_Moving_Units | physically moving units]]''' section below for restrictions and instructions.
See '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | how to create (or reset) your CasperDNS Account.]]'''


==== Configuring primary rental unit ====
= '''<span style="color:#00528c">About The Units</span>''' =  
=== Note on New Units ===
----
----
:* Rez a rental unit, and grant permissions.
[[File:Price_Adjustment.png|300px|thumb|left|Click to see larger image]]<br /> <br /><br /> <br /><br /> <br />
:* 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 all rental units in bulk ====
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 ===
----
----
:* Rez at least one rental unit, and grant permissions.
See the page on '''[[Debit_Permissions | Debit Permissions]]''' to understand why these are necessary.  
:* 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". 
:* If you want to count prims, then rez one [[CasperLet/Prim_Counter | prim counter]] for each land owner.


==== Configuring "slave" rental unit ====
=== Land Notes ===
----
----
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.  
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).  


# Rez a "slave" unit near the actual rental unit you want it linked to.
CasperLet does not prevent rezzing - that is what land settings are for.  
# 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:  
=== Parcels: Multiple or all one parcel? ===
:* 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.


==== Counting prims ====
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 ===
----
----
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 additional tenants, or you have "count all prims" enabled. See the [[CasperLet/Prim_Counter | prim counter]] page for details and FAQ.
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.


= '''<span style="color:#00528c">Adding a Manager</span>''' =
==== Moving a rental unit  ====
Currently, adding a manager can '''only''' be done globally (for all CasperLet units in all sims/regions).  
----
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.  


This is a TWO STEP process, as follows:
Because you've already granted debit permissions to that unit, it won't ask again when you re-rez - this is normal.


'''STEP ONE''' <br />
=== Security Orbs ===
# Have your manager register for their own [https://let.casperdns.com/ CasperDNS] account
----
# It is *very* helpful if they sign up as their SL account name, rather than a random other name - however they should <span style="color:#F00;">'''NEVER'''</span> use a password that is in use for any other service, it should always be a unique password <br />(see how to [[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | create an account on CasperDNS]] for details)
# Once they've done so, have them tell you the name they signed up under
# Log in to YOUR CasperLet account
# click the "Managers" icon
# On the "Managers" page, click "Add a Manager"
# Enter the CasperDNS user name your new manager gave you, and click OK
# You will then be taken to a permissions page - you'll see three blocks of items, color coded for risk level
# Tick the options you want THAT manager to have, and click "save permissions" at the bottom.


<span style="color:#F00;">'''Be very certain you trust the manager if you are granting medium or high risk permissions!'''</span>
If you want/need a security orb, CasperTech now has '''[[CasperSafe_Security_Orb | CasperSafe.]]'''  


'''STEP TWO''' <br />
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.
# Your manager logs in to THEIR CasperDNS account
# They need to go to the [https://let.casperdns.com/managers.php CasperLet Managers tab]
# If there is a selection of landlord names, they need to pick the section with your name.  
# Then they need to add themselves using the '''''Managing someone else's CasperLet system? [Add your own avatars to this account]''''' link.


<span style="color:#F00;">'''If the wrong avatar was added in THIS area, it will need Casper's intervention to remove. So be VERY CAREFUL!'''</span>
=== Difference Between Meters and Boxes?  ===
----


= '''<span style="color:#00528c">Discounts for Renters</span>''' =
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.  
See the [[CasperLet/Discounts | Discounts]] page for details.


= '''<span style="color:#00528c">Website Configuration Options</span>''' =
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.  
See the page on [[CasperLet/Unit_Configuration | unit configuration]] or the page on [[CasperLet/Bulk_Configuration | bulk configuration]] for details of what you can do.


= '''<span style="color:#00528c">Profit Sharing Options</span>''' =
The main unit names are as follows:  
You can enable the profit sharing option in the appropriate section on both the "Units" (bulk) page, '''OR''' in the individual unit configuration page.


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.
  CasperLet Rental Box
  CasperLet Rental Meter
  CasperLet Mesh Rental Meter


To set up profit sharing:  
The Remote relay unit names are as follows:  
:* 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 account name of the person to send it to
:* Click "Add"
:* Popup will go away and you'll see the name with the percentage next to it.


= '''<span style="color:#00528c">Configuring States</span>''' =
  CasperLet Remote Relay Box
Configuring the states of your rental '''BOX''' and '''MESH METER''':
  CasperLet Remote Relay Meter


# Make sure the unit is available (not rented)
= '''<span style="color:#00528c">Customising Your Rental Units</span>''' =
# Move the unit to where it should appear when available
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.  
# 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 "soft 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''':
='''<span style="color:#00528c">Shared Land or Tenant Takes Ownership?</span>'''=
# 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.
=== Tenant Takes Ownership ===
----
:# 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)


==== Limitations ====
=== Shared/Communal Land (Malls, etc.) ===
----
----
:* '''ALL rental units:''' The maximum distance a unit can move, between "available" and "rented" states is 10 meters. A ticket is in the queue to increase the limit.
:# Rez the rental unit on the parcel
:* '''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.
:# Make sure the tenant's role in land group does NOT allow object return for anyone '''else's''' objects
:* '''PRIM rental meter:''' Alpha setting persists across states, and will NOT automatically change.
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' to keep track of everyone's prim/impact usage
:* '''PRIM rental meter:''' Do '''not''' "fold down" the popup AVAILABLE sign, the meter takes care of that automatically.


= '''<span style="color:#00528c">Transferring Renter/Config Information</span>''' =
= '''<span style="color:#00528c">Configuring Your Units</span>''' =  
To learn how to copy or transfer a renter or unit configuration see the '''[[CasperLet/Transfer_Rental | Transfer Rental]]''' page.
:* If all of your rental units will use the same base configuration, follow the instructions in '''[[#Bulk_Setup | "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_.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.  


= '''<span style="color:#00528c">Physically Moving Units</span>''' =
== '''<span style="color:#00528c">Special Notes</span>''' ==
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:
=== 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_.2B_Individual_Setup | bulk + individual]]''' section below.


'''<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 detaching of worn mesh items. The legacy prim meter has the same land impact as the mesh meter.</span>'''
A suggestion ticket '''is''' '''[https://bugs.casperdns.com/view.php?id=105 in the queue]''' to add rental profile functionality.


:1) Right-click on the rental unit  
=== About Pay Buttons ===
:2) select "wear" (or, "More" then "wear" depending on your viewer)
----
:3) Teleport to the new location
To understand what goes in the pay buttons in the different unit configurations, see the '''[[CasperLet/Pay_Buttons | Pay Buttons]]''' page.
: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:'''  
== '''<span style="color:#00528c">Bulk Setup</span>''' ==
:* It reports correct time remaining
:# Rez one "Main" unit per rental, on the parcel to be tracked
:* It remembers the tenant
:# If shared land, unit should stay on the parcel to be tracked
:* Website sees the new location almost immediately
:# If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
:* Prim count will initially reflect the OLD location, but '''will'' update once the prim counter in the new sim sees the new unit.  
:# 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:#F00;">Moving your rental unit in ANY OTHER fashion beyond what is described here is NOT guaranteed to keep the configuration! </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.


= '''<span style="color:#00528c">Configuring Textures</span>''' =
Settings on a per-unit basis will override the global "units" page settings.  
Customising your rental unit textures is easy! Simply:
# Take a copy of the textures out of the unit
# Save them to your hard drive
# Edit them (or use them as templates) to your liking
# Upload the new versions to SL
# Replace the textures in the rental units. That's it!


Remember that each respective texture needs to use the appropriate name:  
== '''<span style="color:#00528c">Individual Unit Setup</span>''' ==
:* "TEX-available"
:# Rez one "Main" unit per rental, on the parcel to be tracked
:* "TEX-overdue"
:# If shared land, unit should stay on the parcel to be tracked
:* "TEX-rented"
:# If tenant takes ownership, the rental unit should be moved off to a different parcel so it can't be returned by the tenant.
:* "TEX-overlimit"
:# Grant debit permissions
:* "TEX-locked"
:# If you've customised your units, make sure they'll '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | still show rental state changes.]]'''
:* "TEX-reserved"
:# 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.


If you are using the flat meter, there will also be these additional textures (and your replacements for this will also need to match these names):
= '''<span style="color:#00528c">Notecard Delivery</span>''' =
:* METER-days
Only you - the system owner - can edit and replace the notecards. Managers are not able to do this.
:* METER-hours
:* METER-minutes
:* METER-months
:* METER-weeks
:* METER-years


= '''<span style="color:#00528c">Texture and Color Changing</span>''' =
Managers may select different notecards from the supply that is '''already''' in the DropBox.  
For the '''rental box''' and '''mesh meter''':
:* Textures must '''also''' be full perm (to YOU, the system owner) in order to properly display them,
:* The rental unit itself '''must''' retain either the "box@<span style="color:#00528c">''(text)''</span>" or "m@<span style="color:#00528c">''(text)''</span>" at the '''beginning''' of the description field on the unit.  


If you remove that, the textures will not change, no matter what else you do. Please note that the “<span style="color:#00528c">''(text)''</span>” in the description can be anything; but something MUST be in the description field after the @ or texture changing will not work correctly. ''(The 4 prim/2 impact '''prim''' meter does NOT have this description requirement.)''
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.  


Use "m@" for the flat meters, and "box@" for the boxes, and be sure to add text after each.
=== Selecting Notecards ===
----
:# Place your "information" and "rented" notecards in your DropBox.
:# Log in to the CasperLet website
:# 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.


= '''<span style="color:#00528c">Renaming Units</span>''' =
=== Selecting Landmarks ===
Rename your units inworld, then touch/click them and select "reset" from the menu. Or you can reset the scripts manually. Just do '''NOT''' pick up and re-rez.
----
:# 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.  


= '''<span style="color:#00528c">Configuring the Door & Sign</span>''' =
For more information about DropBoxes, and why they need to '''stay''' rezzed out, see the '''[[CasperVend_2/DropBoxes | DropBoxes page]].  
This applies to the sample door and sign that is included within the CasperLet shipping crate.  


BOTH THE SIGN AND DOOR (AND THEIR SCRIPTS) ARE PROVIDED "AS-IS", WITHOUT WARRANTY OR SUPPORT. You may informally ask in the CasperTech support group if you get stuck, of course. Chances are there's a scripter who might be willing to help. Naturally, you're welcome to use them without restriction.  
'''Remember:''' Scripted objects in general will not function if you do not rez them under the proper land group. DropBoxes are no exception.  


To use them as-is:
(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.)


# Rez a door or sign near a CasperLet unit
= '''<span style="color:#00528c">Prim Counting</span>''' =
# Touch/click it
For information on when and how to use the prim counter, and about scripted prim autoreturn, see the '''[[CasperLet/Prim_Counter | Prim Counter]]''' page.  
# Click the CasperLet unit you want to link the door and/or sign to
# Click "Yes" on the popup menu
# Now click the CasperLet unit once more to send the most recent data
# 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.  
= '''<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.  


''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, and he'll help promote it.''
= '''<span style="color:#00528c">Payments</span>''' =


= '''<span style="color:#00528c">Group Bots</span>''' =
=== Proxy Payments ===
See the '''[[GroupBots | group bots]]''' page for more information.
----
 
The rental units will accept payments from anyone, not just the tenant.  
= '''<span style="color:#00528c">Scripted Auto-Return</span>''' =


See the '''[[CasperLet/Prim_Counter#Scripted_Prim_Auto-Return | Scripted Auto-Return]]''' section for more information.
The units will also (currently) continue to accept payments from anyone even when set to "won't renew".  


= '''<span style="color:#00528c">Mapper</span>''' =
=== Transaction Logs ===
 
==== About the Mapper ====
----
----
The mapper will show a "mini map" of your sim/region, taking the picture (when rezzed) from whatever is current on Linden Lab's servers. The picture on the mapping table is effectively around water level - the unit beacons themselves are capable of showing rentals in a 3D space, if allowed to use a height range above the table.  
Information about transaction logs may be seen on the '''[[CasperLet/Transactions | transactions page.]]'''


Available units are shown in green and rented units are shown in black on the mapping table.
= '''<span style="color:#00528c">Rental Estate Management</span>''' =
 
==== Customising the table ==== 
=== Adding a manager ===
----
----
You can change the "height modifier" by changing the description of the mapper table - If you set it to 0.00, all units will appear flat on the table. The scale is 1% of actual height.  
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).  


: For example:
See the '''[[CasperLet/Managers | CasperLet Managers]]''' page for details on how to do this '''properly'''.
:: A scale of 1.0 would mean that a unit at 4000m would show 40m above the table
:: A scale of 0.1 would mean that a unit at 4000m would show 4m above the table
:: A scale of 0.0 would mean that a unit at 4000m would show 0m above the table


You can resize the table, rotate it or move it, and the indicators will move into place within 60 seconds.  
=== Sales, Discounts, etc.===
   
Indicators may also be resized by touching/clicking the table and using the +Scale or -Scale buttons on the popup menu.
 
==== Customising the Beacon Indicators ====
----
----
To change the textures on the indicators:
See the '''[[CasperLet/Discounts | Discounts]]''' page for instructions.
:# Rez the "MapBeacon" object from the mapper contents
:# Put texture in its inventory just like you would for CasperLet boxes
:# Delete the OLD "MapBeacon" out of the mapper's physical contents under "edit" mode.
:# "Take" the new MapBeacon with your modified textures
:# Put the new MapBeacon into the mapper's contents.  


==== Limitations ====
=== Profit Sharing ===
----
----
Map tiles (the sim/region's land picture) will '''not''' update automatically - Linden Lab removed that feature. You will need to update your sim/region map on the mapper table manually with any changes you want to see reflected on the map.


You can try picking up and re-rezzing the mapping table - it should pick up the current map on re-rez, and will automatically pick up the current status for all rental units in the sim/region.
See the '''[[CasperLet/ProfitSharing | CasperLet Profit Sharing]]''' page.


==== Paying the Beacon Indicators ====
= '''<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.]]'''
Indicators may be touched, and paid, just like the actual CasperLet unit. (Each beacon automatically connects to the main rental units it sees on the sim/region.) You currently can '''not''' customise the Mapper's beacon pay buttons, however the renter '''can''' type in the amount they need to pay, and pay their normal rent that way from the mapping table.


If the renter uses the pre-configured pay buttons from the mapper beacon, they will get a '''pro-rated''' amount of time added to their rental, '''unless''' you have "fixed payments" turned on.
= '''<span style="color:#00528c">Group Bots</span>''' =
For information on setting up bots for your rental estate, see the '''[[GroupBots | group bots page.]]'''


= '''<span style="color:#00528c">Notecard Delivery</span>''' =
= '''<span style="color:#00528c">Tenant Management</span>''' =  
==== Version 1.19 and prior ====
----
For all the details on various aspects of managing your renters, see the '''[[CasperLet/Managing_Tenants | tenant management page.]]'''
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:  
= '''<span style="color:#00528c">Notification Messages to Tenants</span>''' =
:* 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


==== Version 1.20 and forward ====
See the '''[[CasperLet/Notifications | CasperLet Notifications]]''' page.
----
* Place your "info" and "rented" notecards in your DropBox. Under 1.20 and forward, they do NOT need to have "-Info" or "-Rented" after the name (but you can still do that, if it makes them easier for you to find in the notecard list.)
* Remember, you are the '''ONLY''' one who can change or edit the notecards. Do your best to make sure they're as complete as possible from the start so that you don't need to keep making changes later.


(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">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.  


= '''<span style="color:#00528c">Notifications</span>''' =
= '''<span style="color:#00528c">DIY  Script Components</span>''' =  
You can choose to enable notifications for you and/or your manager(s).  
{{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.'''}}


The "Staff" option in the notification section simply refers to both system owner AND managers, BUT it will only send to which ever ones are ticked.
{{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.}}


To troubleshoot issues with notifications, see the [[CasperLet/FAQ#Notification_Issues | Notifications]] section in the CasperLet FAQ.
=== Door & Sign Unsupported Samples ===
----


= '''<span style="color:#00528c">Rental Office?</span>''' =
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.  
If you want to set up a rental office in one sim/region, with parcels in other regions, you can '''NOT''' use a prim counter (because the prim counter only talks to main rental units that are in the same region.)


Set up your rental unit for the parcel as normal. Add a "slave" unit to the same parcel, if you wish, then follow the instructions on [[CasperLet/Setup#Physically Moving Units|Safely moving your rental units]] to move the main unit to its final location in your rental office.
Naturally, you're welcome to use them without restriction. To use them as-is (applies to both door and sign):


If you have only a single island, then you can use a prim counter, with a rental HQ in one location on that sim.
# Rez a door or sign near a CasperLet unit
# Touch/click it
# Click the CasperLet unit you want to link the door and/or sign to
# Click "Yes" on the popup menu
# Now click the CasperLet unit once more to send the most recent data
# 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.  


= '''<span style="color:#00528c">Rental Vendor</span>''' =
The door will still work from within a linkset.
See the page on [[CasperLet/Show_Parcels | rental vendor integration]] for details


= '''<span style="color:#00528c">Transporter Link</span>''' =
==== Changing Sign Texture ====
----


<span style="color:#F00;">  '''''NOTE: YOU NEED CASPERLET 1.15 OR HIGHER TO USE THIS FUNCTIONALITY.'''''</span>
# Link the sign to the rental unit.
# Customer pays the rental unit to begin a rental.
# Customer clicks sign, gets '''''"Please HOLD DOWN CONTROL and drag the texture..."''''' message.
# Customer then CTL + drags the proper texture over to the sign.
# If customer drags the wrong texture, they need to repeat steps 3 and 4 to change the texture.


# Set the "casperlet" value in the notecard to YES, and save.
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.
# Wait a few seconds until the notecard has finished reading.
# Touch the transporter.
# Touch the 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.
'''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.)


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).
=== CasperLet API ===
 
----
<span style="color:#F00;">  '''''If you have 1.21 or higher:'''''</span> <br />
See the '''[[CasperLet/API | CasperLet API]]''' page for details.
If "acceptpayments" is enabled, the transporter will also duplicate any floating text which appears on the unit.
 
= '''<span style="color:#00528c">CasperLet API</span>''' =
See the [[CasperLet/API | CasperLet API]] page for details.
 
= '''<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">FAQ / Troubleshooting</span>''' =
= '''<span style="color:#00528c">FAQ / Troubleshooting</span>''' =
See the [[CasperLet/FAQ|complete FAQ page]].
See the '''[[CasperLet/FAQ | CasperLet FAQ page.]]'''

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.

Retrieved from "https://wiki.casperdns.com/index.php?title=OLD-CasperLet/Detailed_Setup&oldid=15246"