Legacy WHMCS Module - Game Servers
This is a legacy module that is no longer in development, the current module can be found here: WHMCS Module v2
This module allows WHMCS to interact with GSP-Panel using the WebAPI.
The following WHMCS functions work in this module:
- Create Package
- Terminate Package
- Upgrade/Downgrade Package
- Suspend Package
- Unsuspend Package
Installation
- Download the WHMCS Module from the Members Area, after logging in go to Support > Downloads
- Extract the zip file and place the the PHP file in the “modules/servers/gsppanel/” folder in WHMCS
Setup Module
- Login to GSP-Panel and go into Configuration > Settings > API > Setup an WebAPI Passphrase
- Login to WHMCS and go to Setup > Servers, click “Add New Server”
- Enter the following settings for “Edit Server”
- Name: GSP-Panel
- Hostname: URL to your installation. e.g. http://myinstall.gsp-panel.com/gsp/
- Maximum No. of Accounts: Any high number
- Enter the following settings for “Server Details”
- Type: Select gsppanel
- Password: Enter the API password you previously setup
- Click “Save Changes”
Create a Package
This section is just an example to create a package compatible with GSP-Panel
- Login to WHMCS and go to Setup > Products/Services, click “Create a New Group”
- Name the group anything you want products under it to be associated with
- Click “Create Group”
- You should be back at the Products/Services page, click “Create a New Product”
- Select the product type, select the group you just created and enter a name for the product and click “continue”
- Enter these settings on the specified tabs
- Details
- Uncheck “Require Domain”
- Pricing
- Enter whatever pricing you want for the package
- Module Settings
- Select Gsppanel as the module
- Game ID: The GameID from GSP-Panel, you can find this in the url by going into Configuration > Game Templates > Edit Game and looking at the url, it should say “gid=<number>”, the number is the game's id
- Slots: Not required if you'll be using a configurable option
- Private: Not required if you'll be using a configurable option
- Priority: Not required if you'll be using a configurable option
Advanced
- Package custom fields
- These fields can be used to specify any options allowed in the games “Configurable Options” in GSP-Panel
- Configurable Options
- These fields can be used the same as above
- Private field as a configurable option
- Must be named “Private”
- Valid options are “Yes” and “No”
- Priority field as a configurable option
- Must be named “Priority”
- Valid options are “Below Normal”, “Normal”, “Above Normal”, “High”, “Real Time”
- Slots field as a configurable option
- Must be named “Slots”
- Valid options are numbers
- Location field as a configurable option
- Must be named “Location”
- Valid options of location names setup for machines in GSP-Panel
- Dedicated IP as a configurable option
- Must be named “Dedicated IP”
- Valid options are “Yes” and “No”