OLD-CasperLet/Quick Start: Difference between revisions

From CasperTech Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(98 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Information|Please take the time to thoroughly read the entire page so that you have a better understanding of how the system works.'''}}
{{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.'''}}
{|align=right
{|align=right
   |__TOC__
   |__TOC__
   |}
   |}


= '''<span style="color:#00528c">Quick Start</span>''' =
= '''<span style="color:#00528c">New User Information</span>''' =
 
The following text assumes that you are new to the concept of networked rental systems in general (not just CasperLet), and thus explains both the fundamental concepts as well as the steps necessary to set up the system.
 
=== Creating your CasperLet Account ===
----
See the '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | CasperLet account creation section]]'''.
 
=== Terminology ===
----
: '''Parcel'''<br />A distinct, continuous (undivided) portion or tract of land. 
 
: '''DropBox'''<br />The dropbox stores and dispenses your various rental information notecards and landmarks. See '''[[CasperLet/Quick_Start#About_the_DropBox | About the Dropbox]]''' for details.
 
: '''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.
 
: '''Landlord'''<br />You, the CasperLet account holder and land owner.
 
: '''Manager'''<br />The people that help the landlord manage rentals.
 
=== Rental Unit Is Not A Sign ===
----
Please remember "sign" is '''not''' another word for rental unit, and you '''WILL''' confuse the support staff if you refer to a rental unit as a sign!
 
There is an actual sign object in the CasperLet shipping crate that can be used WITH a rental - but it is not a rental unit by itself, and it must be linked TO a rental unit.
 
The actual sign is not supported - the script is full perm - but the rental units ARE - so this is why it's important to refer to rental units with the correct term.
 
=== Rental Units At A Glance ===
----
To see your rentals at-a-glance, use the '''[https://let.casperdns.com/regions.php Regions]''' page. You will be shown pictures of your sims, with boxes showing where on the region your units are located.
 
If you have deleted units inworld via "edit > delete", they will still appear here until they are cleared off with a '''[[Website_Scans#Scanning_for_Rental_Units | site scan for units]]'''.
 
=== 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 '''[[Current_Versions | 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.
 
=== Rental Unit Rates Note ===
----
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.
 
=== Automated Messages Cannot Be Changed ===
----
Automated messages that the system sends out '''cannot''' be changed or removed at this time.
 
= '''<span style="color:#00528c">Quick Start Sections</span>''' =
 
If '''SOME''' of your rental units will use the same base config, but you will have '''SOME''' units with different settings (i..e, different size stores in a mall, or skyboxes versus whole parcels), use the '''[[#Bulk_.2B_Individual_Setup | "Individual + Bulk setup"]]''' section.
 
If all of your units will '''all''' use the '''same''' configuration (identical stores in a mall, identical skybox rentals, etc.) use the '''[[CasperLet/Quick_Start#Bulk_Setup | Bulk setup]]''' section.
 
Otherwise, use the "individual setup" steps below.
 
=== Setup Limitation ===
----
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.
 
=== Pay Buttons ===
----
To understand what goes in the pay buttons in the different unit configurations, see the '''[[CasperLet/Pay_Buttons | Pay Buttons]]''' page.
 
== '''<span style="color:#00528c">Individual Unit Setup</span>''' ==
=== 1) Unpack your CasperLet shipping crate ===
----
: ''If you're curious, you can see a list of '''[[CasperLet/Introduction | what's in the box]]''' with links to explain some of the included tools. ''
 
=== 2) Rez one main (NOT the remote relay) rental unit PER RENTAL ===
----
: ''If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.''
 
: ''If you are planning to use the mapper table, please read the '''[[CasperLet/Mapping_Table | Mapper table]]''' page.''
 
: ''If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.''
 
: The object names of the primary/master units to use are as follows:
  ''CasperLet Rental Box ''
  ''CasperLet Rental Meter''
  ''CasperLet Mesh Rental Meter''  (this will have a white & grey background, not black)
 
: ''Units with "remote relay" in the name are strictly a command '''relay''' object. They do not store settings '''at all''', and you cannot use them in place of a primary/master unit.
 
==== ''Parcels and when parcel tracking is necessary'' ====
----
The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.
 
Parcels are only "tracked" for prim counting. '''If you do not use prim counting''' (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.
 
If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' and make sure it is properly rezzed and deeded as per the prim counter page.
:# Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.
 
==== ''Manager handling your setup?'' ====
----
''Rez out all the units that are needed - or drag-copy as many as you need - '''NOW''' before the configuration process begins!
 
=== 3) Grant debit permissions ===
----
: ''See the '''[[Debit_Permissions | debit permissions]]''' page to details of what these are and why they should be granted.''
 
: <span style="color:#F00;">''NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal. ''</span>
 
=== 4) Recognize rented state changes? ===
----
: ''Follow the instructions on the '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | CasperLet customisation page]]''' to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not change between rented and available states. ''
 
=== 5) Go to CasperLet website and log in ===
----
: ''Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.''
 
=== 6) Set your different individual settings ===
----
: ''For '''each''' unit you want different from your base defaults, you will need to:
::# Click that specific unit
::# Select "config" from the popup menu
::# Arrive at the individual unit's configuration page
::# Make your changes
::# Remember to click "save" for each option with a "save" button
::# Remember to click "save" at the bottom when done
 
