User Guide - Cromha-Plugins/Cromha-Expansion-plugin GitHub Wiki

Plugins Installation

You can download other plugins here

Mac/Windows/Linux Download

How do I download a mod? Downloading mods is simple. There are two ways of doing this, and only one must be done to successfully download a mod.

If you're on a version of Endless Sky higher or equal to 1.10.2, you can access your plugin directory by going into the game settings and open the plugin tab then click of the plugin folder button. If not, here is the following steps:

The first (and recommended way) requires you to find an already existing plugins folder that is in a different location than the rest of the Endless Sky files. That folder can be found here (if you don't have any of these folders, check this):

Linux: ~/.local/share/endless-sky/
Windows: C:\Users\[Your user name here]\AppData\Roaming\endless-sky\
Mac OS X: ~/Library/ApplicationSupport/endless-sky/

The second way involves creating a new plugins folder within the Steam Endless Sky files:

Locate your Endless Sky files. These can be located by navigating through your Steam library. Right click Endless Sky, go to "properties," go to "local files," then click "browse local files." This should open up the Endless Sky files on your computer.
Create a new folder within the Endless Sky folder. This folder should be named "Plugins."

It may be wise to have a desktop shortcut to these locations if you wish to install more mods later. Once you have either located the plugins folder or created your own, find whatever mod you want, download the given folder, and place it into the plugins folder. Downloaded mods must have at least a 'data/' directory and a 'about.txt' file inside of it, if there is none of that, it won't work.

Here is a template of a plugins folder:

plugins/
|-- example-plugin/
|   |-- data/
|   |   |-- jobs.txt
|   |	 ...
|   |-- images/
|   |   |-- ship/
|   |   |   |-- example-ship.png
|   |   |	 ...
|   |	 ...
|   |-- sounds/
|   |   |-- ambient/
|   |   |   |-- rain.mp3
|   |   |	 ...
|   |   |-- kaboom.wav
|   |	 ...
|   |-- about.txt
|   |-- copyright
|	 ...
|-- other-plugin/
	  ...

No other form of installation is needed. At this point, simply run Endless Sky and play, and the changes that the mod brings will be applied to your game automatically.

Note that in the plugin settings in-game, you can enable or disable installed plugins so you don't have to delete the folders if you don't want to play with a plugin.

Android Download

If you are playing Endless Sky on the mobile version for Android, you can follow one of two steps to download the plugin. You can either use git clone in Termux (or another terminal emulator for Android) or download the plugin from the releases page.

Using a terminal emulator such as Termux:

  • git clone https://github.com/OcelotWalrus/Cromha-Expansion-plugin.git in the terminal emulator.
  • Open Endless Sky.
  • Navigate to Preferences > Plugins.
  • Press "Import."
  • Navigate to the compressed file (usually located in your downloads folder).
  • Open the file.
  • Follow the prompts.
  • Enjoy the plugin! (Or any other plugins!)

Using the releases page:

  • Navigate to the releases page.
  • Choose a continuous version (may be unstable) or a stable version (which has a version number and is marked with "Stable").
  • Download either of the .zip or .tar.gz files (You will get the same result.).
  • Open Endless Sky.
  • Navigate to Preferences > Plugins.
  • Press "Import."
  • Navigate to the compressed file (usually located in your downloads folder).
  • Open the file.
  • Follow the prompts.
  • Enjoy the plugin! (Or any other plugins!)

Updating the plugin is as simple as navigating to the cloned directory in your terminal emulator and using git pull or downloading a newer release on the releases page, and then you should follow the above steps.

Note: If the game crashes on startup, this could indicate your device is not powerful enough to run with the plugin installed. If you have any other plugins enabled, you could try disabling or removing (preferably disabling) them (This can break your saves!).