May 11, 2013 1:45:23 GMT -5

Please take a moment to rate the plugin: ProBoards Library Link


Contents

1. Introduction
2. Help / FAQ
   
3. Integrating Into Custom Mini Profiles & Profiles
4. Showing Wallet Amount Anywhere On The Forum
   
5. Plugin Install / Download
   
6. Adding The "Bank" / "Stock Market" Link To The Navigation
7. API For Developers
   
8. Features
9. Future Features
   
10. Screen Shots
11. Plugin Source
    
12. Plugin Changes

---

mon·e·tar·y

Adjective: Of or relating to money or currency.

This plugin will add currency to your forum, allowing your members to earn virtual money when they post, and from other features of the system that are either included or being developed and released later on in the future.

Most parts of the system can be customised, from the text displayed in mini profiles, to the way money is displayed across the whole forum.

Support is also included for mini profiles that have been modified in the template layout.

Please be sure to read all parts of this post, as it contains important information regarding installing and customising the system.

If you do have any issues, questions, or suggestions, please post in this topic, don't contact me directly.

Note:  The Monetary System plugin will require 1 super user key

---

- How do I edit a members money?
  If the option is enabled to allow staff to edit members money, then all you need to do is go to the members profile, and click on the money value.  A box will appear where you can enter the new money value.  This also applies to the Bank balance if the Bank is enabled.

- Can I add my own companies to the Stock Market?
  Unfortunately you can't.  The Stock Market data is pulled from Yahoo using a script on my server.  It pulls about 15 companies that are household names, and because of this, there isn't a way for you to add more to the list.  However, you can modify the names and symbols of the companies that appear by going to the Stock Market settings page, and if you like, disable specific companies from showing at all.

- Can you add support for multiple currencies?
  While it could be possible, I won't be adding this feature anytime soon, and am not sure if it would ever be done.

- How often is interest earned?
  Interest is earned once per day (every 24 hours).  Interest can only be earned when posting.

- The URL for the Bank and Stock Market no longer work, I get an error page.  How do I fix this?
  Due to a recent update by ProBoards, it has broken the pages that were being used to show the bank and stock market.  0.6.2 + does fix this issue, however you will need to update your navigation links.  Please see the information below regarding the navigation links, it will tell you what they need to be.

- How can I import my settings when I update the plugin?
  See this topic...  support.proboards.com/thread/474770/exporting-importing-plugin-settings

- Why can I not set different amounts for the ranks?
  Ranks are not searchable like Groups are, so this can not be done at this time.

- How do I gift money using a link?
  You can use the gift money link with your unique code on the end... http://yourforum.proboards.com/?monetarygift=YOUR_UNQIUE_CODE.
  Don't forget, you can enable the gift icon that will show in the Yootil bar to make it easier for members to get their gifts.

- I am getting a notification about an update, however I already have the latest version installed.
  There was a bug in version 0.6.4 and lower that caused this, and hopefully 0.6.5 fixes it.  For now, disable the notification until you updated.

- Who sees the update notification?
  Currently only the main admin can see when there is an update.  This may change in the future if I implement a permission system for it.

- The plugin is no longer working, what's going on?
  Make sure you are using at least Yootil Library 0.9 or higher.  Previously versions will no longer work on your forum due to new to new rules regarding remote files.

---

To use the Monetary System plugin, you will need the Yootil Library Plugin, without it, this plugin will not work.  So please follow the instructions in that thread.


Requires: Yootil Library Plugin

----

Download: Monetary System Plugin (0.6.9)

OR

Install: ProBoards Plugin Library (0.6.9)

Note: Please check which version you are installing is the latest.  You can do that my checking this topic title, as it contains the version number as well as the date it was released.

---

Mini Profile

Because people like to customise the look of their mini profile and, this can cause an issue with how the money information gets displayed. Below is a video demoing the basic solution I have put in place.




The classes are; money_text, money_symbol, and money_amount.


Profiles

Some people requested the same thing for profiles, here are the classes to use (same as mini profile).

The classes are; money_text, money_symbol, and money_amount.

The profile also contains the members bank balance, if you wish to show that, use the following classes.

The classes are; bank_text, bank_symbol, bank_amount.

---

If you would like to show the members wallet amount on the forum, you can create an element with the below class, and this will get populated by the plugin.

Class Name: money_wallet_amount

---

The Monetary System doesn't automatically add the "Bank" or "Stock Market" link to the navigation, this is something that you can do yourself so you have full control over where it appears.

The screen shot below should be enough for you to work how how to do it from the admin area.

---

The Monetary System has a very basic API for other developers to hook into the money system.

For the moment the following methods are implemented.

Note: These are all methods.

• pixeldepth.monetary.get - Gets money (see source for params).
• pixeldepth.monetary.subtract - Removes money (see source for params).
• pixeldepth.monetary.add - Adds money (see source for params).
  
