Modding:Setting up your Development Environment: Difference between revisions

From Vintage Story Wiki
Line 90: Line 90:
Packs all mods in your workspace at once.
Packs all mods in your workspace at once.


= Project Setup (ZIP - DLL) =
= Project Setup (Compiled Zip) =


Both dll and zip mods have their advantages and disadvantages, so why not combine them together? This project setup is equal to zip, but you can pack your zip in a different way. Instead of adding the source code to the zip file, it uses the compiled dll. This allows you to have all the dll benefits while still having the zip mod asset structure.
Both dll and zip mods have their advantages and disadvantages, so why not combine them together? This project setup is very similar to zip. Instead of adding the source code to the zip file, it uses the compiled dll. This allows you to have all the dll benefits while still having the zip mod asset structure.


== Pack Mod ==
== Add Mod ==
''Syntax: <code>pack-dll <modid></code>''


Creates a mod zip file and places it in <code>/releases/<modid>/<modid>_v<modversion>_dll.zip</code>. This file is ready for use and can be shared with other people.
''Syntax: <code>add <modid> compiled</code>''
 
Adds a compiled zip mod template to your workspace. The difference is that it uses a compiled dll instead of the actual source code. All other commands are equal to the zip ones.
 
== Set Mod ==
 
''Syntax: <code>set <modid> <source|compiled></code>''
 
Sets the given zip mod either to source or compiled. This can be useful if you want to change the type of your mod later on.


= Project Setup (DLL) =
= Project Setup (DLL) =