jfb-acp-lottery [Jcink.com Wiki]

The Lottery

The lottery mod allows admins to create and run a random drawn that can give away items from the store (if enabled) or points to use in the store or other mods.

Setting up the Lottery

  1. After you have enabled the Lottery mod like described here.
  2. On the left side, click the “Lottery” link to expand the option box.
  3. Then click: “Lottery Settings”
  4. In the right panel, you will need to set: “Is lotterys on?” to “Yes” before you can view it. (See Note 1)
  5. If you wish to have the lottery draws purged from the database then use the option “Number of days before auto-remove a lottery:” (This will help to keep your database smaller and thus quicker to back up.)
  6. Finally, click: “Submit changes” to confirm the settings and enable the mod.

Note:

  1. Despite it saying that Root admins can see the lottery while it is offline, even Root admins cannot actually view the lottery until it is enabled. (If they try while it is offline it gives this error message: “Lottery not online - enable in AdminCP”)

Default Lottery PM

This is the default Lottery PM message that it sends to users. You can dress up the message if you want. The words in the ”{}” are used by the system to pull variables.

Congratulations {username}.
		You have won in the {lotteryname}!
		------------------------------------------
		Total Jackpot: {jackpot} {currencyname}
		Items Won: {itemnames}
		------------------------------------------
		The winning numbers that were picked: {winningnumbers}
		You picked the following numbers: {yournumbers}
		------------------------------------------
		
		Thanks for playing the Lottery.
		
		Lottery Services Bot.
		
		[This message was automatically generated, please do not responded]
		

Adding a Lottery

  1. On the left side, click the “Lottery” link to expand the option box.
  2. Then click: “Add Lottery”
  3. In the right panel, you will need to set the name of the lottery (in the first box.)
  4. Then beside: “Amount of Tickets:” enter a number. This is the total number of tickets that can be purchased by all members. (Once this number is reached, no more tickets will be sold.)
  5. In the next box (“Ticket Sell Price:”) choose how much to sell the tickets for.
  6. In “Number of Balls need to be picked:” choose a number. This is how many numbers a user needs to pick when they buy a ticket. The more numbers, the more prizes are given out. (Since each number adds a new prize pool. EX- if they pick 3 numbers there are: Prizes for getting 1 number right, 2 numbers right and all 3 numbers right. Which will be configured later…)
  7. Beside “Highest Number to be picked:” choose how high you want users to be allowed to pick. (The system will then restrict users to between 1 and the number entered here.)
  8. Next, pick how many days the lottery will be open so users can buy tickets with: “Run for…”
  9. If you wish this lottery to happen repeatedly, you can set: “Is this lottery continuous?” to “Yes” so that once the lottery closes and the winners have been decided, a new lottery will open automatically.
  10. Next decide how many tickets a user can purchase with: “Maximum Tickets:”
  11. The “Minimum Posts:” option allows you to restrict the lottery from users that don't have enough posts. (This can be useful for lotteries with higher costs where users wouldn't have enough money to buy tickets.)
  12. Next decide whether users can sell their tickets back (getting their full money back) with “Allow Sell back:”
  13. Then click the “Add Lottery!” button at the bottom.
  14. The page will then change and you will be taken to a screen that will allow you to configure the options for the prize pool(s).
  15. Use the “Prize for winning” sections to award users forum money for each number they get right.
  16. In the “Jackpot Item Prize for winning” use this to select an item from the store mod (if enabled) to give them that item for getting that number (or many of numbers) right.
  17. Finally, click: “Add Lottery!” to enable the lottery.

Note(s):

  1. You can add as many lotteries as you like. They can all have different options, prizes and run lengths. Plus every ticket sold is unique for that specific lottery.

Edit a Lottery

  1. On the left side, click the “Lottery” link to expand the option box.
  2. Then click: “Edit Lottery”
  3. In the right panel, you will see a drop down menu titled: “Select the Lottery to Edit:” use it to pick the lottery you want to edit.
  4. In the next drop down menu, Choose: “edit”
  5. Then click “Submit changes”
  6. On the page that loads, you will see a screen very similar to the one used to create the lottery… (With the exception that the option to close the lottery has been added.)
  7. When you have finished making the changes. Click: “Edit Lottery”.
  8. You will then be taken to the prize determination page. If you don't want to adjust the prizes just click: “Edit Lottery!” at the bottom to save the changes. Otherwise make the changes then click the “Edit Lottery!” button.

Buying a Ticket

Once the lottery is set up, now users can buy tickets… To do this:

  1. Go to yoursite.b1.jcink.com/index.php?act=lottery
  2. On the page that loads, it will display all the open lotteries. Click the name of the lottery.
  3. On the page that loads now, it will show you the details of this lottery. (It's name, How many numbers will be drawn, when it ends, the cost of a ticket, check winnings and the buy ticket link.) Click the “Buy Ticket”.
  4. On the next page, it will ask for a number (or several numbers depending on how many will be drawn.) You enter a number (one per box) OR click the “Let the computer pick for you(This will overwrite your numbers):” checkbox.
  5. Then click the: “Buy Ticket!” button.

Note

  1. The computer randomly picks numbers, so there is a chance that the same number can be chosen twice. (Happens more commonly when the highest number that can be selected is low.)
  2. The “Check winnings” link is a bit of a misnaming, it doesn't tell you if you've won. (If you've won, you're notified via PM.) Instead it tells you the odds of winning.

Re-selling Tickets

If you've decided that you don't want a ticket anymore, you can re-sell it back to the system (if allowed when the lottery was set up…) To do this:

  1. Go to yoursite.b1.jcink.com/index.php?act=lottery
  2. On the page that loads, it will display all the open lotteries. In the box on the left, Click: “Manage Tickets”.
  3. On the page that loads you will see a list of all the tickest you've bought (with the lottery name, the number of numbers drawn, the numbers you've picked and a link to re-sell the ticket).
  4. Click the “Re-Sell” link.
  5. The ticket will be removed from your list and the money will be refunded.

Note:

  1. There is no warning screen asking if you want to sell your ticket. Clicking the link to sell will remove it instantly.
 
jfb-acp-lottery.txt · Last modified: 2011/07/23 02:14 by viruszero