== '''<span style="color:#00528c">Individual Setup + Bulk Setup</span>''' ==
=== About the Units page ===
----
The '''[https://let.casperdns.com/units.php Units page]''' is also frequently called the "bulk", "global settings", or "global defaults" page, and also is the page referred to when you see "bulk setup" in the documentation. The "units" page controls the base configuration for all of your rental units.


These are the simplified instructions for people who have never used CasperLet (or any other networked rental system) before. As you will soon see, it's really really easy!
If you have '''any''' units that will have a different configuration than the default, they will need to be configured on a per-unit basis - individual unit configuration will override the global defaults where they differ. 
&nbsp;


CasperLet currently does not support rental "profiles" for rental units. (A suggestion ticket '''is''' in the queue for it, however, and it is expected to be added at some point in the future.)


: '''<big>1) Unpack your CasperLet shipping crate </big>'''
=== 1) Unpack your CasperLet shipping crate ===
----
----
: ''If you wish, you can see a list of '''[[CasperLet/Introduction | what's in the box]]''' with links to explain some of the tools in there. ''
: ''If you're curious, you can see a list of '''[[CasperLet/Introduction | what's in the box]]''' with links to explain some of the included tools. ''


&nbsp;
=== 2) Rez one main rental unit (NOT a remote relay) PER RENTAL ===
: '''<big>2) Rez a new primary/master rental unit </big>'''
----
----
: ''If the tenant will TAKE OWNERSHIP of the parcel (such as with land sales on an island estate) then the rental unit must NOT be on the parcel they're taking ownership of. This also means prim counting won't work.''
: ''If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.''
 
: ''If you are planning to use the mapper table, please read the '''[[CasperLet/Mapping_Table | Mapper table]]''' page.''


: ''If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.''
: ''If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.''


    '''The object names of the primary/master units are as follows:'''
: The object names of the primary/master units to use are as follows:
        ''CasperLet Rental Box ''
  ''CasperLet Rental Box ''
        ''CasperLet Prim Rental Meter''
  ''CasperLet Rental Meter''
        ''CasperLet Mesh Rental Meter''
  ''CasperLet Mesh Rental Meter'' (this will have a white & grey background, not black)
 
: ''Units with "remote relay" in the name are strictly a command '''relay''' object. They do not store settings '''at all''', and you cannot use them in place of a primary/master unit.
 
==== ''Parcels and when parcel tracking is necessary'' ====
----
The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.
 
Parcels are only "tracked" for prim counting. '''If you do not use prim counting''' (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.


&nbsp;
If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' and make sure it is properly rezzed and deeded as per the prim counter page.
:# Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.


: '''<big>3) Grant debit permissions </big>'''
==== ''Manager handling your setup?'' ====
----
----
: ''See the '''[[Debit_Permissions | debit permissions]]''' page for details of what these are and why they should be granted.''
''Rez out all the units that are needed - or drag-copy as many as you need - '''NOW''' before the configuration process begins!
: <span style="color:#F00;">'''''NOTE:''' If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal. You will, however, still need to reconfigure the re-rezzed unit - re-rezzing loses old configurations.''</span>


&nbsp;
=== 3) Grant debit permissions ===
: '''<big>4) Configuring a lot at once? Having a manager do most of the work?</big>'''
----
----
: ''Rez out all the units - or drag-copy as many as you need - '''NOW''' before you start the config process!''
: ''See the '''[[Debit_Permissions | debit permissions]]''' page to details of what these are and why they should be granted.''


&nbsp;
: <span style="color:#F00;">''NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal. ''</span>


: '''<big>5) Do you want the rental unit textures to change with rented/available/etc?</big>'''
=== 4) Recognize rented state changes? ===
----
----
: ''Follow the instructions on the '''[[CasperLet/Customisation#Getting_Textures_.26_Colors_To_Change' | CasperLet customisation page]]''' to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, textures '''will not change''' with rental states.
: ''Follow the instructions on the '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | CasperLet customisation page]]''' to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not show changes between rented and available states. ''


