Before you create a new scene or import the asset's functionality into your existing one, I recommend taking a look at the demo maps that come with the asset.

Overview

Welcome to the official STP Documentation/Wiki!

Survival Template Pro is a powerful toolkit designed to be as modular and scalable as possible, while also offering a lot of features found in modern survival games. It can be used as a starting place for your survival game or simply as a learning experience.

This documentation is OUTDATED, a new one is in the works

Links

Universal AI 2.0

Inventory (Module)

Initial Containers: The initial item containers. You can also add more containers at runtime using the AddContainer() method.

For more information on item containers see:

Item Drop Handler (Module)

Drop Obstacle Mask: The layer mask that will be used in checking for obstacles when items are dropped.

Drop Transform: Dropped items are spawned relative to this transform.

Drop Force Mode: The force mode that will be added to the rigidbody of the dropped item.

Item Drop Settings: Position, rotation offsets etc.

Sack Prefab: The prefab used when an item that's dropped doesn't have a pickup (e.g. clothes) or when dropping multiple items at once.

Inventory Startup Items (Behaviour)

Inventory Startup Info: A predefined list of items that will be added to the inventory. To create one, right click in the project view and select:

"Create / Survival Template Pro / Inventory / Startup Items"

Inventory Inspect Manager (Module)

Toggle Threshold: How often can the inventory inspection be toggled (e.g. open/close backpack).

Inventory Materials Handler (Module)

For information about items look into:

Player Movement Input (Behaviour)

Character Mover (Module)

Acceleration: How fast can this character achieve max state velocity.

Damping: How fast will the character stop when there's no input (a high value will make the movement more snappy).

Airborne Control: How well can this character move while airborne.

Step Length: How much distance does this character need to cover to be considered a step.

Forward Speed: The forward speed of this character.

Back Speed: The backward speed of this character.

Side Speed: The sideway speed of this character.

Slope Speed Mod: Lowers/Increases the moving speed of the character when moving on sloped surfaces (e.g. lower speed when walking up a hill).

Anti Bump Factor: A small force applied to the character to make it stick to the ground when moving on a descending terrain/collider.

Enable Running: Is this character allowed to run?

Run Speed: The max running speed.

Run Step Length: Step length specific to running.

Enable Jumping: Is this character allowed to jump?

Jump Height: The max height of a jump.

Jump Timer: How often can this character jump (in seconds).

Enable Crouching: Is this character allowed to crouch?

Crouch Speed Mod: The velocity mod for crouching (multiplied with the base speed: forward, back speed etc.)

Crouch Step Length: Step length specific to crouch walking.

Crouch Height: The controllers height when crouching.

Crouch Duration: How long does it take to crouch.

Enable Sliding: Should this character slide when standing on slopes?

Slide Threshold: The angle at which the character will start to slide.

Slide Speed: The max sliding speed.

Gravity: The strength of the gravity.

Obstacle Check Mask: Layers that are considered obstacles.

Character Velocity Handler (Behaviour)

Low Vitals Velocity Mod: How much will the max velocity be affected by low vitals (e.g. hunger, thirst etc.)

Wieldable Weight Velocity Mod: How much will the max velocity be affected by the equipped wieldable weight.

Carriables Count Velocity Mod: How much will the max velocity be affected by the amount of carried "carriables".

Character Run Blocker (Behaviour)

Disable Run On Stamina Value: At which stamina value (0-1) will the ability to run be disabled.

Enable Run On Stamina Value: At which stamina value (0-1) will the ability to run be re-enabled (if disabled)

Character Jump Blocker (Behaviour)

Disable Jump On Stamina Value: At which stamina value (0-1) will the ability to jump be disabled.

Enable Jump On Stamina Value: At which stamina value (0-1) will the ability to jump be re-enabled (if disabled)

Player Look Input (Behaviour)

Player Look Handler (Module)

X Transform: Transform to rotate Up & Down.

Y Transform: Transform to rotate Left & Right.

Invert: If enabled, the up-down direction will be inverted.

Look Limits: Vertical look limits (in angles).

Sensitivity: Rotation Speed.

Raw: If enabled, the rotation will not be smoothed.

