Skip to content

Lottery

Redjumpman edited this page Oct 13, 2016 · 8 revisions

Command List

Commands Description
Play This let's a user play in an on-going lottery
Start Begins a lottery. Can set restrictions and timers
Signup This creates a lottery membership for the user
Stats Retrieves a user's lottery stats
End This will manually stop a lottery even with a timer
Prize Adds an optional point prize for the lottery winner
Info General information about this plugin
Version Displays the version of lottery you have installed
Role Set the required role for lottery membership
Auto Freeze Will freeze memberships without signup role
Fun Add/Removes some fun text to picking the winner

Explanations


Lottery Signup

This command gives a user a lottery membership. Lottery memberships are required to track and display stats, and can enter member only lotteries. You can restrict who can signup by setting the signup role with the command:

<p>setlottery role <rolename>

Lottery Start

For those upgrading to lottery 2.0, changes have been made to the start command. If you type:

<p>lottery start

You will start lotteries the old way, which require you to manually end the lottery. You can now set a membership requirement and timers. To start a lottery without a timer, but restrict to lottery members type any of the following:

<p>lottery start yes
<p>lottery start true

lottery start 1`

In order to start a lottery with a timer, you need to specify if members are required or not. Do so by typing:

<p>lottery start no <seconds>
OR <p>lottery start false <seconds>

The timer set in seconds. So if you did 60, everyone in the server will have 60 seconds to enter the lottery before it ends. You can always end a lottery that has a timer early by using the command <p>lottery end For more info see Lottery End

Lottery Play

Once a lottery has been started, players may join by typing:

!lottery play

Players that do not meet the lottery requirements will not be able to participate.

Lottery End

A new lottery will be unable to start, until the current one has concluded. You can also use this command to end a lottery that is in the middle of a timer. To end a lottery, type:

!lottery end
You are required to have at least one person participating in the lottery or else the lottery will fail.

Once you end a lottery it will choose one person out of all those who participated at random. The winner will be declared in chat, and everyone will have their stats updated. To view these stats, type:
!lottery stats

OPTIONAL SETTINGS

Lottery Fun

There are two optional settings you can turn on. The first is fun text. Fun text will display a snarky message before picking a winner. This text has no effect on the outcome. To toggle fun text ON/OFF, type:

!lottery fun

Lottery Prize

The second optional setting is to give a point prize. You can create a prize by typing:

!lottery prize amountofpoints

Clone this wiki locally