Code Monkey home page Code Monkey logo

es-mod-share's Introduction

Endless Sky Plugin Share

About

ES Plugin Share is a plugin sharing website for Endless Sky

  • Note: I changed my name to CodeDraken so replace any links that are evan153. Eventually this should be moved or an offical one should be created on the main Endless Sky repo.

Go to the website

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

  1. 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 )

  2. 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.

  3. 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.
  4. Finally, make 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.

es-mod-share's People

Contributors

codedraken avatar wispborne avatar makuta-miras avatar amazinite avatar tmbutterworth avatar kriegstofu avatar darcymanoel avatar itsnickbarry avatar yellowapple avatar wrzlprnft avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.