Smooth Steps: Smooth steps amount (a bigger sample will make means the rotations will be more smoothed).

Smooth Weight: Smoothness affect modifier, a value of 0 means that the rotation will be raw while 1 as smooth as possible.

FOV Camera: Used in lowering/increasing the current sensitivity based on the FOV.

Camera Motion Handler (Module)

Camera: The camera that will be rotated using a spring.

Camera Root: The camera root that will be rotated through bobbing.

Motion Lerp Speed: How smooth should the motion spring movement be.

Bob Transition Speed: How fast should the camera bob be.

Input: Input settings.

Sway: Sway forces (applied when moving the camera).

Fall Impact: Fall impact forces.

Idle State: Idle camera motion state.

Walk State: Walk camera motion state.

Run State: Run camera motion state.

Crouch State: Crouch camera motion state.

Shake Lerp Speed: How smooth should the shake spring movement be.

Explosion Shake: The explosion shake settings.

Shake Spring Settings: The default shake spring force settings (Stiffness and Damping).

Force Lerp Speed: How smooth should the force spring movement be.

Default Force Spring Settings: The default spring force settings (Stiffness and Damping), when external forces are being applied.

Camera Effects Handler (Module)

Background Blur: Background blur component.

Foreground Blur: Foreground blur component.

Background Color Tweaks: Background color tweaks component.

Foreground Color Tweaks: Foreground color tweaks component.

Camera Height Controller (Behaviour)

Y Lerp Speed: How fast should the camera adjust to the current Y position (up - down).

Crouch Offset: An offset that will be applied to the camera position after crouching.

Crouch Easing: Crouch movement easing type.

Main character component used by every entity in the game. It acts as a hub for accessing modules.

Preparation

1. Make sure you're using Unity 2020.3 or newer.

2. Currently the only supported Rendering Pipeline is Built-In.

3. Make sure your storage at least 10gb left.

Installation

Recommended Steps:

1. Navigate to: "Edit / Project Settings / Player / Configuration" and set the Input Handling to New or Both.

2. Navigate to: "Window / Package Manager / My Assets" and find STP: Survival Template PRO.

3. After downloading the asset make sure to import the necessary project settings.

That is all, STP should function perfectly fine now. In case you encountered any problems with the installation feel free to ask for support.

Frequently Asked Questions

"How can I create my own Custom Items?"

"How can I create and configure a new Wieldable?

"How can I add Custom Impact Effects to STP?"

"Where can I change my Player's max health, stamina etc."

1. After you're in your scene that you want to setup. Navigate to: "Tools / STP / Scene Setup"

2. After pressing on "Setup Scene" your scene will become fully usable.

3. Don't forget to place some spawn points otherwise the Player will be spawned where the PlayerSetup object is placed.

Path: "PolymindGames / Survival Template Pro / Samples / Player / Player_SpawnPoint".

At their core item containers are just a list of items.

Name: The name of the item container. If you need to get access to this container you can use the Inventory.GetContainerWithName() method and pass in the name of this container.

Max Weight: The max weight that this container can hold, no item can be added if it exceeds the limit.

Flag: Acts as a container type.

Size: Number of item slots that this container has (e.g. Holster 8, Backpack 25 etc.).

Valid Categories: Only items from the specified categories can be added.

Required Properties: Only items with the specified properties can be added.

Required Tag: Only items that are tagged with the specified tag can be added.

Crafting Manager (Module)

Craft Sound: Sound that will be played after crafting an item.

Player Interaction Input (Behaviour)

Interaction Handler (Module)

View: The transform used in raycasting.

Raycast Distance: The raycast max distance, anything further away will be ignored.

Raycast Radius: The raycast radius, if you're not looking directly at an object you can still interact with that said object if it's in the given radius.

Layer Mask: Interaction layer mask, everything this handler can "see".

Player Wieldables Input (Behaviour)

Wieldables Controller (Module)

Audio Player: The audio player that every wieldable will use.

Wieldable Inventory Select Handler (Module)

Holster Container: The corresponding inventory container (e.g. holster, backpack etc.) that this behaviour will use for selecting items.

