This is a dedicated server plugin is for Space Engineers with Torch API. For the vanilla variant of this plugin, please see here: https://github.com/tebexio/Tebex-SpaceEngineers
Tebex provides a monetization and donation platform for game servers, allowing server owners to manage in-game purchases, subscriptions, and donations with ease.
This plugin allows you to fulfill purchases on your Space Engineers server, enabling you to offer a wide range of virtual items, packages, and services to your players.
The Tebex plugin can primarily be configured via the Dedicated Server GUI's configuration editor.
These are the configuration options available:
Your secret key is required to connect your server to your Tebex store. Your secret key can be created and retrieved from your Tebex panel
By default the Tebex plugin will notify in the console when a package is delivered, for your records. To show more in-depth logging, enable Debug Mode.
Debug mode will also print a list of valid item IDs to your server's console on startup.
⚠️ Do not leave Debug mode enabled for extended sessions. It should only be used for debugging issues with your packages.
If an error or exception occurs on your server, having this setting on will automatically report the problem to Tebex for a developer to review. This helps us improve our plugins without requiring that you contact support.
The following commands are available in the Torch API plugin:
/tebex.secret <secret>: Set your server's secret key/tebex.sendlink <player> <packageId>: Send a purchase link for a package to a player./tebex.forcecheck: Force run any due online and offline commands./tebex.refresh: Refresh your store's listings./tebex.ban: Ban a player from using the store. Players can only be unbanned from the webstore UI./tebex.lookup: Display information about a customer.
/buy: Shows a link to your webstore./tebex.help: Display a list of available commands and their descriptions./tebex.info: Display public store information./tebex.categories: View all store categories./tebex.packages: View all store packages./tebex.checkout <packageId>: Create a checkout link for a package./tebex.stats: View your own player statistics in the store.
To install the Tebex Plugin for a Space Engineers dedicated server, follow these steps:
- Download the latest release of this plugin from Tebex.io, or choose the latest Release from this repository.
- Unzip the plugin's archive
Tebex-TorchAPI-2.0.0.zipto your dedicated server's folder.- If installed using Steam/SteamCMD, this is usually
C:/Program Files (x86)/Steam/steamapps/common/SpaceEngineersDedicatedServer/DedicatedServer64/
- If installed using Steam/SteamCMD, this is usually
- Start the Space Engineers dedicated server and continue to the configuration window.
- Navigate to the
Pluginstab and chooseAdd Assembly. - Select the plugin
Tebex-TorchAPI-VERSION.dllfrom your server folder. - In the configuration window, set your secret key to the one shown in your Tebex panel.
- Start the server.
You will see a message in your server's console indicating that setup with Tebex was successful:
2024-04-16 09:28:42.094: Plugin Init: TebexSpaceEngineersPlugin.TebexPlugin
2024-04-16 09:28:42.110: [Tebex] [INFO] Tebex is starting up...
2024-04-16 09:28:42.111: [Tebex] [INFO] Secret key is set. Loading store info...
2024-04-16 09:28:42.361: Game ready...
2024-04-16 09:28:42.991: [Tebex] [INFO] Connected to store https://example.tebex.io as game server Example Store
If you wish to contribute to the development of the plugin, you can set up your development environment as follows:
Setup Instructions:
- Clone the repository to an empty folder.
- The VRage assemblies in
Libcome from the latest Space Engineers Dedicated Server. Ensure they are up to date. - The Torch assemblies in
Libcome from Torch API. Get the latest assemblies from torchapi.com.
We welcome contributions from the community. Please refer to the CONTRIBUTING.md file for more details. By submitting code to us, you agree to the terms set out in the CONTRIBUTING.md file
This repository is only used for bug reports via GitHub Issues. If you have found a bug, please open an issue.
If you are a user requiring support for Tebex, please contact us at https://tebex.io/contact