SDonate Documentation¶

Requirements¶

Before installing SDonate, you should check that your web server has the following requirements for SDonate to work.

• PHP >= 5.5
• MySQL
• PDO

SDonate also requires access to some functions that some hosts may block. To check these functions work, download https://sdonate.com/downloads/compatibilitychecker.zip then unzip it into the root folder of your web host (usually called “public_html” or “public”), then go to http://<yourdomain.tld>/compatibilitychecker.php (for example, if your domain is “myamazingdomain.com”, go to http://myamazingdomain.com/compatibilitychecker.php). If everything is alright, it will say your host is compatible, otherwise you will need to contact your host to fix any issues or find a new host.

1. Extracting SDonate¶

The first thing you will need to do after do after downloading SDonate is extract the zip. It’s best to extract it into a folder on your desktop for easy access.

2. Setting the admin¶

After you’ve extracted SDonate, go into the “web” folder and open the file called “install.php” using a text editor. Notepad will work but a better text editor such as Notepad++ is preferable as it makes things easier to see. Once you’ve opened it, you will see three lines starting with $adminsteamid, $adminusername and $adminpassword. You will need to decide whether you want the first admin (you) to log in using a username and password or using Steam login. If you want to log in using Steam, edit the line starting with $adminsteamid and put your Steam ID in between the quotation marks. For example, my Steam ID is 76561198134262586, so I would change it to:

$adminsteamid = '76561198134262586';

If you want to use a username and password to log in as admin, make sure that $admingsteamid is empty, so it looks like:

$adminsteamid = '';

Then edit $adminusername and $adminpassword with the username and password you want. For example, if my username is “adminuser” and my password is “mypassword1”, I would change it to:

$adminusername = 'adminuser';

$adminpassword = 'mypassword1';

3. Setting your API keys¶

In the extracted SDonate folder, open the “web” folder again then open “config.php”. You will see a line starting with $sdonateapi, inside the quotation marks next to this copy your SDonate API key you generated earlier. You will also need your Steam API key. To get your Steam API key head over to https://steamcommunity.com/dev/apikey. If you have not already filled in this form, do so now to get your Steam API Key. Now, in “config.php”, in the quotation marks next to $steamapi copy your Steam API key and save your changes.

4. Setting up the MySQL database¶

Using a database manager like phpMyAdmin or your host’s own database management system, you will need to create a database for SDonate as well as a user that has full access to that database, the instructions for this vary by system so they are not covered here, but it should be simple enough. In “config.php”, you will see four lines starting with $dbhost, $dbname, $dbusername`` and $dbpassword. $dbhost is the ip of your MySQL server. Unless your MySQL server is on a different IP to your website, you should leave this as ‘localhost’. In the quotation marks next to $dbname enter the name of the database you created, this should include any prefixes also. Next to $dbusername and $dbpassword enter your database user’s username and password, then save your changes.

5. Setting the main currency of your store¶

In “config.php”, next to $currencycode you will need to enter the currency code of the main currency you want your store to use. Users will be able to pay using their own currencies, but this is the currency that all of your prices will be displayed in. Below is a list of valid currency codes. You only need to enter the three letter code.

• AUD - Australian Dollar
• CAD - Canadian Dollar
• DKK - Danish Krone
• EUR - Euro
• GBP - British Pound Sterling
• MXN - Mexican Peso
• NOK - Norwegian Krone
• NZD - New Zealand Dollar
• PLN - Polish Zloty
• NOK - Norwegian Krone
• RUB - Russian Ruble
• SEK - Swedish Krone
• USD - United States Dollar

6. Setting up Google reCAPTCHA (OPTIONAL)¶

