Help Center

Find answers or browse our knowledge base.

Version File — version.json

What it is: version.json is a helper file used by the ScriptsTribe Plugin System to track versions, changelogs, and “what’s new” notes for your addon.

  • Location: /modules/{addonid}/version.json
  • Important: This file is not shipped with the addon ZIP. It should stay on your local development machine or ScriptsTribe store server so the plugin system can check for updates.
  • Purpose: tells the plugin manager what changed in each release.

Structure

  • version: current version of the addon.
  • whats_new: a flat list of highlights for the current release.
  • changelog: an array of objects, each containing:
    • version — release number
    • date — release date
    • changes — list of changes in that version

Sample version.json


{
  "version": "1.2.0",
  "whats_new": [
    "Added profile tabs integration",
    "Improved SEO schema for blogs",
    "Fixed minor CSS issue on mobile"
  ],
  "changelog": [
    {
      "version": "1.2.0",
      "date": "2025-09-30",
      "changes": [
        "New: Profile tabs hook (profile_tab.php)",
        "Update: Blog schema markup enriched",
        "Fix: CSS bug on profile content blocks"
      ]
    },
    {
      "version": "1.1.0",
      "date": "2025-08-10",
      "changes": [
        "New: Group settings tab",
        "Update: Compatibility with Sngine 4.1",
        "Fix: Minor SQL index error"
      ]
    },
    {
      "version": "1.0.0",
      "date": "2025-07-01",
      "changes": [
        "Initial release with Page and Event tabs"
      ]
    }
  ]
}

Usage

  1. Keep version.json updated in your development copy.
  2. Never ship it inside the addon folder. Only keep plugin.php, assets, init files, SQL, etc. in the release ZIP.
  3. The ScriptsTribe plugin manager can read version.json from your store server to show admins changelogs and update prompts.

Summary

version.json is an update metadata file — it documents new features and fixes, but is not part of the deliverable addon package. Ship only the addon files to customers, and keep version.json on your development/store server for update tracking.

Was this answer helpful?
You must login to vote.
0 found this helpful, 0 did not
Thank you for your feedback!

Related Articles