Select On Start: Should this behaviour select the "starting slot item" on start.

Starting Slot: The fist slot that will be selected.

Inventory Based Wieldables: All of the Item Id - Wieldable pairs.

Wieldable Survival Book Handler (Module)

Survival Book Prefab: Corresponding survival book wieldable prefab.

Left Pages Object Name: The left pages object name of the book (used to parent the UI).

Right Pages Object Name: The right pages object name of the book (used to parent the UI).

Toggle Cooldown: How often can the survival book be enabled/disabled (in seconds).

Wieldable Object Carry Handler (Behaviour)

Character Ray Generator (Module)

Anchor: Transform used in determining the base ray position and orientation.

Walk Spread Mod: How much will walking affect (randomly spread) the final ray.

Run Spread Mod: How much will running affect (randomly spread) the final ray.

Crouch Spread Mod: How much will crouching affect (randomly spread) the final ray.

Airborne Spread Mod: How much will being airborne affect (randomly spread) the final ray.

Player Look Follow (Behaviour)

Player Building Input (Behaviour)

Character Build Controller (Module)

Follow Character Rotation: Should the "placeables" follow the rotation of the character?

View Angle Threshold: Max angle for detecting nearby sockets.

Rotation Speed: How fast can the "placeables" be rotated.

Build Range: "Max building range.

Buildable Mask: Tells the controller on what layers the "buildables" are.

Free Placement Mask: Tells the controller on what layers can "placeables" be placed.

Overlap Check Mask: Tells the controller what layers to to check when checking for collisions.

Place Sound: Sound to play when placing an object.

Invalid Place Sound: Sound to play when the controller tries to place an object but detects a collision.

Character Build Effects (Behaviour)

Character Structure Detector (Module)

Max Detection Distance: The max detection building preview distance.

Max Detection Angle: The max angle detection building preview.

Player Object Carry Input (Behaviour)

Object Carry Controller (Module)

Drop Obstacle Mask: The layer mask that will be used in checking for obstacles when carriables are dropped.

Drop Transform: Dropped carriables are spawned relative to this transform.

Drop Force Mode: The force mode that will be added to the rigidbody of the dropped carriable.

Health Manager (Module)

Starting Health: The starting health of this character (can't be higher than the max).

Starting Max Health: The starting highest health of this character (can be modified at runtime).

Stamina Controller (Module)

Regeneration Rate: How fast will the stamina regenerate.

Regeneration Pause: How much time the stamina regeneration will be paused after it gets lowered.

Run Decrease Rate: By how much will the stamina decrease per second when running.

Jump Take: By how much will the stamina decrease after jumping.

Hunger Manager (Module)

Thirst Manager (Module)

Energy Manager (Module)

Temperature Manager (Module)

Player Death Handler (Behaviour)

Item Drop Type:

All: Drop all items upon death.

Equipped: Drop only the equipped wieldable item.

None: Don't drop any items.

Rigidbody Death Module (Behaviour)

Fall Damage Handler (Behaviour)

Enable Damage: Is this behaviour enabled?

Min Fall Speed: At which landing speed, the character will start taking damage.

Fatal Fall Speed: At which landing speed, the character will die, if it has no defense.

Character Sleep Handler (Module)

Go To Sleep Duration: How much time it takes to transition to sleeping (e.g. moving to bed).

Sleep Delay: How much time it takes to fall asleep.

Sleep Duration: Sleep duration in seconds.

Wake Up Delay: How much time to wait after the sleep is done, before getting up.

Wake Up Duration: How much time it takes to transition from sleeping to standing up.

Hours To Sleep: Max hours that can pass while sleeping.

Max Get Up Hour: Max hour this character can wake up at, we don't want to be lazy :)

Only Sleep At Night: If enabled, this character will not be allowed to sleep during the day.

Check For Enemies: Check for enemies before sleeping, if any of the are found, this character will be unable to sleep.

Check For Enemies Radius: The enemy check radius.

Enemies Layer Mask: The enemy layer, any object with this layer will be considered an enemy.

Cant Sleep Sound: Sound that will be played when attempting to sleep unsuccessfully.

Character Sleep Effects (Behaviour)

Lerp Sleep Module (Module)

Audio Player (Module)

Human Sounds Manager (Behaviour)

Footsteps Manager (Behaviour)

Player UI Inventory Input

Inventory Panels Manager

Item Auto Mover

Wieldable Tags: All of the item tag(s) that correspond to the wieldables.

Clothing Tags: All of the clothing tag(s) that correspond to clothing items.

Item Drag Handler

Dragged Item Scale: The visual scale of the dragged item.

Dragged Item Alpha: The transparency of the dragged item.

Slot Template: Slot template prefab that will be instantiate when an item gets dragged.

Damage UI

Alpha Damage Weight: How much will the alpha of the effects be affected by the amount of damage received.

Blood Screen Fader: Image fading settings for the blood screen.

Blood Screen Fader Damage Threshold: How much damage does the player have to take for the blood screen effect to show.

Directional Damage Indicator Fader: Image fading settings for the directional damage indicator.

Directional Indicator Distance: The damage indicator distance (in pixels) from the screen center.

Scope

Canvas Group: The canvas group used to fade the scopes in & out.

Scopes: All of the existing UI scopes.

Crosshairs

Default Crosshair: The default (starting) crosshair.

Canvas Group: The canvas group used to fade a crosshair in & out.

Crosshair Alpha: The max crosshairs alpha.

Alpha Lerp Speed: The speed at which the crosshairs will change their alpha.

Ammo

Animator: Reference to the animator used for the Ammo UI.

Magazine Text: A UI text component that's used for displaying the current ammo in the magazine.

Inventory Text: A UI text component that's used for displaying the current ammo in the storage.

Charge

Canvas Group: The canvas group used to fade the stamina bar in & out.

Charge Fill Images: UI images that will have their fill amount value set to the current charge value.

Fill Gradient: A gradient used in determining the color of the charge image relative to the current charge value.

Responsible for attaching and detaching UI behaviours to a player.

Sleep UI

Canvas Group: The canvas group used to fade the sleep UI in & out.

Max Canvas Alpha: The max alpha that will be reached when fading in.

Canvas Lerp Speed: The speed at which the sleep UI will be faded in & out.

Current Time Text: A UI text component that's used for displaying the current time while sleeping.

Background Rect: The background rect of this UI piece.

Animator: Reference to the animator used for the sleeping UI.

Show Trigger: The "show" animator trigger.

Hide Trigger: The "hide" animator trigger.

Number of Templates: How many time templates should be spawned each side.

Time Text Template: A prefab with a text component on it that will be instantiated.

Text Size Over Distance: How will the text scale over the duration of its lifetime.

Text Y Position Over Distance: How will the text y position change over the duration of its lifetime.

Text Color Over Distance: How will the color of the text change over the duration of its lifetime.

Interactable Info Display UI

Displayers

Player Vitals UI

Health Bar: The health bar image, the fill amount will be modified based on the current health value.

Energy Bar: The energy bar image, the fill amount will be modified based on the current energy value.

Thirst Bar: The thirst bar image, the fill amount will be modified based on the current thirst value.

Hunger Bar: The hunger bar image, the fill amount will be modified based on the current hunger value.

Player Stamina UI

Canvas Group: The canvas group used to fade the stamina bar in & out.

Fill Bar: The stamina bar image, the fill amount will be modified based on the current stamina value.

Hide Duration: Represents how much time it takes for the stamina bar to start fading after not decreasing.

Alpha Lerp Speed: How fast will the stamina bar alpha fade in & out.

Example (inherit from Interactable)

namespace SurvivalTemplatePro
{
    public class InteractableTest : Interactable
    {
        public override void OnInteract(ICharacter character)
        {
            base.OnInteract(character);

            // Do something when a character interacts with this.
            // e.g. press a button
        }

        public override void OnHoverStart(ICharacter character)
        {
            base.OnHoverStart(character);

            // Do something when a character starts looking at this object.
            // e.g. Enable outline effect
        }

        public override void OnHoverEnd(ICharacter character)
        {
            base.OnHoverEnd(character);

            // Do something when a character stops looking at this object.
            // e.g. Disable outline effect
        }
    }
}

Example (Implement the IInteractable interface)

namespace SurvivalTemplatePro
{
    public class InteractableTest : MonoBehaviour, IInteractable
    {
        public bool InteractionEnabled { get; set; }
        public string InteractionText => "Interaction Text";
        public string DescriptionText => "Description Text";

        public float HoldDuration => 0f;

        public event UnityAction onInteracted;
        public event UnityAction onDescriptionTextChanged;
        public event UnityAction<bool> onInteractionEnabledChanged;


        public void OnInteract(ICharacter character)
        {
            // Do something when a character interacts with this.
            // e.g. press a button
        }

        public void OnHoverStart(ICharacter character)
        {
            // Do something when a character starts looking at this object.
            // e.g. Enable outline effect
        }

        public void OnHoverEnd(ICharacter character)
        {
            // Do something when a character stops looking at this object.
            // e.g. Disable outline effect
        }
    }
}

Name: Item name.

Id: Unique id (auto generated).

Category: Category of this item.

Icon: Item Icon.

Description: Item description to display in the UI.

Pickup: Corresponding pickup for this item, so you can actually drop it, or pick it up from the ground.

Stack Size: How many items of this type can be stacked in a single slot.

Properties: all the item's properties, like Durability, Health Restore, Fuel and so on. You can also define custom properties (see next tab).

Has Blueprint: Does this item have a blueprint? (Required for crafting and dismantling)

Blueprint: A list with all the "ingredients" necessary to craft this item, it's also used in dismantling.

IsCraftable: If enabled this item will show up in the survival book as a craftable item.

Craft Duration: How much time does it take to craft this item, in seconds.

Allow Dismantle: Can this item be dismantled?

Dismantle Efficiency: An efficiency of 1 will result in getting all of the item back after dismantling, while 0 means that no item from the blueprint will be made available.

• To create any item navigate to: "Tools / STP / Item Management".

• While there, you'll see the items organized by category. Choose a category, or create your own, and then create your item in that category, just click the "+" button for adding new elements.

• When you've added a new item in your desired category, click on it, you'll see all of it's info in the Item Inspector.

Explanation

Interaction Enabled: Is this object interactable, if not, this object will be treated like a normal one.

Hold Duration: How time it takes to interact with this object. (e.g. for how many seconds should the Player hold the interact button).

Interaction Text: Interactable text (could be used as a name), shows up in the UI when looking at an object.

Description: Interactable description, shows up in the UI when looking at an object.

On Interact Callback: Unity event that will be called when a character interacts with this object.

Properties

To create a property press on the "+" button and set it's name and type.

Property Types:

• Boolean: Can be true or false.

• Integer: Basic integer, just a number.

• Float: Decimal number.

• Item Id: Holds an item id..

Tags

To create a property press on the "+" button and set it's name.

A Wizard that helps creating new Wieldables is in the works, for now the best way to do that is copy and pasting any of the existing wieldable prefabs. Here's where you can find them:

"PolymindGames / SurvivalTemplatePro / Samples / Wieldables"

How to Create

• To start creating an item pickup, add an "Item Pickup" component to your object:

• After that you'll need to set the corresponding item to the one that you want:

Explanation

Item: Corresponding item id.

Item Count: How many items of the same type is this item going to contain.

Primary Flags: The first type of container that this item will be added to (e.g. a weapon would be added to the holster at first).

Pick Up Sound: Sound that will be played upon picking the item up.

Create

1. Duplicate one of the existing surfaces or create a new one at: "PolymindGames / SurvivalTemplatePro / Resources / Surfaces"

2. You can configure your new surface either through the inspector or the management window: "Tools / STP / Surface Management"

Configure

1. Registered Textures: Specify which textures correspond to this surface.

2. Foot Steps Soft and Hard footsteps (usually walk and run respectively)

3. Fall Impact Fall impact effects and audio that correspond to this surface.

4. Bullet Hit Effect Bullet hit effects and audio that correspond to this surface.

5. Slash & Stab Slash & Stab effects that correspond to this surface.

Note:

This function leverages the SurfaceManager to spawn an effect that corresponds to the hit surface type (e.g. grass, dirt etc.)