(GFL) Automated Steam Donations ReadMe

[denros]

Automated donation system for Steam Game Servers. Allows users to donate or subscribe to your community and handles automatic in-game perk addition and removal. Perfect for gaming communities who want to allow users to donate to support their servers for in-game admin or perk groups.
This application currently comes with a SourceMod plugin for all Source games (CSGO, CSS, TF2) and Garry’s Mod ULX plugin to allow for automated in-game groups after donation. It is also developed with a REST API so support can be added for any game which steam supports for developers or I am willing to develop them on request

Demo: http://davidsaji.site.nfoservers.com/dev_ips/index.php?/donate/ or https://gflclan.com/donate/

Key Features

• Automated PayPal donations
• Supports recurring subscriptions or one-time payments
• Outgoings log for full transparency of finances (Can be disabled)
• Donation Goals with PayPal Balance
• Top Donors List
• Integration with (GFL) Multi-Game Server List (https://invisioncommunity.com/files/file/9411-gfl-multi-game-servers-list/) allowing for collection of stats such as which server’s users have been donating to most and how much each server is bringing in.
• Widgets (Top Donors, Latest Donations, Top Servers Donated To)
• Add user to forum group on donation and removal on cancellation
• Add user to in-game group on donation and remove on expiration or cancellation
• Guest donations (Allow users to donate using steamid without logging in for easier quick donations)
• Donor Banner on Topics and User Profile.

Requirements

• Requires a Steam Login Method for IPS. Choose one of the two, second one is FREE.

1.          Steam Profile Integration : https://invisioncommunity.com/files/file/8170-steam-profile-integration/ 
2.          Steam Login Method : https://invisioncommunity.com/files/file/7555-steam-login-method/ 

• PayPal Account for Payment Gateway.

Installation

Make sure you have above requirements before proceeding.

Website / Forum Setup

1. Install the included gfldonations.tar file through your IPS ACP.
2. In ACP go to Donations/Settings, follow the instructions on the page and input your PayPal and configuration details. Make sure to use the live credentials and to enabled options shown below, especially Transaction Search.
3. In ACP go to Donations/Perk Groups, this is where you create your donor groups. Follow the instruction on the create page and make your perk groups. 
4. Now you are done with your website setup, move on to in-game setup now.

In-Game Setup

1. Make sure your in-game groups for Perks have been created either through ULX for GMOD or sourcemod admin_groups.cfg or sourcebans. This group name should be same as the group you specified when creating a perk group through ACP.
2. Install the appropriate included in-game plugin, sourcemod and gmod plugins are provided. 
3. For Sourcemod, move the sourcemod folder into your csgo/addons folder of server.
4. For GMOD, move the plugin into your addons folder.
5. Now you need to provide an API key and website url so they plugins can access who have donated. 
6. First go to your website IPS Admin CP. Go to Site Feature/ REST & OAuth section. Click the API Keys tab and create a new API key. For Endpoint Permissions, allow (GFL) Donations > Server Game Groups Access and log. An image is shown below as an example.
7. Make a note of your created API key.
8. Now edit the in-game config to have this key. 
9. For Sourcemod, go to csgo/cfg/sourcemod/ GFL-Steam-Donations.cfg and fill in your API Key and Website URL.
10. For GMOD, open gmod\garrysmod\addons\GFLDonations\lua\ulx\modules\ gfldonations_init.lua and input the API details you created. 
11. Fully restart your servers and check logs for errors.

Now everything is setup for automated donations and in-game perks.

If you require any help regarding installation or additional support for games and servers, add me on Steam: https://steamcommunity.com/id/devu4/