OLD-CasperLet/Detailed Setup: Difference between revisions
m (→Limitations) |
|||
Line 136: | Line 136: | ||
==== Limitations ==== | ==== Limitations ==== | ||
---- | |||
:* '''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. | :* '''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. | ||
:* '''PRIM rental meter:''' Unless you edit linked parts, the prim meter is already the smallest you can go. Grabbing a corner and shrinking won't work since one of the prims is already at the 0.010 smallest size. | :* '''PRIM rental meter:''' 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. |
Revision as of 10:37, 27 January 2014
Introduction
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!
Prerequisites
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.)
Getting Started: Overview
- Rez a rental unit.
- Touch/click the unit. You'll get a popup menu.
- Select Config from the popup menu.
- Go to the website. 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 prim counter page for specific process.
What's In The Crate?
For details on what comes in the shipping crate, see the Introduction page.
Creating An Account
See how to create an account on CasperDNS as well as reset your password.
Configuring Your Units
Configuring primary rental unit
- Rez a rental unit, and grant permissions.
- Simply click (touch) the rental unit, and select "Config" from the popup menu.
- Go to the website. 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 prim counter for details.
Configuring all rental units in bulk
- Rez at least one rental unit, and grant permissions.
- Click/"touch" any rental unit, and select "config" from the popup menu.
- Log in, if necessary.
- Click the "Units" icon at the top of the page.
- This will take you to the "bulk" units page.
- Tick the box for each option you are changing, and make the desired change. (If you do not tick the box, the changes will not be saved...)
- When all changes are made on the bulk page, click "save".
- These saved changes will affect all current AND FUTURE rental units you rez out.
- (You can adjust on a per-unit basis as described in the prior section if you wish. Remember per-unit settings override the bulk defaults.)
- If you want to count prims, then rez one prim counter for each land owner.
Configuring "slave" rental unit
The "slave" units can be linked to the actual CasperLet rental units, and will copy whatever the main units do. This is really useful if you want a "central" rental area on the sim/region, as well as payment boxes on each of your rental locations.
- Rez a "slave" unit near the actual rental unit you want it linked to.
- Click "yes" when prompted.
- It's now assigned to that rental unit, and will copy the settings and updates of that unit.
- Simply move (do not pick up!) the "slave" unit OR the main rental unit to where you want it to be
If you do not see particles, check:
- Are particles on?
- Are your graphics/particles set too low?
- Are there a lot of other particle generating things nearby? (particle "starvation")
- If you've been logged on for a while, your cache may be full - flush your cache and relog.
Counting prims
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 prim counter page for details and FAQ.
Adding a Manager
Currently, adding a manager can only be done globally (for all CasperLet units in all sims/regions).
This is a TWO STEP process, as follows:
STEP ONE
- Have your manager register for their own CasperDNS account
- It is *very* helpful if they sign up as their SL account name, rather than a random other name - however they should NEVER use a password that is in use for any other service, it should always be a unique password
(see how to 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.
Be very certain you trust the manager if you are granting medium or high risk permissions!
STEP TWO
- Your manager logs in to THEIR CasperDNS account
- They need to go to the 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.
If the wrong avatar was added in THIS area, it will need Casper's intervention to remove. So be VERY CAREFUL!
Discounts for Renters
See the Discounts page for details.
Website Configuration Options
See the page on unit configuration or the page on bulk configuration for details of what you can do.
Profit Sharing Options
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.
To set up profit sharing:
- 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.
Configuring States
Configuring the states of your rental BOX and MESH METER:
- Make sure the unit is available (not rented)
- Move the unit to where it should appear when available
- Resize and set the transparency as desired for the available state.
- Touch/click the unit, select "States" from the popup menu, then "Set Available"
- Move the unit to where it should appear when rented (max 10m distance away)
- Resize and set the transparency as desired for the rented state.
- Touch/click the unit, select "States" from the popup menu, then "Set Rented"
- Touch/click the unit again, and select "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:
- 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.
Limitations
- 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.
- PRIM rental meter: Unless you edit linked parts, the prim meter is already the smallest you can go. Grabbing a corner and shrinking won't work since one of the prims is already at the 0.010 smallest size.
- PRIM rental meter: Alpha setting persists across states, and will NOT automatically change.
- PRIM rental meter: Do not "fold down" the popup AVAILABLE sign, the meter takes care of that automatically.
Transferring Renter/Config Information
To learn how to copy or transfer a renter or unit configuration see the Transfer Rental page.
Physically Moving Units
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 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:
- 1) Right-click on the rental unit
- 2) select "wear" (or, "More" then "wear" depending on your viewer)
- 3) Teleport to the new location
- 4) Right-click, then "DROP"
- Do not use "detach" - that will detach it to your inventory, and rezzing it out will lose its configuration
- 5) Right-click and then "edit" to move the unit once it is safely dropped
- 6) Touch/click the rental box and use the soft reset function from the pop-up menu. This will update the website with the rental unit's new location.
- 7) Make any changes to the rental unit's configuration that you need to for the new location and save them.
- 8) The next time the prim counter runs in the new sim/region, the relocated rental unit's prim use will be updated.
Moving your rental unit in this fashion means:
- It reports correct time remaining
- It remembers the tenant
- Website sees the new location almost immediately
- Prim count will initially reflect the OLD location, but 'will update once the prim counter in the new sim sees the new unit.
Moving your rental unit in ANY OTHER fashion beyond what is described here is NOT guaranteed to keep the configuration!
Configuring Textures
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:
- "TEX-available"
- "TEX-overdue"
- "TEX-rented"
- "TEX-overlimit"
- "TEX-locked"
- "TEX-reserved"
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):
- METER-days
- METER-hours
- METER-minutes
- METER-months
- METER-weeks
- METER-years
Texture Changing
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@(text)" or "m@(text)" 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 “(text)” 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.)
Renaming Units
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.
Configuring the Door & Sign
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.
To use them as-is:
- 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.
The door will still work from within a linkset.
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.
Group Bots
See the group bots page for more information.
Mapper
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.
Available units are shown in green and rented units are shown in black on the mapping table.
Customising the table
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.
- For example:
- 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.
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:
- 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
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.
Paying the Beacon Indicators
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.
Notecard Delivery
Version 1.19 and prior
By default, these older versions ship with example notecards within the rental units. If you don't change the contents, your prospective renter will get a notecard that just says "this is an example notecard" - which is not exactly something that encourages renting, so PLEASE take the time to put some informational content in them.
- Place two notecards into the contents of EACH rental unit; the names must end with "-Info" and "-Rented".
- The "-Info" notecard is given when a user clicks Info in the menu.
- The "-Rented" notecard is given when a user rents. The user can also click the unit at any time and select "Notecard" from the popup menu to get the "-Rented" notecard again.
It is recommended that you include some basic information about your rental, such as:
- How much per week
- How many prims / land impact are allowed
- Any rules you have on rentals, what tenants can and cannot rez out, any overall business theme, etc.
- Anything else you want to add
Version 1.20 and forward
- 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.)
Notifications
You can choose to enable notifications for you and/or your manager(s).
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.
To troubleshoot issues with notifications, see the Notifications section in the CasperLet FAQ.
Rental Office?
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 Safely moving your rental units to move the main unit to its final location in your rental office.
If you have only a single island, then you can use a prim counter, with a rental HQ in one location on that sim.
Rental Vendor
See the page on rental vendor integration for details
Transporter Link
NOTE: YOU NEED CASPERLET 1.15 OR HIGHER TO USE THIS FUNCTIONALITY.
- Set the "casperlet" value in the notecard to YES, and save.
- 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.
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).
If you have 1.21 or higher:
If "acceptpayments" is enabled, the transporter will also duplicate any floating text which appears on the unit.
CasperLet API
See the CasperLet API page for details.
Hippo Migration Toolkit
Looking to migrate rental configuration information from HippoRent? See the Hippo migration toolkit page for details!
FAQ / Troubleshooting
See the complete FAQ page.