&nbsp;
=== 5) Go to CasperLet website and log in ===
----
: ''Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.''


: '''<big>6) Click the unit and select "Config" from the popup menu </big>'''
=== 6) Set your bulk settings ===
----
----
: ''Simply click ("touch") the rental unit, and select "Config" from the popup menu.''
: ''Go to the '''[https://let.casperdns.com/units.php Units]''' page when logged in, and set your options. Remember to click "SAVE" anytime you have a "save" option on a setting, and then use the "save" button at the BOTTOM of the bulk page as well.  
 
: ''This means change only ONE option at a time, and when you have a "save" button for that option, click "save" once it's set!''


&nbsp;
=== 7) Set your different individual settings ===
: '''<big>7) Let it take you to the website</big>'''
----
----
: ''Using the link from the rental unit means this will take you to the page where you can set the unit's options, once you are logged in. For example, price, auto-evict, etc.
: ''For '''each''' unit you want different from your base defaults, you will need to:
::# Click that specific unit
::# Select "config" from the popup menu
::# Arrive at the individual unit's configuration page
::# Make your changes
::# Remember to click "save" for each option with a "save" button
::# Remember to click "save" at the bottom when done


&nbsp;
== '''<span style="color:#00528c">Bulk Setup</span>''' ==
: '''<big>8) Create a CasperDNS account (NOT CasperVend) if necessary. Otherwise, just log in. </big>'''
=== About the Units page ===
----
----
: ''You can find instructions on how to create a CasperDNS account on the '''[[CasperVend_2/Password_Reset#Creating_Your_CasperDNS.com_Account | passwords page]]'''.
The '''[https://let.casperdns.com/units.php Units page]''' is also frequently called the "bulk", "global settings", or "global defaults" page, and also is the page referred to when you see "bulk setup" in the documentation. The "units" page controls the base configuration for all of your rental units.
 
If you have '''any''' units that will have a different configuration than the default, they will need to be configured on a per-unit basis - individual unit configuration will override the global defaults where they differ. 
 
CasperLet currently does not support rental "profiles" for rental units. (A suggestion ticket '''is''' in the queue for it, however, and it is expected to be added at some point in the future.)


