Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.91 KB

Readme.md

File metadata and controls

41 lines (31 loc) · 1.91 KB
Raw

NAEV PLUGINS

This repository is meant to be a place to centralize a list of approved plugins. If you want to make changes such as adding plugins or updating their information, please open a pull request to do so.

How to Use Plugins

Due to a lack of a proper plugin manager (help wanted!), installation has to be done manually at the moment.

Manual Install

Installation is as simple as dropping the plugin .zip file (or entire directory, such as git clone) into your plugin directory. You can find your plugin directory by running Naev, clicking on options, then clicking on plugins. When you launch Naev, it should automatically detect the plugins and load them. You can check loaded plugins by looking at the plugins tab in the options menu.

Plugin Information Format

The plugin information format is a stub of the plugin.xml that is necessary in each plugin with additional information on where to get the plugin. In particular, an example is shown below.

<?xml version="1.0" encoding="UTF-8"?>
<plugin name="Sea of Mayonnaise">
 <author>Naev DevTeam</author>
 <license>GPLv3+</license>
 <website>https://github.com/naev/total_conversion_plugin_example</website>
 <git>https://github.com/naev/total_conversion_plugin_example</git>
</plugin>

To obtain the plugin you can either use a <git> node indicating that the link is to a git repository, or you can use a <link> to directly link to a zip file to download. A summary of the available nodes is shown below:

  1. <author>: Specifies the author(s) of the plugin.
  2. <git>: specifies the git repository of the plugin. Is not necessary if <link> is used instead.
  3. <link>: specifies a direct link to download a zip of the plugin. Is not necessary if <git> is used instead.
  4. <website> (optional): specifies the website of the plugin
  5. <license> (optional): Specifies the license of the plugin.