Difference between revisions of "Rolepay Money System/Documentation"

From Nexus
Jump to: navigation, search
(Added the Web Interface Documentation. Added the home page.)
(Added the Users page, Tranactions Page, and Settings page for the Web Interface documentation.)
Line 89: Line 89:
 
* Click remove next to their name.
 
* Click remove next to their name.
 
* Poof, their off the list free to continue what ever they want in your network. (''Well, not whatever...'')
 
* Poof, their off the list free to continue what ever they want in your network. (''Well, not whatever...'')
 +
 +
== '''Users Page''' ==
 +
<p>This page will show all account information for every user registered into your network.</p>
 +
<p>You will also be able to remove users and give them money.</p>
 +
 +
=== '''Deleting a User''' ===
 +
<p style="color:#FF0000;font-weight:bold;">''Please remember once this is done, you cannot undo it.''</p>
 +
<p>To delete a user simply navigate to their name, click it. Then simply touch the button "Delete", and they their information and account will be deleted from your network.</p>
 +
 +
=== '''Giving / Removing a User's Money''' ===
 +
<p>When ever you give/take their money. All funds will be placed into the network funds. Since the money has to go somewhere, the only other destination would be the network owner. That would require the user to give/take to the other user.</p>
 +
<p>Follow these steps to give money.</p>
 +
* Navigate to their name.
 +
* Open their tab.
 +
* Enter a new amount in "Amount of Money".
 +
* Press the button "Update".
 +
* Bam, their money has been changed.
 +
 +
== '''Transactions Page''' ==
 +
<p>The transactions page will display all information regarding transactions. The latest transaction will be displayed at the top of the list.</p><p>All information regarding the transaction will be displayed. You are not able to delete the logs.</p>
 +
 +
== '''Settings Page''' ==
 +
<p>The settings page let's you change all the network settings.</p><p>These settings include the Tax and Starting Funds. You are also able to view the network key.</p><p>Your network key is the key that our staff members use to access your network when you are having troubles.</p>
 +
 +
=== '''Changing the Tax''' ===
 +
<p>To change the tax, simple navigate to the "Tax Percentage box", change the number and hit the "Update" button.</p>
 +
 +
=== '''Changing the Start Amount''' ===
 +
<p>To change the start amount, simple navigate to the Start "Amount" box, change the number and hit the "Update" button.</p>

Revision as of 23:28, 26 July 2014

← Rolepay Money System

Product Documentation

This documentation is relevant to the most recent version.
Anything outdated will not work with this documentation.

For information on what has been added in recent versions or if there have been any updates, please view the version history for the RolePay System.

RolePay Server

All information in this article is regarding the most recent server to run a network.

The server is used to start a network, with it you are able to distribute cards and access the web interface.
It also gives support staff members access to your network information and web dashboard.

Server Features

Your server is used as a gateway to your web dashboard, without it you will not be able to distribute cards or access features that would require you to be online.

One of the first things you will get asked when you rez the server is if you would like to Register a network.
This will create a new network with nothing on it.
After creation you will get an error saying that you are missing a card. This error will happen until you place the RolePay Credit Card into the inventory of the server. Please remember that it must be configured.

Server Dialog

Don't know what the buttons do on your server, refer to this simple reference.

  • Dashboard will take you to the web interface. It will require you to go to your browser.
  • Reset will reset the server to factory removing all the network information off the server. (This is not recommended unless your network is broken. Please contact support before resetting.)
  • Re-Obtain will reset the server, except it will keep all network settings. It is good to refresh it once a week.
  • Exit will exit the dialog.

RolePay Registration Terminal

The registration terminal allows users to get registered into your network and possibly adding funds into their account.

Terminal Features

The follow things can be done using the terminal.

  • Register into a network.
  • Receive a new credit card.
  • Add Funds into your personal account.

Not all these features are enabled by default.
The third feature only works if the owner of the terminal enables it. Once the feature is enabled, any user who is registered will be able to add funds into their personal account. If they are not registered but they try to add funds, they will get refunded the amount of Lindens payed to the terminal.

Terminal Dialog

Don't know what the buttons do on your terminal, refer to this simple reference.

  • Register will register the user into the network and send them a card if they are not registered.
  • New Card will send them a card from the server.
  • Add Funds will allow them to pay the terminal with Lindens and add money into their RolePay account for that network. (This feature only works if enabled by owner of the terminal.)

