WooMCX icon

WooMCX -----

A Minecraft Donations Plugin which leverages WordPress and WooCommerce



Github: Here
Discord: Here

API: soon

Step 1: Server Plugin Installation
Installation
For those who don't want to read everything.

  1. Upload plugin to Minecraft Server
  2. Start server so the default config is generated.
  3. Shutdown server
  4. Edit the key and url config options to match your setup ( see below for explanation )
  5. Start Server
Permissions

Node Name
Description
woo.* Allows all current and future permissions
woo.admin Allows key generation/change (Admin only)
Commands
  • /woo check - Checks the server for pending deliveries.
Plugin Config
Ensure any strings such as the URL or lang setting are encased in quotes, on some servers this is required, but there's no way of telling.

Code (YAML):
ConfigVersion : 1.0.2

#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#                                            general settings
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#enable or disable the update checker
UpdateCheck
: true
Disable-if-not-updated
: true

# Set this to the desired language file you wish to load.
# If your l10n is not available but one is that you know how to speak,consider
# contributing to this plugin at https://github.com/WooMinecraft/WooMinecraft/
lang
: "en"

# This is how often, in seconds, the server will contact your WordPress installation
# to see if there are donations that need made.
update_interval
: 1500

# Allowed worlds the player needs to be in to run the commands.
# Disabled by default!
whitelist-worlds
:
#  - world

# Set to true in order to toggle debug information
debug
: false

#this can be in a single string or list format, and will run these commands once per order(chargeback)
#it uses the same user variable as the Website
#example: "ban %s" will ban the user who chargedback
#this dosent work for RestAPI Mode
Chargeback-commands
: ""


#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#                                            Connection settings
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
SQL
:
#Types: MYSQL, RESTAPI
  Type
: "MYSQL"
  #The rest of these details need to be the same as your wordpress DB setup
  #if you run into a issue of it not being able to connect to your WP database, and your details are correct, use another DB host for your wordpress site
  #all public MC hosting normally comes with a free mysql DB, use that one for testing
  TablePrefix
: "wp_"
  MySQL
:
    Host
: "localhost"
    Port
: '3306'
    Database
: "database"
    Username
: "username"
    Password
: "password"
    #Besure to set the Key section below to the same key you set in the admin panel of your website
    #Mysql Mode Needs its aswell
  RestAPI
:
    # You must set this to your WordPress site URL.  If you installed WordPress in a
    # subdirectory, it should point there.
    URL
: "http://playground.dev"
    # If you are having issues with REST, or have disabled pretty permalinks. Set this to false.
    # Doing so will use the old /index.php?rest_route=/wmc/v1/server/ base
    # Setting this to false will also allow you to set the restBasePath value if you have altered your
    # installation in any way.
    prettyPermalinks
: true
    # If your REST API has a custom path base, input it here.
    # NOTE: This is only loaded if prettyPermalinks is set to false.
    # Known good URL bases.
    # - /wp-json/wmc/v1/server/
    # - /index.php?rest_route=/wmc/v1/server/
    restBasePath
: ""
    # This must match the WordPress key in your admin panel for WooMinecraft
    # This is a key that YOU set, both needing to be identical in the admin panel
    # and in this config file
    # For security purposes, you MUST NOT leave this empty even if you are using MySQL
    key
: ""
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#                                            GUI settings
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
GUI
:
  #Set to true to enable GUI
  Enabled
: true
  #Gui Title
  Title
: "&c&lTest"
  #Gui Size
  #Gui sizes: 9, 18, 27, 36, 45, 54
  Size
: 9
  items
: #you can add more items
    1
:
      #Item ID
      id
: "STONE"
      #Item Name
      name
: "&c&lTest"
      #Item Lore
      lore
: #add your item description here
        - "&c&lTest"
        - "&c&lTest"
      #Item Amount
      amount
: 1
      #Item Slot
      slot
: 1
      #Item Link
      #this is a direct link to the item on your website
      link
: "https://google.com1"
      #Item Enchantments
      enchantment
:
        enabled
: true
    2
:
      id
: "STONE"
      name
: "&c&lTest"
      lore
:
       - "&c&lTest"
        - "&c&lTest"
      amount
: 1
      slot
: 2
      link
: "https://google.com2"
      enchantment
:
        enabled
: true
    3
:
      id
: "STONE"
      name
: "&c&lTest"
      lore
:
       - "&c&lTest"
        - "&c&lTest"
      amount
: 1
      slot
: 3
      link
: "https://google.com3"
      enchantment
:
        enabled
: true
#you can add more items here

#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#                                      Bungecord settings
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

# Set this to true if you are using BungeeCord and have mysql mode enabled
# "false" - This is for a direct install on a single server, and will only send commands to itself. (default)
#note: the default mode works with BungeeCord as well but only supports orders with 1 server in them
#example: if you have 2 servers linked to a single item/order, and a player buys a item/rank on your website, it will only give the rank/item to the server the player is on, skipping the other server
Bungee
: false

# "true" - This will make this server the host server, and will send the commands to the other servers connected to it.(all other servers need to be set to false)
# "false" - This will make this server a slave server, and will only accept commands from the host server on the bungeecord proxy.
#its recommended to make a hub/lobby server the host

Bungee-Host
: false

#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 


Explanation
  • Lang: Set this to the desired language file you wish to load. See below the list of available languages.
  • Key: This is used in the WordPress installation. Don't give this key to anyone! (how to get a REST API key from WooCommerce)
  • Url: A URL to your WordPress installation. If you installed WordPress in a subdirectory, it should point there.
  • Time_delay: The amount of seconds between web checks, 1500 is recommended.
You can select a language from this list:

  • en (English)
  • nl (Dutch/Nederlands)
  • es (Spanish/Español)
  • de (German/Deutsch)
Common Issues
301 moved permanently
this means that your website is redirecting this url, for example redirecting http to https.
use https://example.com instead of http://example.com if your website has SSL!

Step 2: Setting up the wordpress side
Requirements
  • A WordPress website
  • WooCommerce - plugin running on your website
If you don't know how to install the requirements please google it. There are enough tutorials explaining how to install WordPress and WooCommerce

WooMinecraft Installation
  1. Download the latest release (Stable|All)
  2. You can install it by unpacking it or you can go to plugins --> add new --> upload and then upload the whole zip file.
  3. Go to WooCommerce -> Settings [​IMG]
  4. Add/label your server and add your key. [​IMG]
  5. You're done now, time to add new items to your store!

Step 3: Creating A Package
Now we've finished the installation we can add products to our store!

Instructions
  1. Open up your WordPress admin panel

  2. Go to Products --> Add new product [​IMG]

  3. Add the general information (name description etc) and tick the "Virtual" box (it doesn't need to be shipped does it?) And remember to tick the product as "Downloadable", or else the order won't process automatically.
Note, this may not be valid on the latest WC - test this for yourself.

[​IMG]

  1. Now under "Product Data" you'll see some tabs, select the General tab

  2. In the general tab you'll see "Minecraft WooCommerce" Click on the add command button. [​IMG]

  3. You now can enter your commands. You don't need to use a slash (/) before it.
Resource Information
Author:
----------
Total Downloads: 27
First Release: Jul 2, 2023
Last Update: May 1, 2024
Category: ---------------
All-Time Rating:
3 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings