Introduction

Description

The weight system allows you to add meaningful weight to the items and equipment the player in your game holds.

You can specify how much weight each item in your database uses. This is done using tags (more on this later). Also, you can also use tags to specify how much additional weight capacity the player can carry (e.g. bags)!

If the player's current weight becomes too heavy, they'll be over-encumbered! When this happens, you can specify which effects this causes such as:

• Changing the player's movement speed
• Disabling dash
• Enabling a switch
• Setting a variable value

Note: The last 2 are intended for use if you have other effects you'd like to implement yourself based on a given switch/variable value (e.g. disabling fast-travel)

As soon as the player is no longer encumbered, the effects that were previously triggered will be reversed.

Installation

1. Extract the .7z file you downloaded using either WinRAR or 7zip and open it.
2. Copy "WeightSystemPlugin.dll" and paste it in the "plugins" folder in your Bakin install directory (usually "SteamLibrary\steamapps\common\BAKIN\plugins")
3. Copy the "Weight System" folder and paste it in your project's "script" folder (if you don't see this folder, create it).
4. Open the "Weight System" folder and copy "ThatDaleDudesLibrary.NET.dll".
5. Paste the file (or replace if it already exists) in the "lib" folder in your Bakin install directory
6. Open Bakin and go to the Layout Tool on the left
7. Click the import button in the top bar on the right (it looks like a little folder with a down arrow)
8. Go to the folder you extracted and select "Layouts.lyrbr". This will import the default layout used by this plugin

Setup

1. In Bakin, open the common events panel and create a new "Custom Event".
2. In the lower-left corner of the common event, click the C# Program Assignment box and select the weight system (it will likely show up as "script/Weight System/WeightSystem.cs")
3. Press OK and then feel free to rename the common event
4. Open your database and go to the Items tab
5. For items that should weigh something, add the following to the "Management Tags + Notes" box on the item: "$weight(x)"
   
   Note: You don't need the quotation marks. Also, replace "x" with how much the item should weigh.
6. For items that should increase your weight capacity, add the following to the "Management Tags + Notes" box on the item: "$increaseWeight(x)"
   
   Note: You don't need the quotation marks. Also, replace "x" with how much the item should increase your weight capacity by.

The setup is now complete. Feel free to open the Weight System's user-interface from Functions > Expanded Features > Weight System and configure how you want to use the plugin