Difference between revisions of "RolePay Toll System Expansion"

From Nexus
Jump to: navigation, search
(reflects changes for v1.1)
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
= '''<span style="color:#4D5A93">Using Expansion Packs</span>''' =
 
= '''<span style="color:#4D5A93">Using Expansion Packs</span>''' =
<p>In order to use any expansion pack, you must have an API key only obtained from the Web Interface from the RolePay Server.<br />You can also obtain an API key from the network owner or someone who has access to the Web Interface.</p><br />
+
<p>In order to use any expansion pack, you must have an API key only obtained from the Web Interface from the RolePay Server.<br/>You can also obtain an API key from the network owner or someone who has access to the Web Interface.</p><br />
  
 
= '''<span style="color:#4D5A93">Making Expansion Packs</span>''' =
 
= '''<span style="color:#4D5A93">Making Expansion Packs</span>''' =
<p>Want to learn how to make expansion packs? All expansion packs are made using the [[Rolepay Money System/API|RolePay Money System API]].<br />All you will need is basic knowledge of HTTP and LSL.</p><br />
+
<p>Want to learn how to make expansion packs? All expansion packs are made using the [[Rolepay Money System/API|RolePay Money System API]].<br/>All you will need is basic knowledge of HTTP and LSL.</p><br/>
  
 
= '''<span style="color:#4D5A93">Setting Up The Toll System Expansion</span>''' =
 
= '''<span style="color:#4D5A93">Setting Up The Toll System Expansion</span>''' =
<p>These steps assume that you already have an API key.<br />Follow these steps to configure your device.</p>
+
<p>These steps assume that you already have an API key.<br/>Follow these steps to configure your device:</p>
* Rez out Item "Toll Payment System".
+
 
* Enter the API key into the dialog box.
+
<b>Note:</b> If you close any of the textboxes during the setup, simply click the Payment Machine to make it re-appear!
 +
 
 +
* Rez the "Toll Payment Machine" & "Toll Barrier" objects.
 +
* Click the Payment Machine and input your RolePay API key into the textbox when prompted.
 
* Enter the toll fee you would like to charge.
 
* Enter the toll fee you would like to charge.
* <b>Copy</b> the presented key.
+
* <u>Click the Barrier</u> to form a connection to the Payment Machine.
* Rez out Item "Toll Barrier".
+
* Your Toll System should now be operational!
* Click the arm and paste copied key into dialog box.
+
 
* Done. Your system is now set up.
+
<p>If the API key you have does not exist or it has been deleted, you will get an error saying "The API key does not exist".<br />You will need to obtain a different API key after that.</p><br />
+
  
 
= '''<span style="color:#4D5A93">Using The Toll Payment Machine</span>''' =
 
= '''<span style="color:#4D5A93">Using The Toll Payment Machine</span>''' =
<p>To make a toll payment, simply touch the machine.<br />By default, all collected fees will be deposited into the Network Funds; this can be changed (view configuration below).</p><br />
+
<p>To make a toll payment, simply touch the Payment Machine.<br/>By default, all collected fees will be deposited into the Network Funds; this can be changed (view configuration below).</p>
  
 
== '''Configuring the Toll Payment Machine''' ==
 
== '''Configuring the Toll Payment Machine''' ==
<p>The configuration menu can only be accessed by the owner.<br/ >The things you can access through the configuration are as follows:</p>
+
<p>The configuration menu can only be accessed by the <b>owner</b>.<br/ ><span style="color:red"><b>To access the configuration menu</b></span>, <u><b>click and HOLD</b></u> the Toll Payment Machine for 2+ seconds; the configuration menu will then appear and provide the following options:</p>
* <b>Group Mode</b> will enable the ability for users wearing the same group tag to waive toll fees; this is useful for emergency services and DOT roles.
+
* <b>Toggle Light</b> Shows/Hides the stop/go light on the Toll Barrier.
* <b>My Key</b> will display the system key to link to component(s) such as the Toll Barrier.
+
* <b>RESET</b> will completely reset the Toll System, requiring you to repeat the setup steps.
* <b>Funds Go To</b> allows you to have funds directed to a personal user, rather than the network funds.<br />Simply input a valid user key. (<b>To go back to default settings,</b> simply leave the dialog box empty and submit.)
+
* <b>Touch Dist</b> allows you to specify the maximum distance a user can be to interact with this system.
* <b>Set API</b> allows you to input a new API key.
+
* <b>Set Price</b> allows you to change the toll fee amount.
* <b>Set Price</b> will allow you to change the toll fee.
+
* <b>Whitelist</b> is used to waive toll fees for users that are apart of specific groups (<b>Max: 10 groups</b>). A user that is apart of a whitelisted group will simply need to activate their group tag before proceeding through the Toll.
* <b>Toggle Light</b> will hide/show the light on the connected Toll Barrier.
+
* <b>Fund Dest.</b> allows you to specify where the received toll payments should be deposited to. <b>By default</b>, all funds are deposited into the Network Fund. If you would rather have the funds sent to a specific user instead, simply input their username into the textbox and submit. (<b>Note:</b> If you wish to revert back and have funds deposited to the Network Fund, simply leave the textbox <b>blank</b> and submit.).
* <b>Hard Reset</b> resets the Payment Machine and Toll Barrier <small>(if connected)</small>.
+
 
<br />
+
  
 
= '''<span style="color:#4D5A93">Using The Toll Barrier</span>''' =
 
= '''<span style="color:#4D5A93">Using The Toll Barrier</span>''' =
<p>The Toll Barrier is used in conjunction with the Toll Payment Machine.<br />The barrier only works when a payment has been successfully processed.</p><br/>
+
<p>The Toll Barrier is used in conjunction with the Toll Payment Machine.<br/>The barrier only works when a payment has been successfully processed.</p>
  
 
== '''Barrier Arm Collision Warning''' ==
 
== '''Barrier Arm Collision Warning''' ==
<p>Once a payment has been processed and the arm barrier opens, the user will have 10 seconds to pass.<br />If a user is in the path of the arm barrier while its attempting to close, an alarm will sound; if the obstacle has not been cleared after three (<b>3</b>) consecutive warnings, the arm barrier will close.</p><br />
+
<p>Once a payment has been processed and the arm barrier opens, the user will have 10 seconds to pass.<br/>If a user is in the path of the arm barrier while its attempting to close, an alarm will sound; if the obstacle has not been cleared after three (<b>3</b>) consecutive warnings, the arm barrier will automatically close.</p>
 +
 
 +
 
 +
= '''<span style="color:#4D5A93">Changelog</span>''' =
 +
 
 +
== '''version: 1.1''' (05/24/2022) ==
 +
* Bug Fix — Payment machine becoming stuck during payment process.
 +
* Bug Fix — Failing to show/hide the Barrier stop/go light.
 +
* Improvement — Made it easier to connect the Toll Barrier during the initial setup process.
 +
* Improvement — Replaced "Group Mode" with a "Whitelist" option; allows you to waive the toll fee for up to 10 groups.
 +
* Improvement — You can now specify the touch distance (the max distance a user can be to still use the system).
 +
 
 +
== '''version: 1.0''' ==
 +
* Initial Product Release

Latest revision as of 14:29, 24 May 2022

← Rolepay Money System Expansion Packs

Using Expansion Packs

In order to use any expansion pack, you must have an API key only obtained from the Web Interface from the RolePay Server.
You can also obtain an API key from the network owner or someone who has access to the Web Interface.


Making Expansion Packs

Want to learn how to make expansion packs? All expansion packs are made using the RolePay Money System API.
All you will need is basic knowledge of HTTP and LSL.


Setting Up The Toll System Expansion

These steps assume that you already have an API key.
Follow these steps to configure your device:

Note: If you close any of the textboxes during the setup, simply click the Payment Machine to make it re-appear!

  • Rez the "Toll Payment Machine" & "Toll Barrier" objects.
  • Click the Payment Machine and input your RolePay API key into the textbox when prompted.
  • Enter the toll fee you would like to charge.
  • Click the Barrier to form a connection to the Payment Machine.
  • Your Toll System should now be operational!


Using The Toll Payment Machine

To make a toll payment, simply touch the Payment Machine.
By default, all collected fees will be deposited into the Network Funds; this can be changed (view configuration below).

Configuring the Toll Payment Machine

The configuration menu can only be accessed by the owner.
To access the configuration menu, click and HOLD the Toll Payment Machine for 2+ seconds; the configuration menu will then appear and provide the following options:

  • Toggle Light Shows/Hides the stop/go light on the Toll Barrier.
  • RESET will completely reset the Toll System, requiring you to repeat the setup steps.
  • Touch Dist allows you to specify the maximum distance a user can be to interact with this system.
  • Set Price allows you to change the toll fee amount.
  • Whitelist is used to waive toll fees for users that are apart of specific groups (Max: 10 groups). A user that is apart of a whitelisted group will simply need to activate their group tag before proceeding through the Toll.
  • Fund Dest. allows you to specify where the received toll payments should be deposited to. By default, all funds are deposited into the Network Fund. If you would rather have the funds sent to a specific user instead, simply input their username into the textbox and submit. (Note: If you wish to revert back and have funds deposited to the Network Fund, simply leave the textbox blank and submit.).


Using The Toll Barrier

The Toll Barrier is used in conjunction with the Toll Payment Machine.
The barrier only works when a payment has been successfully processed.

Barrier Arm Collision Warning

Once a payment has been processed and the arm barrier opens, the user will have 10 seconds to pass.
If a user is in the path of the arm barrier while its attempting to close, an alarm will sound; if the obstacle has not been cleared after three (3) consecutive warnings, the arm barrier will automatically close.


Changelog

version: 1.1 (05/24/2022)

  • Bug Fix — Payment machine becoming stuck during payment process.
  • Bug Fix — Failing to show/hide the Barrier stop/go light.
  • Improvement — Made it easier to connect the Toll Barrier during the initial setup process.
  • Improvement — Replaced "Group Mode" with a "Whitelist" option; allows you to waive the toll fee for up to 10 groups.
  • Improvement — You can now specify the touch distance (the max distance a user can be to still use the system).

version: 1.0

  • Initial Product Release