mirror/Aquaria
1
0
Fork 0
mirror of https://github.com/AquariaOSE/Aquaria.git synced 2024-11-25 09:44:02 +00:00
Code Issues Releases Wiki Activity

Created mod installation (markdown)

False.Genesis 2018-12-24 21:52:00 +01:00
parent 5c36d0abc3
commit cba7bbd3df
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
mod-installation.md Normal file

@ -0,0 +1,19 @@
# Instructions for OSE
Use the in-game mod downloader. This will download an [[`.aqmod` file|aqmod-file]] to the correct place on your disk and you will be able to use the mod right away.
Alternatively, download the mod as [[`.aqmod` file|aqmod-file]] and drop it into the [[_mods|directories#_mods]] directory. The mod should appear in the mod list the next time the mod list is opened.
Note that a mod that comes as [[`.aqmod` file|aqmod-file]] is not editable. You need to extract the file if you plan to make edits.
Alternatively, follow the instructions below.
# Instructions for older versions
The mod should come as a **zip**, **rar**, **7z** or similar kind of archive. Assuming the mod is called _whatever_, simply extract the archive to [[_mods|directories#_mods]] so that
* `_mods/<whatever>.xml` ([[Mod main XML|mod-xml]] file)
* `_mods/<whatever>/mod-init.lua`
* `_mods/<whatever>/<all other mod files and folders>`
are present. This directory structure is mandatory, else the game won't recognize the mod.
Check the included example mods if in doubt.