endless-sky-plugins

This repository is intended to become the central plug-in index for Endless Sky. It hosts the plugin manifests in the manifest folder as well as autogenerated machine-readable formats in the generated folder.

See Plugins.md for a list of indexed plugins, or go to the official page.

How to add a plugin

To add a new plugin to the repository, you must open a new PR creating a valid manifest file for your plugin. For best results, create a new branch when opening a pull request. Avoid opening PRs directly from the master branch, as it can lead to unnecessary resource usage and make maintenance more difficult.

Name your manifest file after your plugin, use the .yaml extension, and place it in the /manifests/ folder. For details on all available manifest fields and their usage, see the manifest documentation. For sample manifests, refer to the examples section or our existing manifests.

You may also use the manifest generator to generate a valid manifest by filling out the required fields. For most users, using the manifest generator ensures your manifest is complete and error-free. Only hand-craft your manifest if you need advanced customization.

Common issues

Once you have your manifest ready, take a moment to check the following before opening your PR to ensure it's merged promptly and smoothly:

1. Are all of your URLs valid? Try copying and pasting them into a web browser to ensure they all point to the locations you expect.
   • Also, check the autoupdate URLs by inserting the current version and ensure it creates a valid URL.
   • If you have included an iconURL, ensure that it is also correctly versioned.
2. Ensure the version listed on your manifest is a real commit/tag. You should be able to find the same commit on your repository that you have listed in the manifest.
3. Ensure the license you're using is valid, either choose one from the SPDX list or enter ALL-RIGHTS-RESERVED.
   • For open source plugins, it’s recommended to use a license from the OSI-approved list.
4. Is your short description too long? It should be less than 150 and must be less than 200 characters.
   • Valid (under 150 characters): "Expands the galaxy with three new planets and a unique ship."
   • Invalid (over 200 characters): "Expands the galaxy by introducing three brand new planets to visit, each with its own unique storyline and missions, and adds one original, custom ship, featuring new art, stats, and unique outfits and weapons."