Skip to content

SusanTN/SMF2Donations

Repository files navigation

SMF2Donations

A comprehensive donation management system for SMF 2.1.6+

Package Information

  • Package: SMF2Donations
  • Version: 1.0.0
  • Author: SMF2Donations Team
  • Copyright: 2025
  • License: BSD 3-Clause
  • Compatibility: SMF 2.1.6+

Features

Core Functionality

  • PayPal Integration - Secure payment processing through PayPal
  • Multiple Currencies - Support for USD, EUR, GBP, CAD, AUD, and more
  • Flexible Amounts - Preset amounts or custom donation values
  • Recurring Donations - Monthly subscription support
  • Anonymous Donations - Option for donors to remain anonymous

Administration

  • Dashboard - Comprehensive overview with statistics and recent activity
  • Goal Management - Set and track monthly donation goals
  • Donation History - Complete transaction logs and reporting
  • Settings Management - Easy configuration of all donation parameters
  • Member Groups - Automatic donor group assignment
  • Data Import - Import existing donation data from legacy systems

Display Features

  • Progress Bars - Visual goal tracking with animated progress
  • Donation Ticker - Real-time donation activity display
  • Mobile Responsive - Works perfectly on all devices
  • Theme Integration - Seamlessly integrates with SMF themes

Installation

  1. Download the SMF2Donations package
  2. Go to Admin → Package Manager in your SMF admin panel
  3. Upload and install the package
  4. Configure your PayPal email in Admin → SMF2Donations → Settings
  5. Set your donation goals and preferences

Configuration

After installation, configure the following settings:

Basic Settings

  • PayPal Email - Your PayPal account email for receiving donations
  • Default Currency - Primary currency for your forum
  • Preset Amounts - Common donation amounts (e.g., 5,10,20,50,100)
  • Monthly Goal - Target amount for monthly donations

Display Options

  • Show Progress Bar - Display goal progress on donation page
  • Show Ticker - Display recent donations ticker
  • Thank You PM - Send private message to donors
  • Donor Group - Automatically assign donors to a member group

Advanced Options

  • Multiple Currencies - Enable support for international donors
  • Anonymous Donations - Allow donors to hide their identity
  • Custom Logo - Upload your organization's logo

Data Import

If you have existing donation data from a previous system:

  1. Go to Admin → SMF2Donations → Import Legacy Data
  2. The system will detect your existing treas_donations table
  3. Preview your data to ensure it looks correct
  4. Run the import to migrate all historical donations
  5. Monthly goals will be automatically updated with imported totals

Note: The importer is designed for treas_donations table structure but can be customized for other formats.

Usage

For Administrators

  1. Set monthly goals in Admin → SMF2Donations → Goals
  2. Monitor donations in Admin → SMF2Donations → Dashboard
  3. View detailed history in Admin → SMF2Donations → History
  4. Adjust settings in Admin → SMF2Donations → Settings
  5. Import legacy data in Admin → SMF2Donations → Import Legacy Data

For Members

  1. Navigate to the Donate page from the main menu
  2. Select donation amount and currency
  3. Choose one-time or recurring donation
  4. Complete payment through PayPal
  5. Receive confirmation and thank you message

Database Tables

The package creates two database tables:

smf2donations

Stores all donation transactions with details including:

  • Member ID, amount, currency
  • Transaction ID and PayPal email
  • Date and payment status
  • Anonymous flag

smf2donations_goals

Tracks monthly donation goals:

  • Month and year
  • Goal amount and currency
  • Amount raised to date

File Structure

SMF2Donations/
├── package-info.xml                      # Package installation information
├── SMF2Donations.install.php            # Database installation script
├── SMF2Donations.uninstall.php          # Cleanup script
├── Sources/
│   ├── SMF2Donations.php                # Main functionality
│   └── SMF2Donations.importer.php       # Data import functionality
├── Themes/default/
│   ├── languages/
│   │   └── SMF2Donations.english.php    # Language strings
│   ├── SMF2Donations.template.php       # Front-end templates
│   ├── SMF2DonationsAdmin.template.php  # Admin templates
│   ├── css/
│   │   └── SMF2Donations.css            # Stylesheet
│   └── scripts/
│       └── SMF2Donations.js             # JavaScript functionality
└── README.md

Permissions

The package adds these permissions:

  • smf2donations_manage - Full administrative access
  • smf2donations_view - View donation pages and statistics
  • smf2donations_donate - Make donations (default: everyone)

Support

For support, updates, and feature requests, please visit our support forum or GitHub repository.

License

This software is licensed under the BSD 3-Clause License, the same license used by SMF itself. This ensures complete compatibility and allows for modification and redistribution under the same terms as SMF.

Changelog

Version 1.0.0

  • Initial release
  • PayPal integration
  • Multi-currency support
  • Goal tracking system
  • Admin dashboard
  • Mobile responsive design
  • Anonymous donation support
  • Recurring donation support
  • Legacy data import functionality

Security

  • All transactions are processed securely through PayPal
  • Input validation and sanitization throughout
  • CSRF protection on all forms
  • SQL injection prevention
  • XSS protection

Credits

Built with love for the SMF community. Special thanks to the SMF development team for creating such an extensible platform.

About

A full featured donation plugin for Simple Machines 2.1.6

Resources

License

Stars

Watchers

Forks

Packages

No packages published