Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cat-Lady authored Oct 22, 2019
1 parent b6297b0 commit e6f87af
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ This plugin integrates boarding enhancements (doh!) into FOSS game "Endless Sky"
Check:
https://github.com/Cat-Lady/Boarding-Enhancements/releases


...for latest, pre-packaged version.


**1.** Unpack ``boarding-enhancements`` to your ES plugins folder. Be sure that you have single ``boarding-enhancements`` directory inside your plugin folder, containing ``data`` and ``images`` directories. Directory structure should look like:

```(...)/plugins/boarding-enhancements/(.../data/, /images/ and other stuff)```
Expand All @@ -35,12 +35,14 @@ It **won't** work if the directory structure will be anything like:

```(...)/plugins/Boarding-Enhancements/boarding-enhancements/(...)```


**2.** Use files from ``vanilla-files-replace`` directory to replace files in your ES installation's ``/data/`` directory. Overwrite files when prompted.

Do **not** put ``vanilla-files-replace`` inside your ``/data/`` directory - it won't work like that. You need to directly replace approriate files with plugin's ones.

You can skip step **2.**, but some variants of Marauder ships (that should be one of toughtest nuts to crack while boarding) won't have new outfits. This step of replacing vanilla files is (hopefully) temporary workaround around limitation in ES plugin's framework - I'm already actively working with upstream to fix it, so there is a chance it won't be necessary in future (instructions and "Release" notes will higlight when that will become reality).


## Author

* **Cat Lady**
Expand Down

0 comments on commit e6f87af

Please sign in to comment.