Skip to content

Commit 92dfd58

Browse files
authored
Update README.md
1 parent 2ec4a32 commit 92dfd58

1 file changed

Lines changed: 14 additions & 27 deletions

File tree

README.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,34 @@
1-
# WooMinecraft - Self-hosted Minecraft Donations
1+
# WooMineSponge - Self-hosted Minecraft Donations
22

3-
[WooMinecraft](http://woominecraft.com) is a free Minecraft Donation plugin for your server that provides a self-hosted solution where you're the boss. By leveraging a well known eCommerce plugin on the
3+
WooMineSponge is a port of free Minecraft Donation plugin from Bukkit to Sponge's API. By leveraging a well known eCommerce plugin on the
44
WordPress side of things, we allow you to specify commands for product variations, general product commands, and resending of donations at any time.
55
![WooMinecraft Logo](https://raw.githubusercontent.com/WooMinecraft/WooMinecraft/master/src/main/resources/wmc-logo.jpg)
66

77
## IMPORTANT
8-
This build supports only **Minecraft Spigot 1.12.2**
8+
This build supports only **Minecraft Sponge**
99

1010
If in your config you are using the **/shop** path as your URL, you must NOT use that going forward. Your host MUST support
1111
access to the WordPress Rest API. If they do not, you should consider changing hosts.
1212

1313
## Config
1414
Your config should look like the below section.
1515
```
16-
# Set this to the desired language file you wish to load.
17-
#
18-
# If your l10n is not available but one is that you know how to speak,consider
19-
# contributing to this plugin at https://github.com/WooMinecraft/WooMinecraft/
20-
lang: "en"
21-
22-
# This is how often, in seconds, the server will contact your WordPress installation
23-
# to see if there are donations that need made.
24-
update_interval: 1500
25-
2616
# You must set this to your WordPress site URL. If you installed WordPress in a
2717
# subdirectory, it should point there.
28-
url: "http://example.com"
18+
url = "https://ar0n.com"
2919
3020
# This must match the WordPress key in your admin panel for WooMinecraft
21+
# This is a key that YOU set, both needing to be identical in the admin panel
22+
# and in this config file
3123
# For security purposes, you MUST NOT leave this empty.
32-
key: ""
24+
key = ""
3325
34-
# Allowed words the player need to be on to run the commands.
35-
# Disabled by default!
36-
# whitelist-worlds:
37-
# - world
26+
# This is how often, in seconds, the server will contact your WordPress installation
27+
# to see if there are donations that need made.
28+
interval = 300
3829
3930
# Set to true in order to toggle debug information
40-
debug: false
31+
debug = false
4132
```
4233

4334
## How does it work?
@@ -48,13 +39,6 @@ the WordPress server to check for donations for all online players.
4839
If online players have commands waiting to be processed, then all necessary commands are ran. There is NO LIMIT to the type of commands you can set, `give`, `i`, `tp`, etc... all commands are ran
4940
by the console sender, and not a player.
5041

51-
## Contributions
52-
53-
As with all Github projects, we encourage our users to contribute, even if it's just a small as [opening an issue](https://github.com/WooMinecraft/WooMinecraft). Every little bit helps, especially with pre-releases
54-
that may be unstable.
55-
56-
Please review the [Contributors Guidelines](https://github.com/WooMinecraft/WooMinecraft/blob/master/CONTRIBUTING.md) for the best way to contribute. If you'd like to see our list of contributors, [check that out on github here](https://github.com/WooMinecraft/WooMinecraft/graphs/contributors).
57-
5842
## Mojang Guidelines
5943
Since this plugin is GPL and entirely opensource, we cannot be sure how you will use this. However, when providing 'donation' options, you are still considered a
6044
`commercial` entity and therefore are bound to the [Mojang Commercial Usage Guidelines](https://account.mojang.com/terms#commercial)
@@ -64,6 +48,9 @@ You'll need the WordPress plugin for this MC Plugin to work - you can [get it he
6448

6549
## Changelog
6650

51+
## 1.2.0-SPONGE
52+
* Ported over to Sponge API. World whitelisting + language change is disabled.
53+
6754
## 1.2.0
6855
* Tested on Spigot 1.12.2
6956
* Cleaned up a lot of internals by simplifying a ton of requests.

0 commit comments

Comments
 (0)