The MOD Team is working on creating a new tool for the MOD Community. This new tool called UMIL (Unified MOD Install Library) built by EXreaction under the supervision of the MOD Team, enables MOD Authors to create simple installation scripts for their MOD that allow the user to one-click install, update, or uninstall a MOD.
UMIL does not perform file edits. AutoMOD (Blinky) is the tool of choice for file edits and installing MODs from a MODX (xml) file. However, AutoMOD (Blinky) does not perform database changes. This is why UMIL exists.
What does UMIL do?
The Unified MOD Install Library will perform the following operations:
- Cache functions
- Purge Cache
- Config functions
- Add configs
- Update configs
- Remove configs
- Determine if a config exists
- Module functions
- Add modules
- Remove modules
- Determine if a module exists
- Permissions/Auth functions
- Add Permissions
- Remove permissions
- Determine if a permission exists
- Table functions
- Add tables
- Remove tables
- Determine if a table exists
- Table column functions
- Add columns
- Remove columns
- Update (change) columns
- Determine if a column exists
- Table Key/Index functions
- Add key/index
- Remove key/index
- Determine if a key/index exists
When a user download’s a UMIL enabled Modification, they can run the installation script (called a UMIF - Unified MOD Install File) provided with the MOD through a browser on their server. This file will call UMIL - if the UMI Library not exist, the script allows the user to easily download UMIL and then run the installation script provided by the MOD Author. UMI Files can be ran in much the same way phpBB3 is installed onto the server.
UMIFs provide a nice GUI (Graphical User Interface) that enables the user to easily install, update and uninstall MODs.
Multiple translations are supported in the UMI library with no need for MOD Authors to support all languages. They are automatically translated and provided within the UMI Library.
How does UMIL benefit the end-user?
UMIL makes installing modules, permissions, making SQL changes, purging caches, etc. an easy and pain-free task. The user would simply run the installation script provided and the UMI Library would determine how it needs to run, if it needs to update the installation of the MOD, install the MOD, or uninstall the MOD at the user’s request. Where MODs would normally use the DIY-Instructions in MODX, or their own installation script, they would now use the UMI Library.
How does the MOD Author use UMIL?
The MOD Author will create a file called the UMIF (Unified MOD Install File), this file utilises the UMI Library to perform the database installation, updates or uninstalls at the user’s request. UMIL is a very easy to use API (Application Programming Interface) that allows MOD Authors to easily and quickly create UMIF files. UMIL is extremely intuitive and easy to learn.
The MOD Team will also provide a method by which MOD Authors can easily create a UMI File through a GUI tool located on phpBB.com
How does UMIL benefit the MOD Author?
UMIL will allow MOD Authors to create installation scripts very easily and quickly. These installation files will conform to the MOD Database Guidelines with regard to language and templates. UMIL provides translations and templates for the GUI, so there is no need for the MOD Author to create anything other than the database actions to install the MOD.
This means that it will alleviate complicated instructions in the DIY section of MODX files, and will diminish support requests for installation of database changes, such as installing modules, creating new permissions, adding configs, or running SQL queries.
UMIL is use friendly, so it will mean less support headaches, and decreased user-error.
UMIL is currently in the testing phase of development, nearing release. However, the MOD Team would like feedback from the community on what features and functionality to include into UMIL before releasing it to the public, thus the reason for this topic.
Feedback, Suggestions, Comments
The MOD Team is looking for feedback and suggestions on what you would like to see in a UMI Library, what kind of functionality would you be looking for as a MOD Author. What can we add to UMIL that will fulfil all of your needs?