Readme
MineSlots Readme
This readme will guide you through all the settings and commands currently available in MineSlots.
Sign Settings
To set up a sign correctly, the following syntax should be used: Line 1: [Slots] will create a slot machine using the default machine. To use another machine, type [slots<machinename>]. Line 2: Machine owner's name. If you do not have permissions to create signs for others, this will automatically fill with your name if left blank. If you do, it will create a server-owned sign when left blank. You can also enter your name or another player's name if you have the appropriate permissions. Line 3: The stake is entered here. If you would like a custom jackpot, and they are enabled, use the following syntax: <stake>:<jackpot> Line 4: Left blank (The machine's reels go here)
The XRYS+Z format
The XRYS+Z format is the standard sign type in mineslots. The R and S refer to reels and sides respectively, and the X, Y and Z are variables chosen by the user.
X: X will set the number of reels (The amount of generated letters per sign, all of which must match for a win) Y: Y dictates the number of sides for the reels (The value of sides sets the number of letters each reel can produce. Setting sides to 2 will mean reels can produce A or B, while setting sides to 3 allows A, B or C to be produced, for example). Z: Z defines the jackpot reinvestment, as a percentage of inputted stakes. For example, setting this to 40 will mean that 60% of paid stakes go to the sign owner, while 40% is automatically added to the jackpot. Larger values of Z will produce big jackpots if many people lose in a row. If you wish to set Z to 0, you can omit the +0 part from the sign (so just type the XRYS part).
Jackpots for XRYS+Z machines are calculated automatically, but can also be overridden if allowCustomJackpot is set to true in the config file.
Here is the first line from a sample XRYS+Z sign: [Slots 4R3S+20]
This will create a machine with 4 reels, each with 3 sides. 20% of paid stakes are added to the jackpot, and 80% goes to the sign owner. The jackpot of this machine would be 21.6 times the stake. This value will then be altered according to "percent" and "round" in the config files.
Config File (Configuring Mineslots)
The following tweaks can be made via the config file. The settings apply across the server.
Progressive (true/false, default:true)
If set to true, the reels stop one by one. If set to false, they all stop at the same time. Win probability is unaffected.
useColours (true/false, default:false)
If set to true, the symbols on slot signs are coloured, if false, all text is black. This only works on signs with 3 or less reels due to space constraints. Also, the reels on coloured slot signs will be off-centre (for an unknown reason).
stakeRound (Number values(divisible by 0.01), default:0.01)
This automatically rounds entered stakes to the nearest number divisible by the defined value. For instance; if you wanted to only allow integer-valued stakes, you would set this to 1.0. The decimal point must be present for this to be read correctly.
stakeDefault (Number values(divisible by 0.01), default:1.0)
Whenever a user does not define the stake on their sign, it will default to the given value. Again, the decimal point must be present to avoid errors.
saveInterval (Integer values, default:15)
The plugin will save current jackpot and highscore data periodically. This setting defines the number of minutes between saves.
storedHighScores (Integer values, default:10)
The highest awarded jackpots are saved by the plugin; this setting defines how many of the top jackpots are saved.
defaultMachine (Machine name, default:3R4S)
When a sign simply says [slots] on the first line, it will use the properties of the default machine. WARNING: It is advised not to change this setting without destroying any slots signs already on the server, as signs created as the default machine will not change their jackpot once placed.
announce (Number values, default:50.0)
When a large enough jackpot is won, a server message will be displayed to all players on the server. This setting defines the minimum jackpot to trigger the message. A value of 0 can be used to show all jackpots won, while a negative value will disable the alerts.
XRYS+Z settings (See the XRYS+Z section of the readme for more information on how the format works)
allow (true/false, default:true)
This setting determines whether players are allowed to create XRYS+Z format signs.
allowCustomJackpot (true/false, default:false)
Normally, the jackpot for XRYS+Z signs is worked out automatically from the chance of winning and the "percent" setting. However, setting this value to true will allow players to input their own jackpot value instead.
percent (Integer values, default:90)
When a player creates a XRYS+Z format sign without inputting a custom jackpot, the jackpot is calculated by the following formula: (stake/chance of winning)*percent (It is then rounded by the "round" setting below). For example: a sign where the player has a 50% chance of winning will return twice the stake if the percent is set to 100. It will return 90% of this value if the sign is set to 90%. In short, the "percent" value is approximately equal to the percentage of stake money going back to players- so a value of 90 would mean that about 90% of the stakes are returned to players, while the other 10% is taken as profit by the sign owner. If you want perfectly fair signs, just set this value to 100.
round (Number Values (divisible by 0.01), default:10.0)
When a XRYS+Z sign is created with a non-custom jackpot, the jackpot will be calculated and then rounded DOWN to the nearest number divisible by the value of "round". Jackpots under the value of "round" will not be rounded down (as that would make the jackpot 0). For example: with the default setting of 10, a jackpot calculated at 32 will round down to 30. For no rounding, this value should be set to 0.01 because this is the smallest amount of money iconomy can handle. Again, do not remove the decimal point or this will not work correctly.
jackAdd (Integer values, deafult:20)
If a XRYS+Z sign is created without the Z value specified, but with the +, Z will default to this value.
maxJackAdd (Integer Values, default:25)
Defines the maximum value of Z, the stake reinvestment.
machines
This is where you can define preset machines (see the preset machines section below for more information).
Commands
The only command currently in Mineslots is /slots top, which displays the top 5 jackpots won on the server. "/slots top 2" will show the second page of top jackpots (ranks 6-10), "/slots top 3" will show the third page (ranks 11-15), and so on.
Preset Machines
Preset machines can be set up in the config file (see above). If a premade machine in the config files is called "Machine1", you can set up an in-game sign with these properties by writing "[slots Machine1]" on the first line of the sign. The stake can then be set, which will set the jackpot automatically. If "AllowCustomJackpot" is set to True in the config files, the jackpot may also be set manually on the sign. The syntax for preset machines in the config file is:
<machinename>: reels: <number of reels> (defaults to 3) sides: <number of sides> (defaults to 4) jackpot: <ratio of jackpot to stake> (defaults to 15.0, must include decimal point to work properly) allowCustomJackpot: <true/false> (defaults to false, if set to true, the user can set a custom jackpot, not based on the above jackpot ratio)
Permissions
MS.create
People with this permission are able to create slot signs. Default setting is on for ops and off for non-ops.
MS.createAny
People with this permission can designate the owner of the sign as someone other than themselves (including the server).
MS.deleteAny
People with this permission can delete any slot signs, including those created by others.
Comments