&nbsp;
=== 1) Unpack your CasperLet shipping crate ===
: '''<big>9) Set desired configuration options, saving each change.</big>'''
----
----
: <span style="color:#F00;">'''''IMPORTANT: Change only ONE option at a time, and when you have a "save" button for that option, click "save" once it's set!'''''</span>
: ''If you're curious, you can see a list of '''[[CasperLet/Introduction | what's in the box]]''' with links to explain some of the included tools. ''


= '''<span style="color:#00528c">Renaming Rental Units</span>''' =
=== 2) Rez one main rental unit (NOT a remote relay) PER RENTAL ===
&nbsp;
: '''<big>1) From in-world, change the name of the rental unit</big>'''
----
----
: ''There is no option to change the name from the website at this time.''
: ''If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.''
&nbsp;
 
: '''<big>2) Click the unit, select "reset" from popup menu</big>'''
: ''If you are planning to use the mapper table, please read the '''[[CasperLet/Mapping_Table | Mapper table]]''' page.''
 
: ''If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.''
 
: The object names of the primary/master units to use are as follows:
  ''CasperLet Rental Box ''
  ''CasperLet Rental Meter''
  ''CasperLet Mesh Rental Meter''  (this will have a white & grey background, not black)
 
: ''Units with "remote relay" in the name are strictly a command '''relay''' object. They do not store settings '''at all''', and you cannot use them in place of a primary/master unit.
 
==== ''Parcels and when parcel tracking is necessary'' ====
----
----
: ''The website needs to pick up the new name from the unit, not the other way around - this is why the menu reset (or "soft reset") is necessary. '''DO NOT''' just pick up and re-rez or you will lose the configuration!''
The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.
&nbsp;
 
: '''<big>3) Repeat for each unit to rename</big>'''
Parcels are only "tracked" for prim counting. '''If you do not use prim counting''' (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.
 
If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' and make sure it is properly rezzed and deeded as per the prim counter page.
:# Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.
 
==== ''Manager handling your setup?'' ====
----
''Rez out all the units that are needed - or drag-copy as many as you need - '''NOW''' before the configuration process begins!
 
=== 3) Grant debit permissions ===
----
: ''See the '''[[Debit_Permissions | debit permissions]]''' page to details of what these are and why they should be granted.''
 
: <span style="color:#F00;">''NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal. ''</span>
 
=== 4) Recognize rented state changes? ===
----
: ''Follow the instructions on the '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | CasperLet customisation page]]''' to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not change between rented and available states. ''
 
=== 5) Go to CasperLet website and log in ===
----
----
: ''For each rental unit you want to rename, simply repeat steps 1 and 2 in this section.''
: ''Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.''


= '''<span style="color:#00528c">Counting Prims</span>''' =
=== 6) Set your bulk settings ===
&nbsp;
: '''<big>Rez one prim counter per land owner (NOT per avatar)</big>'''
----
----
: ''See the '''[[CasperLet/Prim_Counter | prim counter]]''' page for usage details, proper setup, and limitations. Group-owned land requires the prim counter to be deeded to that group. Land owned by an individual, but "set" to a group, does NOT require deeding.''
: ''Go to the '''[https://let.casperdns.com/units.php Units]''' page when logged in, and set your options. Remember to click "SAVE" anytime you have a "save" option on a setting, and then use the "save" button at the BOTTOM of the bulk page as well.  


: ''If you want to see an overview of where your units are inworld, you can click on the '''''Regions''''' icon when logged in on the CasperLet website.''
: ''This means change only ONE option at a time, and when you have a "save" button for that option, click "save" once it's set!''


: '''<big>No prim count in rental unit hover text</big>'''
='''<span style="color:#00528c">Shared Land or Tenant Takes Ownership?</span>'''=
 
=== Tenant Takes Ownership ===
----
----
:# Rez the rental unit ON the parcel - this tells the unit which parcel UUID to track
:# Wait a few seconds for it to pick up the parcel's UUID
:# Move the rental unit off the tenant's parcel and onto land that you control
:# No need for prim counter (they can't use more prims than their parcel allows)


: ''As part of the low-lag goals of CasperLet, the prim counter only counts prims every 3 or 6 hours, depending on whether it's an older or newer version. As a result, the hovertext over the rental unit will NOT show the prim count, ever, because it is not updated dynamically (but rather on a lengthy timed basis), and would thus otherwise cause confusion.''
=== Shared/Communal Land (Malls, Vending Events, etc.) ===
----
:# Rez the rental unit on the parcel
:# Wait a few seconds for it to pick up the parcel's UUID
:# Make sure the tenant's role in land group does NOT allow object return for anyone '''else's''' objects
:# Use a '''[[CasperLet/Prim_Counter | prim counter]]''' to keep track of everyone's prim/impact usage


= '''<span style="color:#00528c">Frequently Used Options</span>''' =
='''<span style="color:#00528c"> Notecard delivery </span>'''=
You can also...
: ...Read about '''[[CasperLet/Detailed_Setup#About_the_Primary.2FMaster_and_Secondary.2FSlave_Units | "slave Units"]]'''
: ...See how to '''[[CasperLet/Detailed_Setup#Transferring_.2F_Copying_configuration | transfer a renter's configuration]]''' from one unit to another
: ...See how to '''safely''' - physically, inworld - '''[[CasperLet/Detailed_Setup#Physically_moving_units | move a rental unit]]'''
: ...Set different '''[[CasperLet/Discounts | discounts]]'''
: ...Set '''[[CasperLet/Detailed_Setup#Configuring_states | different states]]''' (positions, transparencies, etc.) for your rental units depending on whether they're available or rented
: ...Learn how to '''[[CasperLet/Detailed_Setup#Customising_.26_Renaming_Rental_Units | customise the different rental unit textures]]'''
: ...See how to properly '''[[CasperLet/Managers | add a manager to CasperLet]]'''
: ...Learn how to get '''[[CasperLet/Detailed_Setup#Notecard_delivery | notecards set up for delivery]]'''