Google reCAPTCHA is a captcha system which prevents brute-force log in attempts. If you wish to only allow people to log in through Steam you can skip this step as it will have no benefit. If you wish to allow people to log in using a username and password, you should complete this to make your site more secure. To set it up go to https://www.google.com/recaptcha/admin and sign in using a Google account, or register if you don’t have one. Where it says “Register a new site”, enter anything you want under “Label” and enter your domain name under “Domains” and click register. On the next page, under “Keys” you will be given a Site Key and a Secret Key. Enter the Site Key next to $recaptchasitekey in “config.php” and the Secret Key next to $recaptchasecretkey.

7. Creating the folder on your web host¶

On your web host, in the public folder (usually called “public”, “public_html” or sometimes just “www”), create a folder for SDonate to go in. Now, using FTP or your web host’s build-in file browser upload everything from INSIDE the “web” folder into the folder you just created. When this is done, navigate to http://<yourdomain.tld>/<yourfolder>/install.php to complete installation, so if your domain is “myamazingdomain.com” and the folder you created is called “donate”, you’d go to http://myamazingdomain.com/donate/install.php. If all is well it will just say “Installation complete!”, and if not, it will tell you what is wrong.

8. Log into your store and check that the directory has been detected properly¶

Now, log into your store using the admin account you selected then click on “Admin” at the top right. Now click on “Info” and it will tell you the URL that SDonate has detected it has been installed in. If this is incorrect, you will need to type the correct URL next to $dir in config.php. It is important that this is correct for PayPal payments to work.

You have now installed SDonate on your web server! You should look at the section on setting up payment information to accept payments.

1. Extracting the addon¶

If you haven’t already, download SDonate from ScriptFodder then extract the “sdonate-gmod-plugin” folder somewhere on your PC, preferably on your desktop for easy access.

2. Configuring the addon¶

Go into the extracted “sdonate-gmod-plugin” folder, then open the “lua” folder. Open the file called “sdonate_config.lua” using your text editor. In the quotation marks next to SDonateURL enter the URL of your pluginapi.php file. If you installed SDonate using the free included one-click hosting and setup, go to https://sdonate.com and go to your account page, you will see the URL next to “Plugin API URL”. If you installed SDonate’s website on your own web server, the url is http://<yourdomain.tld>/<yourfolder>/pluginapi.php, so if my domain was “myamazingdomain.com” and the folder SDonate was installed in is called “donate”, the URL would be http://myamazingdomain.com/donate/pluginapi.php. Now, in the quotation marks next to SDonateAPIKey enter your SDonate API key you generated earlier, and next to SDonateServerIP enter your Garry’s Mod server’s IP and next to SDonateServerPort. The default chat command to open your donation store website is ”!donate”, but if you want to change this to something else change SDonateCommand.

3. Upload to your server¶

Save all your changes to “sdonate_config.lua”, then upload the “sdonate-gmod-plugin” folder to your Garry’s Mod server’s addon folder, then restart your Garry’s Mod server.

1. Extracting the plugin¶

If you haven’t already, download SDonate from ScriptFodder then open the “sdonate-minecraft-plugin” folder and extract “SDonate Plugin.jar” somewhere on your PC, preferably on your desktop for easy access.

2. Upload to your server and configure¶

Upload “SDonate Plugin.jar” into your Minecraft server’s plugin directory then restart your server. You will probably get a lot of errors, don’t worry, this is normal. In your Minecraft plugin directory there should be a folder called “SDonate_Plugin”. Open this folder, and inside there is a file called “config.yml”. Edit this file, making the following changes:

• Next to URL write the URL to your pluginapi.php file. If you installed SDonate using the free included one-click hosting and setup, go to https://sdonate.com and go to your account page, you will see the URL next to “Plugin API URL”. If you installed SDonate’s website on your own web server, the url is http://<yourdomain.tld>/<yourfolder>/pluginapi.php, so if my domain was “myamazingdomain.com” and the folder SDonate was installed in is called “donate”, the URL would be http://myamazingdomain.com/donate/pluginapi.php.
• Next to Plugin API Key write your SDonate API you generated earlier. You can get it from your account page at https://sdonate.com.
• Next to IP write the IP of your Minecraft server. This must be in numeric form i.e. “123.53.24.63” and NOT a domain like “play.myamazingserver.com”.
• Next to Port write the port your Minecraft server is running on. By default this is 25565.

