Bringing mod into Avorion

Go to the 'My mods' page and in the list click the download icon. Your browser will download a .zip file containing just one folder. This folder is your mod.

Copy the folder into the mod folder of your Avorion user directory. On Windows:

C:\Users\USERNAME\AppData\Roaming\Avorion\mods

When you did this correctly there should exist the file 'modinfo.lua' in this path:

C:\Users\USERNAME\AppData\Roaming\Avorion\mods\YOURMODSNAME\modinfo.lua

Start Avorion, in the main menu go to Settings -> Mods. In the list of mods you will find your own mod: activate it. Now you are theoreticly ready to go. But I highly recommand testing your mod. See below.

Note: Your mod works in singleplayer, but it is not ready to be uploaded to the steam workshop yet. See upload to Steam workshop wiki page for more details.

Test your mod

For these tests I recommand using the EntityDBG mod. It adds the script 'entitydbg.lua' to all ships and stations (don't get confused if you do not know what this is, just subscribe the mod and activate it). Alernatively you may add entitydbg.lua by your own.

Create a new galaxy in gamemode creative and launch it. Having the entitydbg.lua enabled adds a new icon to the top right of your screen, that looks like a piece of a puzzle and is called '~dev'. Click it.

Test your factory

Click this and in the menu navigate to 'Spawn' -> 'Spawn Factory'. The factory you want to test will appear in the list of factories, clicking it will make the factory spawn in your current sector. It will craft the good you selected in 'Production' and therefor consume the goods you selected in 'Consumption'. You may interact with the factory, there is a new option called '~dev', when clicking it, the dev menu opens. But in this case the dev menu is not related to your drone/ship, it is related to the station you interacted with. Clicking 'Ship Commands' -> 'Diplomacy' -> 'Own' will make you own the factory for further testing.

You may also want to test if your station spawns naturally as expected, I do not have a good workflow for that yet. You may temporarily increase the property 'importance' of the good it produces, to see if the factory appears at all (see goods editor for more information).

Test your good

Open the dev menu of your ship by clicking the puzzle icon '~dev' at the top right corner of your screen. Navigat to 'Ship Commands' -> 'Cargo Commands', and in the list click on the good you want to test. The good will appear in your cargo (cargo space required). This view also contains all icons of the goods, you will see how your custom icons will actually look in the game.