&nbsp;
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 refer to the notecard sent to prospective tenants, and "rented" to refer to the notecard that gets sent to the tenant after they rent the unit.
 
=== About the DropBox ===
----
The DropBox contains the notecards and landmarks for your rentals. Notecards are given in two situations. One, when a user clicks for "Info" and Two, when a tenant pays for a rental.
 
One DropBox '''per''' CasperLet system Owner is required. Having duplicates on at least one additional sim/region is '''highly''' recommended to work around sim/region communication issues.
 
See '''[[CasperVend_2/DropBoxes | DropBoxes]]''' for full details and instructions on how to deploy and use the DropBox.
 
See the below for detailed instructions on how to properly set up notecards.
 
=== 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.
 
=== Selecting Landmarks ===
----
:# 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">More Advanced Options</span>''' =
For more information about DropBoxes, and why they need to '''stay''' rezzed out, see the '''[[CasperVend_2/DropBoxes | DropBoxes page]].


When you are ready to take advantage of the many additional options in CasperLet, such as transporter integration and setting up rental hubs, see the '''[[CasperLet/Detailed_Setup | complete user manual]]'''.  
'''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 need help with your CasperLet system, please see the '''[[CasperVend_2/Getting Help|Getting Help]]''' page for information on how to get in touch with us.
(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, regardless of whether the DropBox originally came from a CasperVend or CasperLet pack.)


Thanks for using CasperLet!
= '''<span style="color:#00528c">How do I....?</span>''' =
:* '''[[CasperLet/Customisation#Renaming_units | Rename rental units]]'''
:* '''[[CasperLet/Prim_Counter | Count prims / allow tenant to count their prims]]'''
:* '''[[CasperLet/Managing_Tenants#Transfer_Rental| Transfer a tenant from one rental to another]]'''
:* '''[[CasperLet/Discounts | Set discounts]]'''
:* '''[[CasperLet/Customisation#Showing_Rental_State_Changes_Automatically | Get units to show rented state changes]]'''
:* '''[[CasperLet/Managers | Properly add a manager]]'''
:* '''[[CasperLet/Detailed_Setup#Transporter_Integration | Link the Transporter to rental units]]'''

Latest revision as of 00:58, 14 February 2023

Please take the time to thoroughly read the entire page so that you have a better understanding of how the system works.
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.

New User Information

The following text assumes that you are new to the concept of networked rental systems in general (not just CasperLet), and thus explains both the fundamental concepts as well as the steps necessary to set up the system.

Creating your CasperLet Account

See the CasperLet account creation section.

Terminology

Parcel
A distinct, continuous (undivided) portion or tract of land.
DropBox
The dropbox stores and dispenses your various rental information notecards and landmarks. See About the Dropbox for details.
Tenant
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.
Landlord
You, the CasperLet account holder and land owner.
Manager
The people that help the landlord manage rentals.

Rental Unit Is Not A Sign

Please remember "sign" is not another word for rental unit, and you WILL confuse the support staff if you refer to a rental unit as a sign!

There is an actual sign object in the CasperLet shipping crate that can be used WITH a rental - but it is not a rental unit by itself, and it must be linked TO a rental unit.

The actual sign is not supported - the script is full perm - but the rental units ARE - so this is why it's important to refer to rental units with the correct term.

Rental Units At A Glance

To see your rentals at-a-glance, use the Regions page. You will be shown pictures of your sims, with boxes showing where on the region your units are located.

If you have deleted units inworld via "edit > delete", they will still appear here until they are cleared off with a site scan for units.

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.

Rental Unit Rates Note

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.

Automated Messages Cannot Be Changed