3. Restart your server¶

Save all your changes to “config.yml”, then restart your Minecraft server.

1. Extracting the plugin¶

If you haven’t already, download SDonate from ScriptFodder then open the “sdonate-rust-plugin” folder and extract “SDonate.cs” somewhere on your PC, preferably on your desktop for easy access.

2. Upload to your server and configure¶

Upload “SDonate.cs” into the “oxide/plugins” directory then restart your server. Now, in the “oxide” folder there should also be a folder called “config”, and inside the “config” folder is a file called “SDonate.json”. Open this file and make the following changes:

• Next to PluginAPIUrl write the URL to your pluginapi.php file. If you installed SDonate using the free included one-click hosting and setup, go to https://sdonate.com and go to your account page, you will see the URL next to “Plugin API URL”. If you installed SDonate’s website on your own web server, the url is http://<yourdomain.tld>/<yourfolder>/pluginapi.php, so if my domain was “myamazingdomain.com” and the folder SDonate was installed in is called “donate”, the URL would be http://myamazingdomain.com/donate/pluginapi.php.
• Next to SDonateAPIKey write your SDonate API you generated earlier. You can get it from your account page at https://sdonate.com.
• Next to ServerIP write the IP of your Rust server. This must be in numeric form i.e. “123.53.24.63” and NOT a domain like “play.myamazingserver.com”.
• Next to ServerPort write the port your Rust server is running on. By default this is 28015.

3. Restart your server¶

Save all your changes to “SDonate.json”, then restart your Rust server.

1. Extracting the plugin¶

If you haven’t already, download SDonate from ScriptFodder then extract the “sdonate-sourcemod-plugin” folder somewhere on your PC, preferably on your desktop for easy access.

2. Upload to your server and configure¶

Upload everything INSIDE the “sdonate-sourcemod-plugin” folder into “/addons/sourcemod” on your server. Now, restart your server and go to “cfg/sourcemod”, in here should be a file called “sdonate.cfg”, open it and edit the settings as follows:

• Next to sdonate_apikey write your SDonate API you generated earlier. You can get it from your account page at https://sdonate.com.
• Next to sdonate_serverip write the IP of your server. This must be in numeric form i.e. “123.53.24.63” and NOT a domain like “play.myamazingserver.com”.
• Next to sdonate_serverport write the port your server is running on. By default this is 27015.
• Next to sdonate_url write the URL to your pluginapi.php file. If you installed SDonate using the free included one-click hosting and setup, go to https://sdonate.com and go to your account page, you will see the URL next to “Plugin API URL”. If you installed SDonate’s website on your own web server, the url is http://<yourdomain.tld>/<yourfolder>/pluginapi.php, so if my domain was “myamazingdomain.com” and the folder SDonate was installed in is called “donate”, the URL would be http://myamazingdomain.com/donate/pluginapi.php.

3. Reload The Plugin¶

Save all your changes to “sdonate.cfg”, then either use the command “sm plugins reload sdonate” in your SERVER console, or just restart the server.

Command Variables¶

You can use the following variables in command parameters to replace it with the user’s own info. Valid variables are as follows:

• {{VAR=STEAMID}} - The user’s 64-bit Steam ID i.e. 76561197960287930
• {{VAR=STEAMID32}} - The user’s 32-bit Steam ID i.e. STEAM_0:0:111010
• {{VAR=STEAMID3}} - The user’s SteamID3 i.e. U:1:222020
• {{VAR=STEAMUSERNAME}} - The user’s Steam username (NOTE: This should not be used to assign packages, since more than one user can have the same Steam username, this should only be used for things like sending a personalised message such as “Thanks for purchasing, {{VAR=STEAMUSERNAME}}”)
• {{VAR=Minecraft_Username}} - The user’s Minecraft username.

