| Table of Contents |
|---|
About Multicraft
Multicraft is a popular and widely used Minecraft server control panel. Learn more about Multicraft on their website at http://www.multicraft.org/.
Supported Features
| Create | Cancel | Suspend | Unsuspend | Management | Config Options |
|---|---|---|---|---|---|
| YES | YES | YES | YES | YES | YES |
Management Features
This module supports the following management features within the client area:
- View Server Status
- Restart Minecraft Server
- Stop Minecraft Server
- Start Minecraft Server
- Set Server to Day Time
- Set Server to Night Time
- Set Server Name
- View Connected Players
- Kick Players
- Server Console
- Log in to Multicraft
Installing Multicraft
To install the Multicraft module, visit [Settings] > [Company] > [Modules] > Available, and click the "Install" button for Multicraft.
A message will be displayed, indicating that the module was successfully installed. Then click the "Add Server" button.
Enter the details for your Multicraft master server.
| Field Name | Description |
|---|---|
| Server Label | Enter a label for this Multicraft master server, it can be anything you like. |
| Panel URL | Enter the full URL to your Multicraft Panel, ie "http://multicraft.mydomain.com/". This is where you login. |
| Panel API URL | Enter the full path to your api.php, usually the Panel URL with /api.php appended, ie "http://multicraft.mydomain.com/api.php". |
| Username | Enter your Multicraft username. |
| API Key | Enter the API key for Multicraft. This can be found in Multicraft under Users, by clicking on your username. |
| Log All API Requests | It's recommended that this remain unchecked as management features make frequent API calls. Enable for debugging. |
| Dedicated IP Addresses | You can add dedicated IP addresses here (optional), just fill out the following
|
After filling out these options, click "Add Server" to add your Multicraft master server.
Most people will only have 1 Multicraft master server listed here. By specifying the Daemon ID via a configurable option, you can set which server Minecraft servers will be created on.
Configurable Options Overview
This module supports configurable options which may alter the provisioning of Minecraft servers. Configurable Options override Package settings.
Not Required
Configurable Options are not required, and this list in no way limits the Configurable Options that can be created. However, only the following Configurable Options can alter the way Minecraft servers are provisioned.
| Option Name | Possible Values | Recommended Field Type | Description |
|---|---|---|---|
| user_players | 0, 1 | Checkbox | Determines whether the owner can set the number of player slots themselves in Multicraft. 1 for yes. |
| players | integer >= 1 | Quantity, Dropdown | Sets the number of player slots, overriding the package value. |
| memory | integer >= 0 | Quantity, Dropdown | Sets the amount of memory for the server, overriding the package value. |
| daemon_id | integer >= 1 | Dropdown | Sets the Daemon ID to use for the server, overrides the package value. Useful for offering servers in different locations, ie "Los Angeles", "Dallas", "Miami" which correlate to Daemon ID's in those locations. |
| dedicated_ip | 0, 1 | Checkbox | If 1, attempt to use one of the IP Addresses set for the module. If none are available, the server will default to the main IP. |
| jarfile | ??? | Dropdown | The jarfile to use for the Minecraft server. A value of "default" will use the default Minecraft server. Otherwise, enter the jar file name for the server, ie "craftbukkit.jar". |
Creating Configurable Options
The following steps describe how to create configurable options. This section describes the following:
- Creating a Configurable Option Group
- Creating Configurable Options, and assigning them to the Group (repeat this step as necessary to create all Configurable Options required)
Creating an Option Group
To create a Configurable Option Group, visit [Packages] > Options, and click the "Create Group" button.
| Field Name | Description |
|---|---|
| Name | Enter a name for this group. |
| Description | Enter a description for this group (optional). |
| Package Membership | Leave this section blank, we will add the options to the group when creating the options instead. If you have already created the options, you may add them to the group on this step. |
After filling out these options, click the "Create Group" button to create the Option Group.
Creating a Configurable Option
To create a Configurable Option, visit [Packages] > Options, and click the "Create Option" button.
| Field Name | Description |
|---|---|
| Label | Enter a label, which will appear above or next to this form field. |
| Name | Enter a name, which is the form field name. (Important! This should match an Option Name described above. The module requires specific naming.) |
| Type | Select the field type from "Checkbox", "Radio", "Drop-down", and "Quantity". |
| Options Section | Set pricing information within the Options section. The fields required here may vary depending on the "Type" selected above. |
| Group Membership Section | Add this Configurable Option to the previously created Option Group by moving the Group from the right to the left in the multi-select box. |
After filling out these options, click the "Create Package Option" button to create the Option. Repeat as necessary to create all of the configurable options you wish to make available to the client during checkout.
Sample Configurable Options
The following are sample configurations for each of the supported configurable options listed above, and may serve as good examples for getting started.
| Option Name | Sample Configuration Screenshot (Click for full size) |
|---|---|
| user_players |  |
| players |  |
| memory |  |
| daemon_id |  |
| dedicated_ip |  |
| jarfile |  |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
Creating a Package consists of several sections:
Basic
The Basic section consists of the following options:
| Field Name | Description |
|---|---|
| Package Name | Enter the name of this Package, it will be visible wherever services are listed and on any order forms. |
| Status | "Active" is the default, "Inactive", and "Restricted" are also available. |
| Quantity Available | If this Package has a limited quantity available, enter the quantity, or leave it as "Unlimited". |
| Description | Enter a Description for this Package. HTML is allowed, and descriptions appear on order forms. |
| Configurable Options | Select the Configurable Option Group you created previously, to make those options available for this package. |
| Module | Select "Multicraft" for the module. |
Module Options
The Module Options section consists of the following options, which are Multicraft specific:
Pricing
Welcome Email
Group Membership