Automated messages that the system sends out cannot be changed or removed at this time.

Quick Start Sections

If SOME of your rental units will use the same base config, but you will have SOME units with different settings (i..e, different size stores in a mall, or skyboxes versus whole parcels), use the "Individual + Bulk setup" section.

If all of your units will all use the same configuration (identical stores in a mall, identical skybox rentals, etc.) use the Bulk setup section.

Otherwise, use the "individual setup" steps below.

Setup Limitation

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.

Pay Buttons

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

Individual Unit Setup

1) Unpack your CasperLet shipping crate

If you're curious, you can see a list of what's in the box with links to explain some of the included tools.

2) Rez one main (NOT the remote relay) rental unit PER RENTAL

If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.
If you are planning to use the mapper table, please read the Mapper table page.
If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.
The object names of the primary/master units to use are as follows:
  CasperLet Rental Box 
  CasperLet Rental Meter
  CasperLet Mesh Rental Meter  (this will have a white & grey background, not black)
Units with "remote relay" in the name are strictly a command relay object. They do not store settings at all, and you cannot use them in place of a primary/master unit.

Parcels and when parcel tracking is necessary

The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.

Parcels are only "tracked" for prim counting. If you do not use prim counting (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.

If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:

  1. Use a prim counter and make sure it is properly rezzed and deeded as per the prim counter page.
  2. Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.

Manager handling your setup?

Rez out all the units that are needed - or drag-copy as many as you need - NOW before the configuration process begins!

3) Grant debit permissions

See the debit permissions page to details of what these are and why they should be granted.
NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal.

4) Recognize rented state changes?

Follow the instructions on the CasperLet customisation page to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not change between rented and available states.

5) Go to CasperLet website and log in

Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.

6) Set your different individual settings

For each unit you want different from your base defaults, you will need to:
  1. Click that specific unit
  2. Select "config" from the popup menu
  3. Arrive at the individual unit's configuration page
  4. Make your changes
  5. Remember to click "save" for each option with a "save" button
  6. Remember to click "save" at the bottom when done

Individual Setup + Bulk Setup

About the Units page

The Units page is also frequently called the "bulk", "global settings", or "global defaults" page, and also is the page referred to when you see "bulk setup" in the documentation. The "units" page controls the base configuration for all of your rental units.

If you have any units that will have a different configuration than the default, they will need to be configured on a per-unit basis - individual unit configuration will override the global defaults where they differ.

CasperLet currently does not support rental "profiles" for rental units. (A suggestion ticket is in the queue for it, however, and it is expected to be added at some point in the future.)

1) Unpack your CasperLet shipping crate

If you're curious, you can see a list of what's in the box with links to explain some of the included tools.

2) Rez one main rental unit (NOT a remote relay) PER RENTAL

If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.
If you are planning to use the mapper table, please read the Mapper table page.
If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.
The object names of the primary/master units to use are as follows:
  CasperLet Rental Box 
  CasperLet Rental Meter
  CasperLet Mesh Rental Meter  (this will have a white & grey background, not black)
Units with "remote relay" in the name are strictly a command relay object. They do not store settings at all, and you cannot use them in place of a primary/master unit.

Parcels and when parcel tracking is necessary

The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.

Parcels are only "tracked" for prim counting. If you do not use prim counting (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.

If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:

  1. Use a prim counter and make sure it is properly rezzed and deeded as per the prim counter page.
  2. Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.

Manager handling your setup?

Rez out all the units that are needed - or drag-copy as many as you need - NOW before the configuration process begins!

3) Grant debit permissions

See the debit permissions page to details of what these are and why they should be granted.
NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal.

4) Recognize rented state changes?

Follow the instructions on the CasperLet customisation page to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not show changes between rented and available states.

5) Go to CasperLet website and log in

Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.

6) Set your bulk settings

Go to the Units page when logged in, and set your options. Remember to click "SAVE" anytime you have a "save" option on a setting, and then use the "save" button at the BOTTOM of the bulk page as well.
This means change only ONE option at a time, and when you have a "save" button for that option, click "save" once it's set!

7) Set your different individual settings

For each unit you want different from your base defaults, you will need to:
  1. Click that specific unit
  2. Select "config" from the popup menu
  3. Arrive at the individual unit's configuration page
  4. Make your changes
  5. Remember to click "save" for each option with a "save" button
  6. Remember to click "save" at the bottom when done