Creating User Choices¶

If you have ticked “User Chooses”, you can create choices for the parameter. If you do not create any choices, the buyer will be able to enter anything they want, but if you create at least 1 choice they will have to choose between the options you define. When creating a choice, you have to enter a name, value and price. The name is what is displayed to the buyer when choosing, the value is the actual parameter value and the price is the amount added to the package price if this choice is chosen. For example, if creating a choice for the “DarkRP Add Money” command, if you enter the name as “Ten Thousand Dollars”, value “10000” and price “0”, this will add nothing to the base package price and will add $10000 to their DarkRP money if this option is chosen.

For more info on the actions available for various games see:

• Actions - Garry’s Mod
• Actions - Minecraft
• Actions - Rust
• Actions - Other Games
• Special Actions

Console Command¶

Run a console command on the player.

Parameters:

• Command - The console command to run.
• Package Expiry Command - The command to run when the package expires or when the package is revoked.

Custom LUA¶

Run a custom LUA command.

Parameters:

• LUA - The LUA code to run.
• Package Expiry LUA - The LUA code to run when the package expires or when the package is revoked.

Add To Group¶

Add the user to the specified group using either ULX, FAdmin, Evolve, Assmod or ServerGuard. Make sure to choose the right one for the admin mod your server is using.

Parameters:

• Rank - The rank to give the user. Note that for Assmod this must be the rank number and for all other mods it must be the rank name.

DarkRP Add Money¶

Give the user the specified amount of money in DarkRP.

Parameters:

• Money - The amount of money to give the user.

DarkRP Custom Job¶

Create a custom job in DarkRP.

Parameters:

• Job Name - The name of the job.
• Models - The file paths of the models available for this job separated by commas. Example - /path/to/model/model1.mdl,/path/to/model/model2.mdl,/path/to/model/model3.mdl If you want to offer the user a choice of models enter the path to each one in a seperate choice.
• Description - The job description.
• Weapons - The weapons this job spawns with separated by commas. Example - weapon_ak472, weapon_keypadchecker, lockpick If you want to offer the user a choice of weapons enter each one in a seperate choice.
• Salary - This job’s salary.
• Has License - Whether this job has a weapon license. Enter 0 for no and 1 for yes.

Pointshop 1 Points¶

Give the user the specified amount points in Pointshop 1.

Parameters:

• Points - The amount of points to give the user.

Pointshop 2 Standard Points¶

Give the user the specified amount of standard points in Pointshop 2.

Parameters:

• Points - The amount of standard points to give the user.

Pointshop 2 Premium Points¶

Give the user the specified amount of premium points in Pointshop 2.

Parameters:

• Points - The amount of points to give the user.

Send Chat Message to Buyer¶

Put a message in the chatbox of the buyer.

Parameters:

• Message - The message to display in the user’s chatbox.
• Expiration Message - The message to display in the user’s chatbox when the package expires or is revoked.

Send Chat Message to All Players¶

Put a message in the chatbox of all players on the server.

Parameters:

• Message - The message to display in all players chatboxes.
• Expiration Message - The message to display in all players chatboxes when the package expires or is revoked.

CombineControl Donation¶

Add a donation perk to the CombineControl donations database.

Parameters:

• DB Host - The hostname the MySQL server is running on

• DB Name - The name of the database

• DB Username/DB Password - The username and password of the user used to access the database

• Character ID - Set this to “User Chooses” to let them enter their own character ID, or enter -1 to use Prop Limit Increase, Ragdoll Limit Increase, Scoreboard Title or Scoreboard Title Color donation types.

