Version 0.5.6a

- added persistent chests / stashes
- refactoring of entities
- updated docs

Author: benjaminfoo

Data/Scripts/Util/arc_constants.lua

@@ -4,5 +4,5 @@
 --- This file contains constants related to the modification.
 ---
 
-architect_version = '0.5.5a_test'
+architect_version = '0.5.6a_test'
 

docs/guide.md

@@ -337,10 +337,19 @@ The built-in functions like System.LogAlways, Script.ReloadScript(...), Script.U
 There is a documentation for all of them in <editor>/tools/luadoc.
 
 ## Entities
+An entity is an object within the scene (the player, a single plant, the horse - everything is an entity).
+
+The built-in entities are stored at:
+- KingdomComeDeliverance\Data\Scripts.pak\Entities\
+- KingdomComeDeliverance\Data\Scripts.pak\Scripts\Entities\
 
 ### Create a new entity
+Two define an entity two things are needed:
+- a *.ent file, which maps the entity name with a lua script
+- a *.lua file, which contains the executing logic of that entity
+ 
 
-Create *.ent file in Entities/TestEntity.lua
+Create *.ent file in KingdomComeDeliverance\Mods\<yourModFolder>\Entities\
 ```
 <Entity
     Name="TestEntity"
@@ -561,60 +570,55 @@ server_onInit -> onReset -> onInit -> onLoaded
 
 ## Misc.
 
--- Use inbuilt methods
-
--- Convert vector with n components to human readable string / pretty print
+-- Convert vector with 3 components to human readable string / pretty print \
 System.LogAlways("Located at: " .. Vec2Str(player:GetPos()}))
 
--- Make the player fall
+-- Make the player fall \
 player.actor:Fall({1,1,1})
 
--- Makes the actor grab on a ladder
+-- Makes the actor grab on a ladder \
 Human.GrabOnLadder(ScriptHandle ladderId);
 
--- Get current amount of money by player
+-- Get current amount of money by player \
 player.inventory:GetMoney()
 
--- Add or remove money to the players inventory, works with negative value and includes and ui
+-- Add or remove money to the players inventory, works with negative value and includes and ui \
 AddMoneyToInventory(player,amount)
 
--- Save the game
+-- Save the game \
 Game.SaveGameViaResting() 
 
--- Activate frost overlay
+-- Activate frost overlay \
 System.SetScreenFx("ScreenFrost_Amount", 1);
 
--- Show information about the player
-#dump(player)
-#dump(player.actor)
-#dump(player.soul)
-#dump(player == System.GetEntityByName("dude") => entity?)
-
-look into this for player manipulation:
-file:///C:/dev/Steam/steamapps/common/KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindSoul.html
+-- Show information about the player \
+dump(player) \
+dump(player.actor) \
+dump(player.soul) \
+dump(player == System.GetEntityByName("dude") => entity?) \
 
+Take a look into the following files for player manipulation:
+- KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindSoul.html
+- KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindGameRules__AddMinimapEntity@IFunctionHandler__@ScriptHandle@int@float.html
+- KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindGameRules__AddObjective@IFunctionHandler__@int@char__@int@ScriptHandle.html
 
-file:///C:/dev/Steam/steamapps/common/KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindGameRules__AddMinimapEntity@IFunctionHandler__@ScriptHandle@int@float.html
-file:///C:/dev/Steam/steamapps/common/KingdomComeDeliverance/Tools/luadoc/luadoc/C_ScriptBindGameRules__AddObjective@IFunctionHandler__@int@char__@int@ScriptHandle.html
-
-
--- Enables the black bars used for movie sequences
+Enables the black bars used for movie sequences  \
 wh_ui_ShowRatioStrips = 0 / 1
 
+Enables / disables the hud \
 wh_ui_ShowHud = 0 / 1
 
+Toggles fullscreen-mode \
 r_Fullscreen = 0 / 1
 
 ### Key-Handling
 See the crytek documentation for [Setting up controls and action maps](https://docs.cryengine.com/display/CEPROG/Setting+Up+Controls+and+Action+Maps)
 
-1.) Create a function
-function testEcho()
-    System.LogAlways("Hello World!") 
-end
+1.) Create a function  \
+function testEcho() System.LogAlways("Hello World!") end
 
-2.) Add a command to the console 
+2.) Add a command to the console  \
 System.AddCCommand('testEcho', 'testEcho()', "testEcho!")
 
-3.) Bind the key (page down) to method testEcho
+3.) Bind the key (page down) to method testEcho  \
 System.ExecuteCommand("bind 'pgdn' testEcho")

docs/index.md

@@ -27,22 +27,19 @@ iframe{
 
 
 # Welcome!
-This project introduces new features and mechanics to [kingdom come deliverance](https://www.kingdomcomerpg.com/) like a construction-system,
-a resource-system, a basic crafting-system, town management, etc. 
+This project introduces new features and mechanics to [kingdom come deliverance](https://www.kingdomcomerpg.com/) \
+If you enjoy this mod send me your [screenshots / videos](https://www.nexusmods.com/kingdomcomedeliverance/mods/958?tab=images) or maybe [buy me a cup of coffee](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PMULUFGTQFAJA&source=url) - thanks to all of you! \
+If you are interested in modding KC:D checkout the [guide](https://benjaminfoo.github.io/Architect/guide). 
 
-This means that the player can create and spawn constructions - this ranges from simple props to flora & fauna, 
-vegetation, houses, walls, towers, tents, chairs, benches, beds, etc. almost anywhere in the world. Its also possible to build 
-custom constructions like wood-, stone-, coal-, ... -generators which produce resources or items over time.
-
-##### If you enjoy this mod send me your [screenshots / videos](https://www.nexusmods.com/kingdomcomedeliverance/mods/958?tab=images) or maybe [buy me a cup of coffee](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PMULUFGTQFAJA&source=url) - thanks to all of you! 
-
-<br>
+## Features
 
-**Note**  
-Make a backup of your saved games - there is no new save required.  
-There are no DLCs required to use this mod.
+- construction-system - spawn constructions anywhere in the scene - this includes vegetation, structures, furniture, etc.
+- resource-system - some constructions generate resources (generators), some constructions require resources to be build
+- crafting-system - craft arrows, cook all the things
+- base management - manage your base like a boss
+- chests - manage your items
+- ...
 
-##### Thanks to [Warhorse Studios](https://warhorsestudios.cz) for developing and realizing this beautiful game and the modding sdk!
 
 <br>
 
@@ -609,7 +606,7 @@ Get the modification at the [nexus](https://www.nexusmods.com/kingdomcomedeliver
 <br>
 
 ## Credits & Thanks
-Thanks to [Warhorse Studios](https://warhorsestudios.cz) for developing and realizing this beautiful game and the modding sdk!  
-Also thanks to [sexybiscuit](https://www.youtube.com/channel/UCvpxkCUky0wN5e0DNf_YZCQ) for creating the great videos on how to use and install the modification!  
-  
+Thanks to [Warhorse Studios](https://warhorsestudios.cz) for developing KC:D \
+Thanks to [sexybiscuit](https://www.youtube.com/channel/UCvpxkCUky0wN5e0DNf_YZCQ) for creating the great videos on how to use and install the modification!  
+Thanks to the [Cheat Mod](https://www.nexusmods.com/kingdomcomedeliverance/mods/106) and [Sim's Camping Mod](https://www.nexusmods.com/kingdomcomedeliverance/mods/881) for being a great modders resources.
 This page uses [bootstrap 4](https://getbootstrap.com/) and was generated with [jekyll](https://jekyllrb.com/docs/plugins/generators/).  

mod.manifest

@@ -2,9 +2,9 @@
 <kcd_mod>
   <info>
     <name>architect</name>
-    <description>Adds base-building elements to the game.</description>
+    <description>A modification which introduces base-building features and other mechanics to Kingdom Come Deliverance.</description>
     <author>Benjamin Foo</author>
-    <version>0.5.5a</version>
+    <version>0.5.6a</version>
     <created_on></created_on>
     <dependencies>
     </dependencies>