-
Notifications
You must be signed in to change notification settings - Fork 7
Meldii Usage Guide
This page will help you package up you addon for use with Meldii.
Basically a Meldii addon is just a zip file contains your addons files and a melder_info.ini file.
The recommended structure inside the zip is this:
|-AddonName
|--Addon.lua
|--Addon.xml
|--melder_info.ini
That is that the top level entry in the zip is a folder with your addons name, then in this folder you have all the files and content for your addon as well as the melder_info.ini (the ini can really go any where but this is preferred).
Now for the normal content of the melder_info.ini:
title=MeldiiExample
author=Bill Murray
version=1.0
patch=1.2.1740
url=http://www.firefall.com/community/threads/GhostBuster.1
description=Who are you gonna call
GHOST BUSTERS!!
Most of the above should be self explanatory, but to be clear.
- Patch refers to the most recent version of Firefall that this addon is compatible with.
- Description can be multi lined.
Here are more options that you can use but aren't commonly needed
destination=gui/components/MainUI/
remove=gui/components/MainUI/HUD/Abilities/
ignore=filename
-
destination
is used in mods to set where the contents of the addon will be extracted to, any file in the zip will cause the original file to be backup-ed and overwritten with the file in the zip. -
remove
You can have multipleremove
commands, this will cause Meldii to back these up and remove them when the addon is installed -
ignore
You can have multipleignore
commands, these files will not be extracted from the addons zip.
Now that you have your addon packaged up its time to host it!
At the moment you have two choices when it comes to hosting a Meldii addon.
In the Help flyout in Meldii there is a Melder Info Generator, use this to create the tags you will need to embed in your fourm thread.
eg.
[center][url=http://goomichan.github.io/Meldii/install.html?id=15425]
[img]http://goomichan.github.io/Meldii/images/OneClick.png[/img][/url]
[size=1][color=#161C1C]
[melder_info]version=1.0;patch=prod-1933;dlurl=15425;providertype=FirefallForums[/melder_info]
[/color][/size][/center]
When you embed this in your forum post you will get a One click install button as well as the tags Meldii need to check if there is a new version out.
That mean that each time you release an update you will need to edit or replace these tags with new ones.
If the addon is hosted on the forums that means that the addon is attached to the post as an attachment.
Once you have uploaded the file to the forums paste the url to it into Meldiis info generator to create the correct tags and then place those in your forum post.
.. say stuff