This plugin is an addon for Holographic Displays (required)!
An innovative way to stimulate your players to donate. Display your store's donations progress bar directly in game, with four different placeholders for Holographic Displays:
An innovative way to stimulate your players to donate. Display your store's donations progress bar directly in game, with four different placeholders for Holographic Displays:
- Progress bar (fully customizable)
- Raw amount of donations received
- Raw amount of donations goal
- Current percentage of the donations goal
The plugin is able to read and parse web pages using regular expression, without affecting the performance of your server.
Placeholders
The following placeholders can be used in holograms:
Placeholders
The following placeholders can be used in holograms:
- {donationsPercentage} - The percentage of the completed donations goal
- {donationsProgressBar} - The fancy progress bar
- {donationsReceived} - The raw amount of money received
- {donationsGoal} - The donation goal set in config.yml
Requirements
- Have a donation page. Buycraft*, Enjin* and Minecraft Market are supported by default, but the plugin can be configured.
- Have a goal module visible to everyone, with percentage or raw amount of donations received displayed.
- Have the plugin Holographic Displays installed.
Using the browser
* Enjin and BuyCraft use a protection against attacks that requires JavaScript. In order to enable support for it, download this file and drop it in the folder /plugins/DonationHolograms/. Stop and start the server to enable it, the reload command is not enough.
Installation
- Download and install Holographic Displays (make sure it's updated)
- Drop DonationsHolograms.jar in the plugins folder
- Start and stop the server to generate the configuration
- Edit the configuration (explaination below)
- Drop the browser (read above) in the plugin folder if you use Enjin or BuyCraft.
- Start the server
- If you change the configuration in the future, do /DonationHolograms reload
Configuration
If you need help getting it working, don't hesitate contacting me on the discussion tab or in a private conversation. However, please try before asking for help.
In the plugin's folder there are two files: config.yml and custom-store.yml.
config.yml:
SpoilerIn the plugin's folder there are two files: config.yml and custom-store.yml.
config.yml:
# The url of your store.
page-url: 'http://store.your-server-domain.com'
# The store type, by default the plugin supports Buycraft, Enjin and Minecraft Market.
# There are some default types of store supported, depending on their configuration.
# The default value is for Buycraft, using the classic template and showing both the amount and percentage.
#
# LIST OF POSSIBLE DEFAULT VALUES:
#
# Buycraft / Classic template / Displaying goal amount: 'buycraft-classic-amount'
# Buycraft / Classic template / Showing percentage only: 'buycraft-classic-percentage'
# Buycraft / Flat template / Displaying goal amount: 'buycraft-flat-amount'
# Buycraft / Flat template / Showing percentage only: 'buycraft-flat-percentage'
#
# Enjin / Default template / Displaying goal amount: 'enjin-amount'
# Enjin / Default template / Showing percentage only: 'enjin-percentage'
#
# Minecraft Market / Default template / Displaying goal amount: 'market-amount'
# Minecraft Market / Default template / Showing percentage only: 'market-percentage'
store: 'buycraft-classic-percentage'
# How frequently the plugin should check for changes.
# 300 seconds = 5 minutes (by default)
refresh-seconds: 300
# If your store just shows the percentage, set this to 100.
# Otherwise, if the store is displaying the amount of money donated,
# set this to your goal and the percentage will be calculated automatically.
donations-goal: 100
# If the percentage placeholder can go over 100.
allow-percentage-over-100: false
# Section regarding the progress bar.
progress-bar:
__# The unicode symbol used to draw the progress bar.
__# Check for symbols here: http://unicode-table.com, use "\u" + the unicode number.
__# By default it's a full block symbol.
__symbol: '\u2588'
__# The total amount of symbols used to draw the progress bar.
__length: 20
__# The color used to fill the progress bar.
__color-filled: '&b'
__# The color that represents the empty part of the progress bar.
__color-empty: '&8'
custom-store.yml:
Spoilerpage-url: 'http://store.your-server-domain.com'
# The store type, by default the plugin supports Buycraft, Enjin and Minecraft Market.
# There are some default types of store supported, depending on their configuration.
# The default value is for Buycraft, using the classic template and showing both the amount and percentage.
#
# LIST OF POSSIBLE DEFAULT VALUES:
#
# Buycraft / Classic template / Displaying goal amount: 'buycraft-classic-amount'
# Buycraft / Classic template / Showing percentage only: 'buycraft-classic-percentage'
# Buycraft / Flat template / Displaying goal amount: 'buycraft-flat-amount'
# Buycraft / Flat template / Showing percentage only: 'buycraft-flat-percentage'
#
# Enjin / Default template / Displaying goal amount: 'enjin-amount'
# Enjin / Default template / Showing percentage only: 'enjin-percentage'
#
# Minecraft Market / Default template / Displaying goal amount: 'market-amount'
# Minecraft Market / Default template / Showing percentage only: 'market-percentage'
store: 'buycraft-classic-percentage'
# How frequently the plugin should check for changes.
# 300 seconds = 5 minutes (by default)
refresh-seconds: 300
# If your store just shows the percentage, set this to 100.
# Otherwise, if the store is displaying the amount of money donated,
# set this to your goal and the percentage will be calculated automatically.
donations-goal: 100
# If the percentage placeholder can go over 100.
allow-percentage-over-100: false
# Section regarding the progress bar.
progress-bar:
__# The unicode symbol used to draw the progress bar.
__# Check for symbols here: http://unicode-table.com, use "\u" + the unicode number.
__# By default it's a full block symbol.
__symbol: '\u2588'
__# The total amount of symbols used to draw the progress bar.
__length: 20
__# The color used to fill the progress bar.
__color-filled: '&b'
__# The color that represents the empty part of the progress bar.
__color-empty: '&8'
custom-store.yml:
This is an advanced configuration, it allows you to set a custom regular expression to detect the amount of donations. If you have a custom template and the default values don't work, feel free to send me a PM and I will create a configuration for you.
To use the custom configuration, set store to "custom" in config.yml.
Code (Text):
custom:
# The regular expression to find the donated money.
# {number} is a placeholder for the pattern of a decimal number.
regex: '(myCustomRegex)({number})(\/$)({number})'
# The group of the regular expression that represents the money donated or the percentage.
group: 2
# If the regex and the HTML should ignore spaces (recommanded)
ignore-spaces: true
Commands
Please read Holographic Displays' commands list first.
Spoiler: How to create a hologram (quick example)custom:
# The regular expression to find the donated money.
# {number} is a placeholder for the pattern of a decimal number.
regex: '(myCustomRegex)({number})(\/$)({number})'
# The group of the regular expression that represents the money donated or the percentage.
group: 2
# If the regex and the HTML should ignore spaces (recommanded)
ignore-spaces: true
Commands
Please read Holographic Displays' commands list first.
/hd create donations
/hd setline donations 1 Percentage bar: {donationsProgressBar}
This commands would create a hologram named "donations", made of a single line, displaying something like this:
Percentage bar: █ █ █ █ █ █ █ █ █ █
You can combine multiple placeholders and add multiple lines, check out Holographic Displays' page./DonationsHolograms autodetect - Recommends you the store type to use in config.yml
/DonationsHolograms status - Prints the donations amount from the webstore, if the last check was successful, if you are using the browser JAR file, and some config values
/DonationsHolograms reload - Reloads the plugin
/DonationsHolograms dump - Writes the HTML page to htmlDump.txt in this plugin's folder, to show how does the plugin see the page html. It can be different from what you would see with a browser.
Permissions
The single permission to use all the commands is donationsholograms.admin
Terms & conditions
This plugin works exactly as stated in the description. If you are unsure, feel free to ask before buying! By purchasing this resource, you accept and agree to the following terms:
- The purchase is final, no refunds allowed*.
- You will not redistribute it.
- A single purchase is valid for a single server or network (A BungeeCord server counts as one).
- Buying the plugins gives you free assistance for a single store page, in particular for the regular expressions.
- The plugin will be maintained as long as possible, but there is no guarantee that new features will be added.
*except if your store page is not compatible and I'm not able to fix it.