RolePay Credit Card

The card is the most important tool that you can use for the RolePay Money System.

Without this tool you will not be able to transfer money. You will also be able to view how much money you're carrying.

Transfering Money

Looking to transfer money to other users? Before these steps can be taken, please make sure that there is someone within 10 meters of you and registered into the same network.

  • Open the tab on the right side of your card.
  • Select "Transfer Funds" on the menu.
  • Select a person from the list.
  • Enter the amount of money to transfer.
  • Press Confirm.

You did it! You just transferred money. Please remember, you will actually have to have the money in the account to transfer it.

Card Settings

As you might have guessed, there are a lot of settings on the card HUD. A lot of them are not explained well. But that's what this documentation is for isn't it.

Any settings changed on the current card will be loaded onto other cards you have in that network. If you turn off sounds on one card, and you get a new card. The settings will be loaded and sounds will be turned off after loading the settings.

Sound

This button is used to turn off the sounds that you receive when ever someone gives you money.

The feature is simply Enable / Disable. All you have to do is click it once and it will be saved.

Animation

When ever you send money to someone that is within 10 meters of you, you will have the option to have an animation show.

This animation will only show how ever if you are wearing the attachment which can be retrieved by clicking Settings -> Attachment and wearing it.

If you send money and have this feature enabled. Your arm will hold a dollar bill out showing the transfer of money.

Background

This will allow for you to change the background of the card.

To change your background please follow these steps below.

  • Touch Settings -> Background
  • Get a texture UUID
  • Paste the UUID into the box.
  • Press submit and the texture is changed.

This feature will not sync across all cards you own in the network. It will only work on this single card.

If you change a card the background will never change back. Meaning if you are the owner of a network and change the texture, when you distribute the card. The texture will be the same for everyone unless they are to change the texture.

The Web Interface

The web interface is where you manage all settings and features for your network.

You can also view all transaction logs, and edit user account settings.

There are multiple pages, each page will be explained here.

Home Page

The main page is where you can view the network settings, and statistics.

It also has a place to view what support members are online to get help for the system. But remember, we also have a group of active customers that are willing to help you.

Server Options

The server options displays all important information for the server including errors, users registered, how much network funds you have, and the tax.

There is also a feature called notifications. This will give a little popup whenever someone makes a transaction in your network. You will need to be logged in the Web Interface for the notification to show up. You must also have a browser that is up to date.
We recommend the internet browser Google Chrome.

Support (Need Help?)

This is a simple way to see what staff members are online.

These staff members will be able to help you with the system. This also allows you to figure out when they are online and links to the wiki.

Please view the wiki first before contacting them.

Banned Users

Do you have a user that has been abusing your system? Use this as a way to ban them from your network.

They will not be able to do anything within the network. This includes register, transfer funds, and receive funds.

How to Ban Someone

  • Click the button "Add To Ban List"
  • Enter their Username (not display name)
  • If their name is found they will be added on the list.

How to Un-Ban Someone

  • Locate their name in the ban list.
  • Click remove next to their name.
  • Poof, their off the list free to continue what ever they want in your network. (Well, not whatever...)

Users Page

This page will show all account information for every user registered into your network.

You will also be able to remove users and give them money.

Deleting a User

Please remember once this is done, you cannot undo it.

To delete a user simply navigate to their name, click it. Then simply touch the button "Delete", and they their information and account will be deleted from your network.

Giving / Removing a User's Money

When ever you give/take their money. All funds will be placed into the network funds. Since the money has to go somewhere, the only other destination would be the network owner. That would require the user to give/take to the other user.

Follow these steps to give money.

  • Navigate to their name.
  • Open their tab.
  • Enter a new amount in "Amount of Money".
  • Press the button "Update".
  • Bam, their money has been changed.

Transactions Page

The transactions page will display all information regarding transactions. The latest transaction will be displayed at the top of the list.

All information regarding the transaction will be displayed. You are not able to delete the logs.

Settings Page

The settings page let's you change all the network settings.

These settings include the Tax and Starting Funds. You are also able to view the network key.

Your network key is the key that our staff members use to access your network when you are having troubles.

Changing the Tax

To change the tax, simple navigate to the "Tax Percentage box", change the number and hit the "Update" button.

Changing the Start Amount

To change the start amount, simple navigate to the Start "Amount" box, change the number and hit the "Update" button.