Extension Developer Help

AbanteCart Extension Submit Format Manual

Who is this document for:

This is a quick reference for AbanteCart extension developers or individuals submitting extensions to the AbanteCart Marketplace. The document covers the basics of standards and requirements for an extension archive to be uploaded and listed in the marketplace.

Why follow standards:

Following standards helps ensure high-quality extensions and a better experience for AbanteCart users. Standards also help developers adapt quickly to future system improvements. Our team continuously enhances these guidelines. We recommend using the extension developer tool to generate a standard extension framework.

Archive Naming Convention

You can name your submitted ZIP archive however you prefer. After upload, the file will be renamed using the extension’s unique text ID and version. Example: product_features_v101.tar.gz

Ensure the extension text ID is unique by searching the Marketplace. Avoid starting the ID with default, which is reserved for core extensions.

Extension Archive Content

Organize files as outlined in the extension development manual. Some required files and directories:

Package Level (main archive directory):
Required:
/[archive]/code/extensions/[extension_text_id]
/[archive]/license.txt
/[archive]/package.xml

Optional:
/[archive]/copyright.txt
/[archive]/code/extensions/[other_ext_id]
/[archive]/manuals/

/[archive]/code/extensions/[extension_text_id] – Directory with extension code.
Note: Multiple extensions can be included, but only one main extension is used for installation.

/[archive]/license.txt – Licensing information displayed during installation. Use UTF-8 encoding.

/[archive]/package.xml – Package details in XML format. Learn more

Extension Level (/[archive]/code/extensions/[extension_text_id]):
Required:
config.xml – Extension settings and details.
main.php – Main extension controller.
image/ – Extension icon directory.
admin/language/english/[extension_text_id]/[extension_text_id].xml – Admin language file.

Images:
  • image/icon.png (57×57 px) – Required in the archive.
  • Upload manually after package upload:
  • icon-hi-resolution.png (114×114 px)
  • main.jpg (1500×800 px, .png allowed)
  • Any additional .jpg or .png images will appear in the preview slider.
Note: Archive size is limited to 6MB. Remove unused files or host large resources separately.
Glossary:

Extension Text ID:
Unique identifier using lowercase alphanumeric characters and underscores (no spaces or special characters).
Example: product_features

Extension Version:
Follow software versioning standards to manage and track updates.

AbanteCart Versions:
Your extension must specify the minimum supported AbanteCart version. Extensions are compatible with all newer versions within the same minor release (e.g., 1.3.x). Major version changes will trigger install warnings.
Continue