Packaging a Module

Applies to: Jamroom 7.0+ Last verified: 2026-10-24
  • Before you start

    Your module works on your development site, and its version number in _meta() is the one you want to release. Every update needs a higher version, such as 1.0.0, then 1.0.1, 1.1.0 or 2.0.0. Note the changes in the module's changelog.txt.

  • Developer settings

    In Developer Tools, Global Config, enter:

    • Developer Name: your name, as on your jamroom.net account
    • Developer Prefix: the prefix your modules and skins start with. See Module Naming.

    The Package Module and Package Skin tools appear under Tools once a prefix is set. They only list modules and skins that start with your prefix.

  • Creating the ZIP

    1. Open Developer Tools > Tools > Package Module.
    2. Choose the Module to ZIP.
    3. Choose the Module License: Mozilla Public License version 2.0 (recommended for free modules), Jamroom Commercial License, MIT License, or Freeware License (no restrictions).
    4. Check Export Form Designer to include fields added with the Form Designer in the module's code.
    5. Create the ZIP, and download it.

    The tool adds the license to the module and names the ZIP after the module and its version. Package Skin does the same for skins.

    The xx prefix packages modules for your own sites: install the ZIP on another site to move a module there.

  • Releasing it

    Upload the ZIP to the Marketplace from your profile on jamroom.net. Sites that have the module then see the new version under ACP > Marketplace > System Updates. When they update, the previous version is kept, so they can go back to it.

  • The jamroom.net upload screens and private release channels aren't covered here. Ask on the forum or contact the Jamroom team if you're releasing for the first time.

Tags