Stalburg Wiki

Obenseuer/Modding:Making Lavender Mods: Difference between revisions

VisualWikitext
Nextej (talk | contribs)
csseditors, moderator
3,027 edits
WIP
 
Added my ID ranges
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{breadcrumb|Obenseuer|Modding}}
==Making simple data-driven mods with Lavender for new items and recipes==
==Making simple data-driven mods with Lavender for new items and recipes==
Lavender library allows you to make simple mods without needing any programming knowledge or requiring you to compile the code, that can be easily used with BepInEx launcher. You should start by making a new folder for your mod, where you will place its all contents.
Lavender library allows you to make simple mods without needing any programming knowledge or requiring you to compile the code, that can be easily used with BepInEx launcher. You should start by making a new folder for your mod, where you will place its all contents. To run your mod in game, your custom folder will need to be located in <code>..\Obenseuer\BepInEx\plugins</code>, you can place this folder and work on it there now, or keep it separate and duplicate it to the plugins location whenever you want to test it.


===Mod config===
===Mod config===
Line 19: Line 21:
</pre>
</pre>


* <code>"ModName"</code> - Specifies the internal name of the mod, it should be the same as the parent folder of your mod.
* <code>"ModName"</code> - Specifies the internal name of the mod, this name will be referenced throughout the mod to address various aspects.
* <code>"Name"</code> - Specifies the external name of the mod for the user.
* <code>"Name"</code> - Specifies the external name of the mod for the user.
* <code>"Description"</code> - Specifies the description of what your mod does for the user.
* <code>"Description"</code> - Specifies the description of what your mod does for the user.
* <code>"Author"</code> - Specifies your signature of who made the mod for the user.
* <code>"Author"</code> - Specifies your signature of who made the mod for the user.
* <code>"URL"</code> - Specifies a website URL address for your authorship, can be omitted.
* <code>"URL"</code> - Specifies a website URL address for your authorship and where to look for help with issues, can be omitted.
* <code>"Version"</code> - Specifies the version of the mod for the user. Common formats are Major.Minor.Bugfix order of numbers or Incompatible.Compatible.Bugfix order, however you are not bound to any system and can specify anything of your choosing.
* <code>"Version"</code> - Specifies the version of the mod for the user. Common formats are Major.Minor.Bugfix order of numbers or Incompatible.Compatible.Bugfix order, however you are not bound to any system and can specify anything of your choosing.


Line 40: Line 42:
"ItemFiles": [
"ItemFiles": [
"ExampleItems1.json",
"ExampleItems1.json",
"ExampleItems2.json",
"ExampleItems2.json"
],
],
"RecipeFiles": [
"RecipeFiles": [
"Recipes.json",
"Recipes.json"
],
],
"LavenderAssetFiles": []
"LavenderAssetFiles": []
Line 97: Line 99:
** <code>"name"</code> - Specifies the name of your asset.
** <code>"name"</code> - Specifies the name of your asset.
** <code>"objTexturePaths"</code> - If your asset is a model, specifies the location of textures the model is using.
** <code>"objTexturePaths"</code> - If your asset is a model, specifies the location of textures the model is using.
To use the defined asset for your items or recipes, the address path will follow this formula <code>#lv-''ModName''-''ID''</code>, the ModName is what you defined in datamod.json.
== ID Allocations ==
Item and Recipes are identified via integer values.  This, unfortunately, means that conflicts between mods are possible if we (as a community) do not communicate and document which mod(ders) use which ID regions.
When a modder starts creating items or recipes for a published mod, please update this table and reserve yourself a free ID range:
{| class="wikitable"
|+
!Modder
!Item ID Range
!Recipe ID Range
!Active
!Notes
|-
|hiemas-lerastad
|30000-39999
|30000-39999
|Yes
|
|-
|hiemas-lerastad
| -
|100001-100003
|??
|Mass Yeast Extraction
|-
|norbby42 (Quackers)
|400000-409999
|400000-409999
|Yes
|
|-
|cellizel (Chicken Deli Man)
|122000-126000
|122000-126000
|Yes
|C-Coffee Mod
|-
|HighHybrid
|420000-429999
|420000-429999
|Yes
|Range for mods by HH
|}
[[Category:Obenseuer Modding]]
Retrieved from "https://stalburg.net/Obenseuer/Modding:Making_Lavender_Mods"