Bulk Setup

About the Units page

The Units page is also frequently called the "bulk", "global settings", or "global defaults" page, and also is the page referred to when you see "bulk setup" in the documentation. The "units" page controls the base configuration for all of your rental units.

If you have any units that will have a different configuration than the default, they will need to be configured on a per-unit basis - individual unit configuration will override the global defaults where they differ.

CasperLet currently does not support rental "profiles" for rental units. (A suggestion ticket is in the queue for it, however, and it is expected to be added at some point in the future.)

1) Unpack your CasperLet shipping crate

If you're curious, you can see a list of what's in the box with links to explain some of the included tools.

2) Rez one main rental unit (NOT a remote relay) PER RENTAL

If the tenant will be taking OWNERSHIP of the parcel (such as with land sales on an island estate), the rental unit must NOT be rezzed on the parcel to which they take ownership. As a side-effect, this means the prim-counting feature will not function, and if you are using the mapper table, the mapper will direct potential customers to where the rental units are physically located, not the parcel.
If you are planning to use the mapper table, please read the Mapper table page.
If the landlord is retaining ownership of the parcel that the tenant is renting (such as with vending events or shopping malls), the rental unit should be ON the parcel.
The object names of the primary/master units to use are as follows:
  CasperLet Rental Box 
  CasperLet Rental Meter
  CasperLet Mesh Rental Meter  (this will have a white & grey background, not black)
Units with "remote relay" in the name are strictly a command relay object. They do not store settings at all, and you cannot use them in place of a primary/master unit.

Parcels and when parcel tracking is necessary

The rental unit will report the UUID of the parcel it is rezzed on when it signs in to the system.

Parcels are only "tracked" for prim counting. If you do not use prim counting (for example, if you are transferring ownership of parcels on island estates), then there is no reason to "link" the unit to the parcel.

If you wish to count prims on a parcel other than the one the rental unit is rezzed on, you must:

  1. Use a prim counter and make sure it is properly rezzed and deeded as per the prim counter page.
  2. Enable "Prim Consolidation", which will effectively count all owned parcels by the same land owner.

Manager handling your setup?

Rez out all the units that are needed - or drag-copy as many as you need - NOW before the configuration process begins!

3) Grant debit permissions

See the debit permissions page to details of what these are and why they should be granted.
NOTE: If you are re-rezzing a copy of a unit you've already granted permissions for, you won't see another debit perms popup. This is normal.

4) Recognize rented state changes?

Follow the instructions on the CasperLet customisation page to make sure they STILL change once you're done with configuration. If you make changes without following these instructions, rental units will not change between rented and available states.

5) Go to CasperLet website and log in

Click one of your rental units, select "config" from the popup menu, use that link to go to the website, and log in.

6) Set your bulk settings

Go to the Units page when logged in, and set your options. Remember to click "SAVE" anytime you have a "save" option on a setting, and then use the "save" button at the BOTTOM of the bulk page as well.
This means change only ONE option at a time, and when you have a "save" button for that option, click "save" once it's set!

Shared Land or Tenant Takes Ownership?

Tenant Takes Ownership

  1. Rez the rental unit ON the parcel - this tells the unit which parcel UUID to track
  2. Wait a few seconds for it to pick up the parcel's UUID
  3. Move the rental unit off the tenant's parcel and onto land that you control
  4. No need for prim counter (they can't use more prims than their parcel allows)

Shared/Communal Land (Malls, Vending Events, etc.)

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

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 refer to the notecard sent to prospective tenants, and "rented" to refer to the notecard that gets sent to the tenant after they rent the unit.

About the DropBox

The DropBox contains the notecards and landmarks for your rentals. Notecards are given in two situations. One, when a user clicks for "Info" and Two, when a tenant pays for a rental.

One DropBox per CasperLet system Owner is required. Having duplicates on at least one additional sim/region is highly recommended to work around sim/region communication issues.

See DropBoxes for full details and instructions on how to deploy and use the DropBox.

See the below for detailed instructions on how to properly set up notecards.

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, regardless of whether the DropBox originally came from a CasperVend or CasperLet pack.)

How do I....?

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