https://github.com/m-suro/mgiveaway

mGiveaway is a powerful and flexible Minecraft plugin for Paper servers that seamlessly integrates with Discord to host engaging giveaways. Players can participate in giveaways directly from Discord, and winners can be automatically rewarded in-game.
https://github.com/m-suro/mgiveaway

discord giveaways minecraft paper plugin spigot util

Last synced: 7 months ago
JSON representation

mGiveaway is a powerful and flexible Minecraft plugin for Paper servers that seamlessly integrates with Discord to host engaging giveaways. Players can participate in giveaways directly from Discord, and winners can be automatically rewarded in-game.

• Host: GitHub
• URL: https://github.com/m-suro/mgiveaway
• Owner: m-suro
• Created: 2025-01-05T10:09:43.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-03-05T23:07:40.000Z (7 months ago)
• Last Synced: 2025-03-05T23:28:17.422Z (7 months ago)
• Topics: discord, giveaways, minecraft, paper, plugin, spigot, util
• Language: Java
• Homepage:
• Size: 7.31 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  





  Boost your server community with exciting giveaways!


  mGiveaway seamlessly integrates Discord and Minecraft,


  allowing you to create engaging giveaways, set custom rewards,


  and automatically deliver prizes to winners in-game.








  

    

  

  

    

  





  
mGiveaway - Discord Minecraft Giveaway Plugin




  





  


Discord Integration: Slash commands for easy giveaway creation & management in Discord.

  


Automated Giveaways: Schedule start/end times for fully automated giveaways.

  


Configurable Requirements: Permissions, Groups/Roles (Vault), PlaceholderAPI values.

  


In-Game Rewards: Automatic execution of commands for winners.

  


Customizable Embeds: JSON configuration for rich Discord embed messages.

  


Dynamic Placeholders: Embeds update with time left, entries, winners, etc.

  


Giveaway Reminders: In-game broadcasts to notify players.

  


Statistics Tracking: Track entries and wins.

  


Extensive Text Config:  config.yml for messages, UI text, etc.

  


Update Checker: In-game notifications for new versions.





  





  


Spigot: 1.17+ [Paper recommended]

  


PlaceholderAPI: 2.11.6+

  


Vault: 1.7+





  





  


Download & Install: Get mGiveaway-VERSION.jar from GitHub Releases and place in /plugins folder.

  
Restart your server

  


Configure Discord Bot in config.yml:

    


      
Create Bot at Discord Developer Portal.

      
Get Bot Token ("Bot" tab).

      
Paste Token into discord.bot.token in plugins/mGiveaway/config.yml



    

  

  


Configure config.yml for:

    


      


prefix: In-game prefix.

      


broadcast_interval & broadcast_message: Giveaway reminders.

      


discord.bot settings (token, status, activity, channels, etc.) - Token & giveaway_channel REQUIRED.

      


discord.bot.command customization.

      


discord.bot.giveaway_embed, giveaway_end_embed, log_embed: JSON Embed customization (use Discord Embed Builder).

      


messages: All text messages.

      


giveaways: Define giveaway settings & requirements.

    

  

  


Reload Plugin: Use /mgwreload or restart server.





  



Use /create_giveaway (default) to create giveaways.

/create_giveaway name: prize: minecraft_prize: duration: winners: command: requirements:




  


name: REQUIRED: Internal giveaway name.

  


prize: REQUIRED: Formatted prize description (Discord).

  


minecraft_prize: REQUIRED: Plain-text prize (in-game broadcast).

  


duration: REQUIRED: Duration string (e.g., 2d 30m).

  


winners: REQUIRED: Number of winners.

  


command: REQUIRED: First reward command (%player% placeholder).

  


requirements: OPTIONAL: true/false (if the giveaway start should wait for requirements)



⚙️ Configuring Giveaways (config.yml - giveaways section):


See the example giveaway configuration (giveaways.5Diamonds) in the config.yml for a template. Key configuration options for each giveaway defined under the giveaways section:




  


settings: - Settings for the giveaway

    


      


scheduled_start: (Optional) Date and time to automatically start the giveaway at a future time. Format: dd/MM/yyyy HH:mm:ss (24-hour format). If not set, the giveaway starts immediately (or when manually forced).

      


end_time: REQUIRED: Date and time to automatically end the giveaway. Format: dd/MM/yyyy HH:mm:ss (24-hour format).

      


winners: REQUIRED: The number of winners for this giveaway.

      


commands: REQUIRED: Reward commands (%player%).

      


prize_formatted: REQUIRED: Discord prize description.

      


minecraft_prize: REQUIRED: In-game prize text.

    

  

  


requirements: (Optional)

    


      


group: Vault Group/Role.

        


          


<group_name>: value: true/false, formatted.

        

      

      


permission: Vault Permission.

        


          


<permission_node>: value: true/false, formatted.

        

      

      


placeholder: PlaceholderAPI value.

        


          


<placeholder_name>: over: <number> or under: <number>, formatted.

        

      

    

  





  



For Giveaway and Giveaway End Embeds:

    {TIME-LEFT}, {END-TIME}, {ENTRIES}, {WIN-COUNT}, {PRIZE}, {WINNERS}


For Log Embed:

    {GIVEAWAY-NAME}, {ENTRIES-COUNT}, {PRIZE}, {COMMANDS}, {WINNERS-MENTIONS}, {ENTRIES-LIST}




  



After making any changes to the config.yml file, remember to use /mgwreload in-game to reload the plugin.

Sometimes, the plugin pauses itself because of runtime errors. To restart it just reload it ;)


  [![bStats: Paper Servers](https://bstats.org/signatures/bukkit/mGiveaway.svg)](https://bstats.org/plugin/bukkit/mGiveaway/24362)