• pixeldepth.monetary.clear - Clears the money amount  (see source for params).
• pixeldepth.monetary.bank.clear_transactions - Clears all the transactions.
  
• pixeldepth.monetary.bank.clear_balance - This will clear the bank balance (doesn't touch the wallet).
  
• pixeldepth.monetary.bank.get_transactions - Gets the last X transactions.
  
• pixeldepth.monetary.disable_earning - Can disable money from being earned for the current page.
  
• pixeldepth.monetary.enable_earning - Can enable money to be earned for the current page.
• pixeldepth.monetary.clear_all - Clears everything for the user (data object is reset).
• pixeldepth.monetary.clear_last_interest - Clears the last interest timestamp.
  

Please look through the source to see how they work.  If you have questions, or need to know how they work, what parameters etc, please ask.  I will try to put better docs together if people start using them.

---

Note: There may be missed features in the current release not mentioned here.


Administration Area (Backend)

1. Settings
2. • Change money text (i.e "Money").
     
   • Change money symbol (i.e "£").
   • Change money symbol to an image.
     
   • Show, or not show the money in the mini profile across the whole forum.
   • Show, or not show the money text in the mini profile across the whole forum.
   • Show, or not show the money symbol in the mini profile across the whole forum.
     
   • Show, or not show the money on the profile for users.
   • Show, or not show the money text on the profile for users.
   • Show, or not show the money symbol on the profile for users.
   • Show, or not show the money on the members list.
   • Show, or not show the money text on the members list.
   • Change table header text on the members list.
   • Set money to include decimals or just be whole numbers.
   • Allow editing of money from the users profile if user has permission (i.e staff).
   • Disable earning money from the quick reply.
     

1. Earning Settings
   
   • Set the amount of money earned for a new thread.
   • Set the amount of money earned for including a poll.
   • Set the amount of money earned for replying in a thread (full reply).
   • Set the amount of money earned for replying in a thread (quick reply).
   • Set the amount of money earned for categories.
   • Set the amount of money earned for boards.
     

1. Permissions
   
2. • Add categories for where money will be disabled.
   • Add boards for where money will be disabled.
     
   • Add members who can no longer earn money.
   • Add threads to disable earning money in them.
   • Add groups who can no longer earn money.
     

1. Bank
   
2. • Enable or disable the Bank.
   • Interest Rate amount.
   • Minimum amount the user can deposit into the Bank.
   • Minimum amount the user can withdraw from the Bank.
   • Coin image can be changed.
   • Transaction text replacements
     

1. Stock Market
   
2. • Enable or disable the Stock Market.
   • Enable or Disable the Stock Chart image.
   • Compact layout for smaller forum widths.
   • Stock block width to fine tune the width of the information.
   • Up arrow image can be changed.
   • Down arrow image can be changed.
     
   • Stock company name and symbol replacements
     

1. Wages
   
2. • Enable or disable the wages system.
   • Set how often wages should be paid.
   • Enable or disable wage bonuses.
   • Set the bonus amount.
   • Set where the wages should be paid into.
   • Set wage rules for different amounts based on post count.
   • Set staff wages.
     

1. Rank Up
   
   • Enable or disable rank up earning.
   • Set where the money should be paid into.
   • Set the amount of money that can be earned for ranking up.
     

1. Gift Money
   
   • Enable or disable the gift system.
   • Set where the money should be paid into.
   • Change the gift icons.
   • Create gift codes with different amounts, and with different permissions.
     

Forum Features (Frontend)

• Members can earn money from creating new threads.
• Members can earn money from adding a poll to their threads.
• Members can earn money from replying in threads.
• Members can earn money from replying using the quick reply (if enabled).
• Members can view other members money amount.
• Members can access the Bank feature (if enabled).
• Members can deposit money into the Bank if they meet the minimum amount.
• Members can withdraw money from the Bank if they meet the minimum amount.
• Members can view their last 5 transactions at the Bank
• Members can access the virtual Stock Market (if enabled).
• Members can buy and sell stock from the stock Market.
  
• Staff can edit members money amount from their profiles (if enabled).
• Staff can edit members bank balance from their profiles (if enabled).
  
• Members list displays members money amount (if enabled).
• Bank added to Yootil Plugin Bar.
• Stock Marked added to Yootil Plugin Bar
  
• Earning interest once a day if you post.
• Earning a wage when actively posting.
• Earning money for ranking up when actively posting.
• Staff can earn a wage which doesn't expire like members wages rules.
• Accept gift money
  

---

• Donate
• Lottery
• Shop
• Raffle
  
• Events
• Gift Vouchers
  

---

Click image to open bigger version in new tab / window.





   

---

If you are interested in seeing how the system works, and how I have put it together, below is an uncompressed version. Please don't redistribute it, as a lot of hours have gone into this.

This is the merged version.  Locally it's split into the components and then merged into the file you see below.

htt://pixeldepth.net/proboards/plugins/monetary_system/monetary_system.src.js

As of July 2013, I have moved all the code to GitHub.  Below is a link to the rep.

github.com/pixelDepth/monetarysystem

---

Here, I will attempt to keep this up to date of what things have been changed so people don't need to look through all the new posts.

0.6.9 [21/08/2013]
- Fixed an issue with 2 loops when there were custom amounts of boards and categories.
- Added in the option to set the "Bank Balance" column header on the members page.
- Changed validation restriction for a lot of places where you can change text (now anything is accepted).

0.6.8 [20/08/2013]
- Changed the refund all stock dialog to allow the user to decline the message, which then stops showing up for good.

0.6.7 [20/08/2013]
- Fixed an issue where gift money would try to pay into the bank when the bank is disabled.

0.6.6 [19/08/2013]
- If stock market is disabled, a notice to the user will ask them if they want a refund on all investments.
- Bug fix to gift money showing an error to the user if there was no "Show Gift Icon" value set.
- Fixed an issue with wages not correctly looping through groups to find the highest earning amount.

0.6.5 [13/08/2013]
- Edit money now has improved permissions, you can select who can edit the money (by default all staff can).
- You can now ban groups from earning money.
- Bank balance can now be shown on the members list for staff (if bank is enabled). By default this is disabled.
- Staff can now earn a wage that is not depended on posting.
- Bug fix to the edit money icon showing for all people.
- Money for wages and gifts will default to being paid into the wallet (in case the Bank is disabled).
- Gift money to everyone, specific members, and groups. Gifts can only be used once per person.
- Show gift icon (can be turned off incase you want to create a game... Hunt the gift code ) in Yootil bar to the user.
- Edit Money setting is now disabled by default.
- Bug fix to update notification checking.

0.6.4 [11/08/2013]
- Can now change the money separator (default is ":").
- Can choose to have a space after the money separator or not.
- No longer restricted to using spans for customising the profile and mini profile.
- Mini profile customising doesn't require custom elements to be inside the "info" div now, can be anywhere in the mini profile.
- Update notification is shown to all staff now.
- Update notification can not be hidden unless it's disabled (people get lazy and hide the message, I want people to update).
- Bug fix to version checking (also method has been moved to Yootil).
- Can show the members wallet amount anywhere on the forum using an element with the class "money_wallet_amount".
- Customising of money and bank on the members profile is now possible. Please see first post for details when 0.6.4 is out.
- Profile money and bank amounts now show a small edit icon, this can be customised or turned off.
- Transaction rows text size has been increased by 1.
- Bug fix with wages where bonus was being paid when it wasn't meant too.
- Members who rank up now earns a fixed amount set in the settings.
- "RANKUP" transaction text added to Bank settings page

0.6.3 [04/08/2013]
- "Posts:" match string changed to "Posts" (some people have removed the colon ":" so this caused issues).
- Bank and Stock Market Yootil Bar icons can now be changed (can be found on the Bank and Stock Market settings pages).
- More options to select for the update checker (2, 3, 4, 5, and 6 days added).
- You can now set different earning amounts for categories and boards.
- Fixed an issue with floats in the title bar of the stock market and bank effecting some forums.
- Improved version update checking showing the message for an older version number.

0.6.2 [02/08/2013]
- Fixed 404 issues with latest ProBoards changes

0.6.1 [30/07/2013]
- Wages
- Bug fix
- Optimisation
- More customising of text that appears
- Bank balance no longer shows on profile if bank is disabled

0.6.0 [14/07/2013]
- Stock Market
- Customise all images that appear
- Money symbol can now be an image
- Quick reply earning enabled by default and set to 5
- Various other things changed and fixed

0.5.3 [09/05/2013]
- Fixed an edit money bug, sometimes it would reset to 0
- Staff can now see how much a user has in their bank on their profile
- Staff can now edit a bank balance
- Staff can no longer edit their own money

0.5.2 [06/05/2013]
- Fixed a balance bug when interest is added

0.5.1 [06/05/2013]
- Fixed bug when no user has a money object

0.5.0 [05/05/2013]
- Fixed an issue with drafts not clearing.
- Interest now can be earned once a day if you post.
- API has changed, instead of "pixeldepth_monetary", it's now "pixeldepth.monetary".

0.4.3 [01/05/2013]
- Bug fix with members getting money in their bank account when editing the users money.
- Bug fix with permissions (categories, boards, and members).
- New feature; Ban earning from specific threads.

0.4.2 [22/02/2013]
- If not logged in, bank page will just show the forum
- Admin tabs have been changed around, some settings combined to 1 tab now
- New setting for the quick reply, you can now set the amount if you want it to be different
- 2 new methods for other plugins: pixeldepth_monetary.disable_earning() & pixeldepth_monetary.enable_earning()
- Minor bug fixes and tweaks to the code