Upgrading Movie Jukebox - YAMJ/yamj-v2 GitHub Wiki

How to upgrade to the latest version of the MovieJukebox

Introduction

This page details how you can upgrade to a newer version of the !MovieJukebox.

Saving Your Configuration Files

If you have edited any of the default properties files, then you should save these somewhere safe before updating your installation.

To preserve your settings you should use the moviejukebox.properties file, which is not overwritten when you upgrade. However, if you have changed any of the skin.properties for your skin, you should copy these values in to a skin-user.properties file which will not be overwritten when you upgrade. However, it is good practice to save this file somewhere just in case.

Updating the !MovieJukebox Files

The next step is to delete the lib and properties folders to ensure a clean upgrade and then simply extract all the files from the latest zip file overwriting any files in your !MovieJukebox directory.

You can then copy your settings files back into the appropriate folders.

You may also have to delete the skin folder if you get any transformation errors after the upgrade. Simply remove the !MovieJukebox supplied folders from the skin folder (default, sd, hebrew, gfb107 & gfb107-sd) and unpack them from the zip file.

Running the Jukebox

The first run after the jukebox software has been updated will re-create all of the XML files and will therefore take longer than usual. Often there are changes in how the jukebox works internally that means that this is necessary to prevent problems.

Changing Genres.xml and Categories.xml

If you have edited either of these two files, then they WILL be overwritten when you upgrade MovieJukebox. To prevent this in the future, you should follow the following steps:

  • Copy categories.xml to my-categories.xml
  • Copy genres.xml to my-genres.xml
  • Add these lines into the moviejukebox.properties file
# Genres file used for consolidating/renaming genres
mjb.xmlGenreFile=my-genres.xml

# Categories file used for enabling/renaming categories
mjb.xmlCategoryFile=my-categories.xml

Now next time you do an upgrade (official or development) you will only need to look for any new changes and update your version (my-???.xml), although these files are rarely changed.