OLD-CasperLet/Quick Start: Difference between revisions
m (→Terminology) |
|||
| Line 34: | Line 34: | ||
---- | ---- | ||
: '''Parcel'''<br />A distinct, continuous (undivided) portion or tract of land. | : '''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. | : '''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. | ||
Revision as of 01:17, 15 June 2016
 | Please take the time to thoroughly read the entire page so that you have a better understanding of how the system works. |
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.
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 notecard delivery section for detailed instructions on how to properly set up notecards.
Creating your CasperLet Account
See the CasperLet account creation section.
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.)
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.
Do not call a rental unit 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.31 or later. You may see what the current versions are of everything from the versions page.
CasperLet Rental units version 1.2x 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.
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 use the SAME configuration (identical stores in a mall, skyboxes all the same prim counts, etc.) use the Bulk setup steps below.
Otherwise, use the "individual setup" section 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.
A suggestion ticket is in the queue to add rental profile functionality.
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 (non-"slave") 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.
- 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
- Units with "slave" 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.
Rez the unit ON the parcel to be tracked'
This is how CasperLet picks up the UUID of the parcel in order to keep tabs on it. It doesn't have to stay there, once it registers the parcel, it can be moved off to a sidewalk or rental office.
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:
- 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
Individual Setup + Bulk 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 (non-"slave") 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.
- 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
- Units with "slave" 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.
Rez the unit ON the parcel to be tracked'
This is how CasperLet picks up the UUID of the parcel in order to keep tabs on it. It doesn't have to stay there, once it registers the parcel, it can be moved off to a sidewalk or rental office.
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:
- 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
Bulk 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 (non-"slave") 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.
- 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
- Units with "slave" 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.
Rez the unit ON the parcel to be tracked'
This is how CasperLet picks up the UUID of the parcel in order to keep tabs on it. It doesn't have to stay there, once it registers the parcel, it can be moved off to a sidewalk or rental office.
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!
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)
- 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 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.
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 Units page.
- 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
- 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 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.
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....?
Ready for more?
There's also the complete user manual when you are ready to move beyond what's on this page.