[Brian]

With the release of Jamroom 4.1.3, there is now a new "Module Manager" built in to the Jamroom Control Panel. If you have developed a Jamroom module, there are a couple of things you will want to update in your module so it works properly in the new Module Manager:

• thumbnail.png - this is a new icon/image file that must be located in your jamroom/modules/Module_Name directory. It must be called "thumbnail.png" and be 96x96 pixels. If you do not make it 96x96 pixels, the image will be resized to that aspect ratio, which may not look very good, so be sure your image is the proper size. It must be a PNG image.
  
• There are 3 new $config variables that need to be defined in your module's include.php script:
  
  

  Code

  $config['ModuleName_developer'] = 'Your Name or company name'; $config['ModuleName_description'] = 'A Description of what your module does'; $config['ModuleName_support_url'] = 'http://yoursite.com';

  
  These should be located right under the current "version" config variable, and should be:
  - developer: This should be your company name or your name
  - description: This is a description of exactly what your module does. This is not a place for an advertisement, but a simple 2-3 line description.
  - support_url: This needs to be a link to a forum/page that your users can get help at. It IS ok to point to Jamroom's 3rd party support forum, but you need to make sure this is a location you will be checking on a daily basis for support.
  

That's about it - setup right it will make your module look really nice in the new Module Manager.

If anyone has any questions, please let me know.

Thanks!

- Brian


_________________
Make sure and check out:
* The Jamroom FAQ
* The Jamroom Documentation

Last edited by Brian on 09/18/13 16:58; edited 1 time in total

[SteveX]

Thanks Brian, this is really neat.

Just wondering, would it be possible to post a brief description of how to use the new module comments?


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[Brian]

Sure - there are 3 additional fields that need to go in your module/ModuleName/include.php file:

Code

$config['ModuleName_developer']   = 'Your Name/Developer Name'; $config['ModuleName_description'] = 'Short description of what your module does'; $config['ModuleName_support_url'] = 'http://yoursupportforum.com';

These would be placed right underneath your "version" $config variable entry.

The 3 fields are hopefully self describing - note that you can use the 3rd party forum here on Jamroom.net as your support forum url - just make sure you are keeping tabs on any posts into that forum that relate to your module.

Hope this helps!

- Brian


_________________
Make sure and check out:
* The Jamroom FAQ
* The Jamroom Documentation

[SteveX]

Ah, sorry, I meant the new module comments in the tracker here:
http://www.jamroom.net/index.php?m=td_tracker&o=view&id=1648

I should really have started a new thread.


_________________
Kulshi Mezian!

"Stranger from another planet, welcome to our hole. Just strap on your guitar and we'll play some rock and roll"

Ultrabubble create things.

[Brian]

SteveX:

Ah, sorry, I meant the new module comments in the tracker here: http://www.jamroom.net/index.php?m=td_tracker&o=view&id=1648 I should really have started a new thread.

I need to so some additional module documentation - I'll get that online after the 4.1.4 release, since there may be a need to change/tweak a few things up until the release.

Hope this helps!

- Brian


_________________
Make sure and check out:
* The Jamroom FAQ
* The Jamroom Documentation