How to use Tebex / Buycraft

[MrTibo]

M I N E H U T  C O M M U N I T Y  F A Q

HOW TO USE TEBEX (BUYCRAFT)

REQUIREMENTS: TEBEX
DIFFICULTY: MEDIUM

Introduction to Tebex

Tebex (formerly known as Buycraft) is a plugin that allows you to make your very own webstore. It will be linked to your Minehut server, and handle purchases automatically.

 

---

Installing Tebex

Before you can set up your webstore, you will need to install Buycraft (Tebex) on your server from the Minehut panel. You can read this CFAQ for help with installing plugins.

Now the plugin is installed, you can head over to the Tebex website to begin setting up your webstore.

First off, you will need a Tebex account. At the top right of the website, click Sign Up, fill in the required information, and click Create Account. You will receive an e-mail from Tebex that includes a button used to activate your account. Make sure to check your spam folder if you cannot find the email.

Now we have you registered, it’s time to make your first webstore. When you register/log-in for the first time, you should be automatically brought to a page with a wide selection of games. (If you weren’t, you can use this link). To make a webstore for your server, select Minecraft: Java Edition. In the next window, fill in the name of your server, and select the currency you want to receive payments in, and click continue.

The next page shows some secret information that will be used to connect your server to the webstore. To connect your webstore, fire up your server, and once inside, run the buycraft secret command that is shown on the website in your server console. Once you’ve done that, the box at the top right should now say Connected and you’re ready to click Continue. Your webstore is now connected to your server!

 

---

Personalizing your webstore

The next step is to personalize your webstore, because who wants that boring, default text on their homepage? On the left side of your screen, you will see lots of different options to edit your webstore. Under the webstore category, you can find Design. Here you get more options such as Appearance, Preferences, and Homepage. In Appearance, you can find the settings to change the looks of your webstore, and in Homepage, you can find - who guessed it - a box to change your Homepage text (The text that is first shown to new visitors of your webstore).

Notes: By default, Tebex adds a Modules section in your webstore’s sidebar, you can remove this in the Sidebar tab, and while you’re at it, edit what you do want to show in your sidebar. Tebex also adds an About page by itself. You can remove/edit it by going to Webstore → Pages

 

---

Using Categories and Packages

Packages are the things that your players can buy. This could be anything, like ranks, suffixes, loot boxes, keys, particles, etc. Packages are displayed in Categories and Sub-Categories.

First off, you’ll need to go to the packages page to start editing. Look in your sidebar to the left and press “Packages”, or click this link to go there directly.

By default, there is a “Packages” category and an “Example” package. You can remove these if you’d like, or you can edit them to whatever you want them to be. For this tutorial though, we’re going to make a new Category and Package.

Let’s start by making a new Category. In the top right of your screen, click Add New → Category. You can give your category a name and description, both of which will be displayed on the webstore, but only the category name will be displayed in-game (The /buy GUI) as well. Next, there are some settings to cover.
The format of this list is

• Category

  • Setting

    • Explanation

• General

  • Parent category

    • Category selection: If you want to make the current category a sub-category, you can use this option to choose what you want the parent category to be. If a category has sub-categories, it will be displayed with a small arrow on the webstore where you can select a sub-category.

  • Package Display Formation

    • This option changes the way packages are displayed in the category. You can choose between a grid that includes the package images, or a list with no images.

  • Minecraft GUI Item

    • The item that will be used for the category in the /buy menu in-game

• Visibility

  • Only show if a customer has purchased a package

    • Package selection: You can use this option if you only want the category to be visible to a player if they have already bought another package

  • Disable this category and remove it from the webstore

    • Yes/No: Whether or not the category should be disabled and hidden

  • Order the packages in this category by price

    • Yes/No: Changes the way packages are ordered. Instead of being ordered the way they are placed in the tree-structure, you can order them by price (low → high)

• Cumulative

  • Cumulate the purchases inside of this category so customers only pay the difference when purchasing a higher-priced package.

    • Yes/No: If enabled, the price of the package that a player has already bought is deducted from more expensive ranks. This is useful if you don’t want to set-up package upgrades, but automate the process of only having to pay the difference instead.

  • Disable cumulative packages that have a lower price than the current purchased package.

    • Yes/No: If enabled, packages that are cheaper than another package a player has already bought in the same category will be disabled and hidden.

