Patreon Plugin
This is a plugin to link Patreon to your Minecraft server. This plugin allows Patreons to receive perks in game, for example a special rank or bonus currency, anything is possible.
This plugin handles the relationship between Patreon and your server, and will repeatedly check for new Patreons to award, this plugin also handles people who decide they no longer want to be a Patreon and will correctly remove the additional permissions they have received.
Commands:
PatreonPlugin supports PlaceholderAPI. No expansion installation is required, if PatreonPlugin and PlaceholderAPI are on the same server the placeholders will immediately work.
The following placeholders are provided:
Setup
This video describes how to setup PatreonPlugin. Please note this video was made before email verification was added to the plugin.
Configuration
This plugin is highly configurable, including all messages sent to users.
Verification
Along with linking Patreon accounts, this plugin supports email verification to ensure players only link Patreon accounts which they own. This is configurable in the config.yml exert that is shown below. It is recommended you create an email account that is only used for verification codes to follow the best security practices.
If you are using Gmail you must give a app password, information on how this can be created is found on the google wiki
email :
# Used to set if email verification is used, if set to true, the following settings must be configured to work
# A code is sent to the given email to ensure that the user has access to the email address
# NOTE: It is recommneded if this is set to true to ensure players do not have the permission node "patreonplugin.unlink"
verify : false
# Login credentials for the account being used
# Make a account just for this, as otherwise impersonation will be a problem
# NOTE: if you are using a gmail account, you MUST use an app password rather than the GMAIL default password, setps on how to configure one can be found here:
# https://support.google.com/accounts/answer/185833
password : "password"
# The account email address
address : "[email protected]"
# Subject line of the email
subject : Patreon Verification Link
# Body of the email, valid placeholders are:
# {USERNAME} - for the players in game name
# {CODE} - Must be included, this is the players verification code
body :
- "Hi {USERNAME}"
- ""
- "To complete the Patreon verification process, run the following command within the server"
- "<b style='color:black;'>/linkpatreon verify {CODE}</b>}"
- ""
- "If you did not initiate this request, feel free to ignore this email"
- ""
- "Thanks,"
- "Patreon Plugin"
- "Please note, this email address is not monitored"
# STMP host for email, the default is the gmail host
host : "smtp.gmail.com"
Permissions
Permission nodes:
Discord
Booksaw Development has a dedicated support discord, feel free to join it here to ask any questions: https://discord.gg/JF9DNs3
BStats
PatreonPlugin uses bStats for anonymised data collection, to disable this go to plugins/bStats/config.yml
Licensing
You purchase this plugin as is, there is no guarantee of any future updates from the current state. When purchasing this plugin you agree to the following:
This is a plugin to link Patreon to your Minecraft server. This plugin allows Patreons to receive perks in game, for example a special rank or bonus currency, anything is possible.
This plugin handles the relationship between Patreon and your server, and will repeatedly check for new Patreons to award, this plugin also handles people who decide they no longer want to be a Patreon and will correctly remove the additional permissions they have received.
Commands:
- /linkpatreon <email> - patreonplugin.link – Link your Patreon and Minecraft account
- /unlinkpatreon – patreonplugin.unlink - Removes the link to Patreon (so users can choose to have their data removed) - be warned if you give players this permission they may be able to exploit it by repeatedly linking and unlinking their patreon account
- /patreon link <player> <email> - patreonplugin.admin - Admin command to manually link a users Patreon, this command skips verification
- /patreon unlink <player> - patreonplugin.admin - Removes this players patreon admin link
- /patreon update – patreonplugin.admin – force an update to run (checking the Patreon website for new Patreons and removing any users who are no longer Patreons)
- /patreon token – Get a link to the webpage required to setup authorisation for (this process is explained below)
- /patreon code <code> - patreon.admin – Provide the code received from running “/patreon token” so PatreonPlugin has authorization to contact Patreon
- /patreon reload - patreon.admin - reload the configuration for the plugin
PatreonPlugin supports PlaceholderAPI. No expansion installation is required, if PatreonPlugin and PlaceholderAPI are on the same server the placeholders will immediately work.
The following placeholders are provided:
- %patreonplugin_ispledged% - For if the player is pledged to Patreon
- %patreonplugin_usertier% - Returns the user's tier on Patreon
Setup
This video describes how to setup PatreonPlugin. Please note this video was made before email verification was added to the plugin.
Configuration
This plugin is highly configurable, including all messages sent to users.
Verification
Along with linking Patreon accounts, this plugin supports email verification to ensure players only link Patreon accounts which they own. This is configurable in the config.yml exert that is shown below. It is recommended you create an email account that is only used for verification codes to follow the best security practices.
If you are using Gmail you must give a app password, information on how this can be created is found on the google wiki
Code (YAML):
email :
# Used to set if email verification is used, if set to true, the following settings must be configured to work
# A code is sent to the given email to ensure that the user has access to the email address
# NOTE: It is recommneded if this is set to true to ensure players do not have the permission node "patreonplugin.unlink"
verify : false
# Login credentials for the account being used
# Make a account just for this, as otherwise impersonation will be a problem
# NOTE: if you are using a gmail account, you MUST use an app password rather than the GMAIL default password, setps on how to configure one can be found here:
# https://support.google.com/accounts/answer/185833
password : "password"
# The account email address
address : "[email protected]"
# Subject line of the email
subject : Patreon Verification Link
# Body of the email, valid placeholders are:
# {USERNAME} - for the players in game name
# {CODE} - Must be included, this is the players verification code
body :
- "Hi {USERNAME}"
- ""
- "To complete the Patreon verification process, run the following command within the server"
- "<b style='color:black;'>/linkpatreon verify {CODE}</b>}"
- ""
- "If you did not initiate this request, feel free to ignore this email"
- ""
- "Thanks,"
- "Patreon Plugin"
- "Please note, this email address is not monitored"
# STMP host for email, the default is the gmail host
host : "smtp.gmail.com"
Permission nodes:
- “patreonplugin.link” is given to users by default, if you want some users to not have access to this command you will have to explicitly revoke the permission node. This is required to link your Patreon account
- "patreonplugin.unlink" is not given to users by default, only users who have OP or have the permission node are able to use this command
- “patreonplugin.admin” is not given to users by default, only users who have OP or have the permission node are able to use these commands
Discord
Booksaw Development has a dedicated support discord, feel free to join it here to ask any questions: https://discord.gg/JF9DNs3
BStats
PatreonPlugin uses bStats for anonymised data collection, to disable this go to plugins/bStats/config.yml
Licensing
You purchase this plugin as is, there is no guarantee of any future updates from the current state. When purchasing this plugin you agree to the following:
- You do not own the plugin copyright – The original copyright owner (booksaw) maintains that right.
- You cannot distribute PatreonPlugin – PatreonPlugin may only be used on servers you own.
- Support will only be given to verified accounts – You will have to provide evidence that you have purchased the plugin before you will be given support for it.
Resource Information
Author:
----------
Total Downloads:
63
First Release:
Apr 8, 2022
Last Update:
Mar 9, 2024
Category:
---------------
All-Time Rating:
3 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings