https://opengamemods-group.github.io/ES-Mod-Share/

Mod sharing website for Endless Sky
https://opengamemods-group.github.io/ES-Mod-Share/

Last synced: 10 days ago
JSON representation

Mod sharing website for Endless Sky

• Host: GitHub
• URL: https://opengamemods-group.github.io/ES-Mod-Share/
• Owner: OpenGameMods-group
• Archived: true
• Created: 2016-08-21T20:16:06.000Z (almost 8 years ago)
• Default Branch: gh-pages
• Last Pushed: 2021-07-30T17:00:20.000Z (almost 3 years ago)
• Last Synced: 2024-05-28T15:10:42.337Z (about 1 month ago)
• Language: SCSS
• Size: 11.4 MB
• Stars: 8
• Watchers: 5
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Lists

• awesome-endless-sky - ES-Mod-Share - A large plug-in site, deprecated in favour of a more official approach. (Plug-Ins)

README

        
# Endless Sky Plugin Share

## Deprecation Note

This repo is no longer maintained and no more pull requests will be accepted. You can find the new mod manager and plugin repository at the [Endless Sky Community](https://github.com/EndlessSkyCommunity)

### About

ES Plugin Share is a plugin sharing website for [Endless Sky](http://endless-sky.github.io/)

[Go to the website](https://OpenGameMods-group.github.io/ES-Mod-Share/)

### Installing plugins

Generally, installing a plugin is as simple as dropping it into the Endless Sky `plugin` folder for your operating system, specified here: https://github.com/endless-sky/endless-sky/wiki/CreatingPlugins.

However, some plugins may have issues with other ones, so be sure to read each plugin's description before installation, and **back up your saves**.

### Submitting a plugin to the website

0. Clone/Download/Pull the repo ( this can be complicated for users not familar with Git. A new way of uploading mods may be implemented in the future )

1. Go to the `plugins` folder and add your own plugin folder (eg. `/mods/mypluginfolder`). Inside, add a `metadata.json` file (eg. `/mods/mypluginfolder/metadata.json`). The easiest way is to copy the [the example plugin](https://github.com/CodeDraken/ES-Mod-Share/tree/gh-pages/_plugins/mod-example-title).

2. Images may be either externally linked or hosted by the site.

    - If you are using a local image (included in the website's source, not hosted elsewhere), prepend `local:` before the image name to tell the website that it's not a hyperlink.

        - eg. `local:banner.png`, `local:thumbnail.jpg`

    - The **thumbnail** is a small image that represents your plugin in the list. 

    - The **banner** is larger and shown when your plugin is being viewed by the user.

3. Finally, make a [pull request](https://help.github.com/articles/creating-a-pull-request/)!

Note: The data format for the plugin data is YAML, but it is processed to json, which is why it has the json file extension.

All plugin data is available in json format at https://OpenGameMods-group.github.io/ES-Mod-Share/plugins-json.html.