• Advanced

  • Only allow the customer to purchase one package from this category

    • Yes/No: After purchasing a package from the category, block the player from buying anything else from that category again

  • Delete pending expiry commands of other packages in this category upon a new purchase

    • Yes/No: If you’ve set-up expiry commands, stop these from happening if a player makes another purchase in the same category

  • Add any remaining time of other purchased packages in this category onto new purchases

    • Yes/No: When purchasing another package while a previous package has not run out yet, add the remaining time to the new purchase. 

Now you have your category set-up, you can start adding packages. To create a new package, go back to your Packages tab, and again click on “Add New” like you did to create a new category. There are 2 package types.

1. Normal packages

2. Downloadable packages

You can use a downloadable package if you want to send downloadable content to anyone buying the package. In this tutorial, we’ll be giving a more detailed explanation about normal packages.

Just like with categories, you can give your package a name, description, and icon. You will also get a Price box, here you can fill in the amount you want your players to pay for this package. If you select the “Pay Anything You Want” option, your players can pay anything above the amount you entered in the Price box. Packages also have a couple of options to go over. The format will be the same as the categories explanation.

• General

  • Recurring Payment

    • Here you can change the behavior of the package. Whether it should be a subscription or a one-time payment. You can change the duration of the package in the next option

  • Remove From Customer After

    • How long the package should last on the player. You can set-up expiry commands in the Commands section

• Limits

  • Global Limit

    • Limit how many times this package can be bought globally on your server.

  • User Limit

    • Limit how many times a player can buy the package

  • Do not include packages that have been removed from customers when calculating limits.

    • Yes/No: If the package has been removed from a player (expired), it will not be included in the limit calculation.

• Restrictions

  • Required Packages

    • Set-up the packages a player needs to have bought before they’re able to buy the current one

  • Allowed Payment Gateways 

    • If you have multiple payment gateways set-up, you can limit which gateways can be used to buy the package

  • Do not allow the customer to increase the quantity of this package when purchasing.

    • Yes/No: When enabled, a player cannot change the number of times they want to buy this package. Useful if you don’t want players to accidentally buy the same package twice.

• Visibility

  • Publish On Webstore From

    • With this option, you can schedule when you want the package to appear on the webstore. If you leave this empty, it will be available right away.

  • Remove From Webstore After

    • With this option, you can schedule when you want the package to be removed from the webstore. If you leave this empty, it will be available forever, until you remove it manually.

  • Do not show this package to customers who haven't logged into the webstore.

    • Yes/No: If enabled, players who haven’t logged in to the webstore (entered their in-game names) will not be able to see the package

  • Do not display this package on the webstore and disable it entirely.

    • Yes/No: Whether or not to completely hide the package from the webstore

Now you have changed the settings of your package, it’s time to make it do something in-game. For this, we will use the “Commands” section. There’s a lot of different things you can do with commands, but the most common one is of course: giving ranks.

To connect a package to a rank, you will simply need to add the command to give the rank to the player. This can be done with the option “When this package is purchased”. In the type field, enter the command you use to give players a rank. You can use the {username} placeholder. You can also find a list of other placeholders by clicking here. For this example, I will be using a LuckPerms command. When you’re done, it should be looking something like this:

Noticed the little gear icon on the right? In this pop-up window, you can find some extra settings. For rank packages, you can leave the default options, but if you’re selling something like crate keys, you can use this pop-up to change the required inventory slots to make sure the player can receive their item. If you have multiple servers linked to one webstore, you can also select the server you want to run the command on.

 

---

Require further assistance?:

If you need more help on this topic, head over to this section of forums, or join our Discord!

 Minehut Buycraft tutorials

Compiled by MrTibo at the Minehut Staff Team

[Untreated]

Great CFAQ! Many people use Tebex/Buycraft, so this is very informative and useful for those just getting started.

[_omga]

Awesome tutorial, goes in depth. Will be very useful for server creators!