2.1 KiB
2.1 KiB
OpenCart 3 Module Template
A comprehensive template for developing custom modules and extensions for OpenCart 3.x e-commerce platform.
Features
🚀 OpenCart 3 Compatibility
- Fully compatible with OpenCart 3.x versions
- Uses OCMOD (OpenCart Modification) system for safe modifications
- No core file changes required
📦 Module Structure
- install.xml: OCMOD installation file with modification definitions
- upload/: Directory for module files to be uploaded to OpenCart
- install.php: Optional PHP installation script
- install.sql: Optional database installation script
🔄 Automated Releases
- Integrated Gitea Actions workflow for automatic builds
- Generates
.ocmod.zippackages on push to main branch - Extracts metadata from
install.xmlfor versioning - Ready-to-install extension packages
🛠️ Development Tools
- XML-based modification system
- Template structure for rapid module development
- CI/CD pipeline for quality assurance
- Version management through install.xml
Installation
- Clone this repository
- Customize the
install.xmlwith your module details:- Set
<name>,<code>, and<version> - Add your modifications in the
<file>sections
- Set
- Place your module files in the
upload/directory - Add installation scripts if needed (
install.php,install.sql) - Push to your repository to trigger automatic release build
Usage
For Module Developers
- Use this template as a starting point for new OpenCart modules
- Define your modifications in
install.xml - Add custom files to
upload/directory - Test locally before deploying
For Store Owners
- Download the generated
.ocmod.zipfrom releases - Upload via OpenCart's Extension Installer
- Install and configure the module through admin panel
Requirements
- OpenCart 3.x
- PHP 7.3 or higher
- MySQL 5.7 or higher
- OCMOD support enabled
Author
Mohamed Youssef
Website: my-dev.pro
Email: Contact through website
License
This template is provided as-is for OpenCart module development. Please check individual module licenses for usage terms.