steps to add a custom module to install/update

[HerzScheisse]

Hi Jefferson,

Thanks for this awesome module... this is really great and very usefull.. Thanks!

anyway... are there some special steps needed to get a module listed inside the Custom Module Manager to be able to use the Github Update service?

I've added the new module to the module_update_service_configuration.json and ModuleUpdateServiceConfiguration.php

but cant get this to work (also deleted server and browser cache couple of times)

can you please explain the needed steps and files to update... and maybe add this to the README file?

Thank You!

/Holger

[Jefferson49]

Hi Holger,

yes, there are some more steps to take if updating the configuration. The code contains several switches to handle this:

• GENERATE_CUSTOM_MODULE_UPDATE_CONFIG
• USE_LOCAL_CONFIG
• GENERATE_DEFAULT_TITLES_AND_DESCRIPTIONS

If you update the configuration in the PHP code, you need to set GENERATE_CUSTOM_MODULE_UPDATE_CONFIG = true and once open/reload the module update view of Custom Module Manager (CMM).

Afterward, you can set USE_LOCAL_CONFIG = true, which will make CMM use the newly generated local configuration.

Additional hints:

• In the latest CMM versions, the JSON file with the configuration is always loaded remotely from GitHub. Therefore, all users can already use a new configuration even if the custom module version of CMM is not updated yet.
• The latest remote JSON configuration can be found in the version branch
• For example, I have already update the remote configuration of the "time-trave-map" module based on your recent pull request :-)
• If you want to use your local JSON configuration (generated like described above) instead of the remote JSON configuration, you need to set USE_LOCAL_CONFIG = true
• The module descriptions for all the custom modules are automatically generated (for all supported languages) from the custom modules itself.

Hope this helps

Markus

[HerzScheisse]

awesome... got it working now... Thanks for the details...
I thought there must be something else, because my changes were not applied... but I didn't looked close enough to see these switches...
Thank you!