FFXIVAPP / ffxivapp

Visit us on Discord! https://discord.gg/aCzSANp
https://xivapp.com
MIT License
89 stars 45 forks source link
addon-manager c-sharp ffxiv overlays plugin-manager wpf

FFXIVAPP

Issue tracking, feature request and release repository.

Join the chat at https://gitter.im/Icehunter/ffxivapp

Main Application Installation

Recommended Format (Issues)

Title: brief description

Description: Detailed description including any log lines or screenshots to illustrate the issue.

Recommended Format (Suggestions)

Title: As a (I can/want to) (because/so I can) .

Description: This is where you can provide examples of what you mean, provide illustrations to support the request (if needed or helpful) and to say if you want; what you ideas of "definition of done" would be.

Formatting

Formatting can be achieved via example from the follow URL: Markdown

Open-Source Plugins

Directions on how-to install for FFXIVAPP are found on each repo. Thanks!

Plugin Installation

Plugins are NOT included in this download. When you open the application go to the Update tab and install the plugins you want; or update one if an update is available.

If you are a developer and want to distribute your own plugins and have update availability then you must have them hosted online somewhere. You will need to make a VERSION.json file that can be added to a sources list in the application.

The format of the file is as follows:

{
    "PluginInfo": {
        "Name": "Plugin.Name.dll",
        "Version": "3.0.5145.29167",
        "Files": [
            {
                "Name": "Plugin.Name.dll",
                "Location": ""
            },
            {
                "Name": "Logo.png",
                "Location": ""
            },
            {
                "Name": "PluginInfo.xml",
                "Location": ""
            }
        ],
        "SourceURI": "http://url/to/base/directory/of/download"
    }
}

If you have other files they can be added into that structure. If they are in sub-directories the the location would be something like this:

{
    "PluginInfo": {
        "Name": "Plugin.Name.dll",
        "Version": "3.0.5145.29167",
        "Files": [
            {
                "Name": "Plugin.Name.dll",
                "Location": ""
            },
            {
                "Name": "Logo.png",
                "Location": ""
            },
            {
                "Name": "PluginInfo.xml",
                "Location": ""
            },
            {
                "Name": "Some.ext",
                "Location": "path/to/sub/folder"
            }
        ],
        "SourceURI": "http://url/to/base/directory/of/download"
    }
}

The location will not have a leading or trailing slash.