• Donation Type - The type of donation perk. Valid donation types are as follows (only enter the number):

  • 1 - Credits
  • 2 - Strength Stat
  • 3 - Speed Stat
  • 4 - Toughness Stat
  • 5 - Agility Stat
  • 6 - Perception Stat
  • 7 - Aim Stat
  • 8 - All Stats (global stat boost)
  • 9 - Custom Model

  The following donation types only work if Character ID is set to -1:

  • 1 - Prop Limit Increase
  • 2 - Ragdoll Limit Increase
  • 3 - Scoreboard Title
  • 4 - Scoreboard Title Color (in the form “r g b” 0-255)

• Donation Data - Enter the relevant data for the donation type chosen. For example, if you’d chosen “Credits” as the donation type, and enter “500” in the donation data, the person will receive 500 credits.

Console Command¶

Run a console command on the player.

Parameters:

• Command - The console command to run.
• Package Expiry Command - The command to run when the package expires or when the package is revoked.

Custom Command¶

Run a console command on the server.

Parameters:

• Execution Time - Choose whether the command will run as soon as the purchase is complete or when the user next joins the server, for most commands you should choose “On Join” to make sure the commands runs properly.
• Command - The console command to run.
• Expiration Command - The command to run when the package expires or when the package is revoked.

Give Item¶

Give the purchaser X amount of a certain item.

Parameters:

• Item Shortname - The shortname of the item to give the user. You can find a list of these at http://docs.oxidemod.org/rust/#item-list.
• Amount - The amount to give.

Give Blueprint¶

Give the user a blueprint for a certain item.

Parameters:

• Item Shortname - The shortname of the item for the blueprint. You can find a list of these at http://docs.oxidemod.org/rust/#item-list.

Important Notes¶

RCON commands are ran as soon as the buyer purchases the package, for this reason it is recommended that you DO NOT use commands that require the user to be connected to the server, as they will not work if the user is not connected to the game server when they are making a purchase. Test commands using the “Test Server” button to see which commands work. Use “Custom Command” instead of “RCON Console Command” if the Sourcemod plugin is installed.

RCON Console Command¶

Run a console command on the player via RCON.

Parameters:

• Command - the command to run

Custom Command (REQUIRES SOURCEMOD PLUGIN)¶

Run a console command on the server.

Parameters:

• Execution Time - Choose whether the command will run as soon as the purchase is complete or when the user next joins the server, for most commands you should choose “On Join” to make sure the commands runs properly.
• Command - The console command to run.
• Expiration Command - The command to run when the package expires or when the package is revoked.

Important Notes¶

RCON commands are ran as soon as the buyer purchases the package, for this reason it is recommended that you DO NOT use commands that require the user to be connected to the server, as they will not work if the user is not connected to the game server when they are making a purchase. Test commands using the “Test Server” button to see which commands work. Use “Custom Command” instead of “RCON Console Command” if the Sourcemod plugin is installed.

MySQL Query¶

Perform a query on a MySQL database.

Parameters:

• DB Host - The hostname the MySQL server is running on
• DB Name - The name of the database
• DB Username/DB Password - The username and password of the user used to access the database
• DB Query - The query - you can use prepared values by replacing values to prepare with a ?
• DB Prepared Values - The values to be prepared, seperated by a |NEWVAL|

My package doesn’t show up in my store even though it’s enabled!¶

Make sure your package has at least one command added, then make sure that command has your server enabled. A package won’t show up for a server if it has no commands enabled for that server.

PayPal Error 10002 - Security header is not valid¶

Your PayPal API credentials are incorrect, follow the instructions in Setting Up PayPal again.

I’ve enabled Maintenance mode and now I can’t disable it!¶

Go to http://yourdomain.com/folder/login.php, or if you are using the one-click hosting and setup this will be at https://sdonate.com/stores/<yourdomain>/login.php. When you have logged in, go to http://yourdomain.com/folder/dashboard.php (https://sdonate.com/stores/<yourdomain>/login.php if using free SDonate hosting).