## Background
\nAt the time of this plugin’s creation, it is Lunar New Year (02\/2023). Usually, during special holidays, the lottery prize money in Hong Kong get’s extra high to attract people to buy for the occasion.<\/p>\n
However, while that is happening, I am halfway across the globe from my extended family and loved ones (Think of it like Christmas when the entire family gather around). Therefore, I’ve had the bright idea of creating a lottery plugin inspired by this… Scroll to the bottom of the page if you want to see what inspired this plugin.<\/p>\n
## About
\nWant a **lottery system** on your server that is **a bit more like IRL** that doesn’t evenly distribute chances over all tickets bought making the poor who wants to try their luck just idiots giving free money to that one person who bought 6400 tickets?<\/p>\n
With this plugin, you can create a **manually started or automatically reoccurring lottery game** on your server. While the mechanics in full might not be as simple, **joining a game by placing a bet is super simple**. A player can **win prizes of different tiers depending on the number of matching numbers** they’ve bet on!<\/p>\n
**One thing to note is that the odds are independent of the number of bets placed. (In other words, one person playing doesn’t mean that player is 100% going to win.)**<\/p>\n
## How to play LotterySix?
\n### 1. Check if a draw is scheduled and available to play!
\n– Games can be scheduled to start in the config or manually started with `\/lottery start`
\n– Open the GUI with `\/lottery play`<\/p>\n
<\/p>\n
### 2. Click on the gold ingot to begin!<\/p>\n
<\/p>\n
### 3. Choose your 6 lucky numbers (Simple Entry)
\n– There are also other forms of more complex entry methods for you to discover!<\/p>\n
<\/p>\n
### 4. Get ready at the scheduled draw time for the draw!
\n– 6 numbers + 1 special number will be chosen at random
\n– By a cryptographically secure random number generator, if that matters to you<\/p>\n
<\/p>\n
### 5. Collect prizes if you win!
\n– If the numbers you’ve picked contain 3 or more numbers selected in the draw (excluding the special number), you will win some prizes!
\n– The more matching numbers, the higher your winnings!
\n– **Each tier is NOT guaranteed a winner, unlike a lucky draw, in fact, it is extremely difficult to win higher tiers**
\n– See the link below for a detailed explanation<\/p>\n
<\/p>\n
## How do the entry types & draw work?
\nhttps:\/\/github.com\/LOOHP\/LotterySix\/wiki\/LotterySix-Draw-&-Prizes-Explanation<\/p>\n
## DiscordSRV Integration
\nPlace bets, check your bets, past draw results and more offline via DiscordSRV!
\n– Draw Result Announcement
\n– Slash Command **\/lottery**<\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
## Floodgate Geyser Integration
\nUse Bedrock forms in places where book interfaces were used because they cannot be opened remotely
\n<\/p>\n
## Responsible Gambling
\n**See how LotterySix facilitates the promotion of responsible gambling even as a just-for-fun Minecraft plugin**
\n**https:\/\/github.com\/LOOHP\/LotterySix\/wiki\/Responsible-Gambling**<\/p>\n
## Returning to the Community \/ Charity
\n**An account can be configured to receive a portion of the lottery ticket sales taken as tax (the “Lotteries Fund”).**
\nFor example, they can be received by the server owner or an admin to then be redistributed to other players to fund server-wide projects! This allows taxed ticket sales to be turned to good use, returning them to the server community.<\/p>\n
## Dependencies
\n– PlaceholderAPI
\n– Vault
\n– A Vault Compatible Economy Plugin<\/p>\n
## Installation
\n### Only on Spigot, Paper etc.
\n1. Put LotterySix.jar into the plugins folder along with the required dependencies
\n2. Start the server
\n3. *Edit the config (if you need to)*
\n4. *Restart the server (if you changed something in the config in step 3)*<\/p>\n
### Over a Bungeecord or Velocity Network
\n1. Put LotterySix.jar into the plugins folder along with the required dependencies in your backend servers (Spigot, Paper etc.)
\n2. Put LotterySix.jar into the plugins folder in your proxy server (there are no dependencies on proxy servers)
\n3. Start and then Stop your proxy server and your backend servers
\n4. Edit your LotterySix config **on the proxy server**
\n5. Remember to set `Bungeecord: true` in the above config
\n6. **Copy the above config to all of your backend servers** and replace the originally generated one
\n7. Start your proxy server and your backend servers
\n8. If you ever want to adjust the config, make sure you follow the steps again starting **from Step 3**<\/p>\n
### You are recommended to read this if you are unsure how to configure LotterySix games.
\n**https:\/\/github.com\/LOOHP\/LotterySix\/wiki\/Configuration-Guide-&-Recommendations**<\/p>\n
## Development Builds<\/p>\n
<\/p>\n
**Jenkins**<\/p>\n
## Showcase Server
\nWant to give the plugin a try?<\/p>\n
“`
\nIP: mc.loohpjames.com
\n“`<\/p>\n
<\/p>\n
## Commands
\n**\/lotterysix play** – Opens the LotterySix GUI [lotterysix.play]
\n**\/lotterysix balance** – Change the balance in any player’s betting account [lotterysix.balance]
\n**\/lotterysix start** – Manually start a game and schedule the draw at timestamp [lotterysix.start]
\n**\/lotterysix run** – Manually start the draw of an on-going game [lotterysix.run]
\n**\/lotterysix cancel** – Cancel the current game and refund all bets [lotterysix.cancel]
\n**\/lotterysix preference** – Set your own player preferences [lotterysix.preference]
\n**\/lotterysix settopprizefund** – Set the top 3 tier prize fund for the current game [lotterysix.settopprizefund]
\n**\/lotterysix setdrawtime** – Set the draw time of the current game [lotterysix.setdrawtime]
\n**\/lotterysix setspecialname** – Set a special name for the current game [lotterysix.setspecialname]
\n**\/lotterysix setcarryoverfund** – Set the carry-over fund from last round to the current game [lotterysix.setcarryoverfund]
\n**\/lotterysix reload** – Reload the config [lotterysix.reload]
\n**\/lotterysix update** – Check for updates [lotterysix.update]<\/p>\n
## Default Config
\nhttps:\/\/github.com\/LOOHP\/LotterySix\/blob\/main\/src\/main\/resources\/config.yml<\/p>\n
## Disclaimer
\nMany jurisdictions have regulations against “Game of Chance” (Such as loot boxes, or lotteries) with real-world monetary value. Please make sure your server follows those relevant regulations. LotterySix is just for fun and is not responsible for how each server uses our content.<\/p>\n
## Data usage
\nUsage statistics at https:\/\/bstats.org\/plugin\/bukkit\/LotterySix will be visible to the public with your server included in the statistics. No private information of your server is sent.
\nUpdate checking is also done via https:\/\/api.loohpjames.com to notify you whenever a new version is released. No private information of your server is sent.<\/p>\n
## Inspired By “Mark Six \u516d\u5408\u5f69” of the Hong Kong Jockey Club
\n**If you are wondering how it looks like IRL~~**
\n(Language: Cantonese, Partially English)
\nThe draw starts at **1:35**
\n