Magento 2 Integration
Installation Guide
Install our Magento 2 module via zip upload or Composer. The widget renders automatically on product pages.
Download Module
gunupdate-magento2.zip — v1.0.0
Method A: Manual Install
1 Extract Files
Unzip and copy to your Magento installation:
unzip gunupdate-magento2.zip -d app/code/GunUpdate/Widget/
2 Enable & Deploy
php bin/magento module:enable GunUpdate_Widget
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
Method B: Composer (coming soon)
composer require gunupdate/magento2-widget
php bin/magento setup:upgrade
php bin/magento cache:flush
3 Configure
Go to Stores → Configuration → General → GunUpdate Widget. Enable the module, enter your API key, select mode and theme. Save & flush cache.
Widget Modes
compatibility
"Does this fit my gun?" — customer uploads photo or selects model, gets yes/no answer + compatible products from your store.
builder
Interactive gun builder — clickable hotspot zones on a gun silhouette. Customers explore accessory categories visually.
configurator
Full experience — build + compatibility check + smart recommendations. Best for stores with 50+ gun accessories.
Data Attributes Reference
| Attribute | Required | Description |
|---|---|---|
| data-store | Yes | Your API key |
| data-product-id | Yes | Product ID on your platform |
| data-product-name | No | Product name for better matching |
| data-product-sku | No | SKU for precise matching |
| data-mode | No | compatibility | builder | configurator |
| data-theme | No | light | dark | auto |
| data-platform | No | Platform identifier for analytics |
| data-lang | No | Language code (default: en) |
Requirements
- • Magento 2.4+
- • PHP 8.1+
- • Composer access
- • GunUpdate API key