Creating Starts

Introduction

The start.yaml file is the most important file of a plugin, it's the root of the lore. This file is filled in with the attributes that the player will have when starting the game using your plugin. This attributes are the items, the gold, the mounts that the player owns, the health and max health, the starting location etc... Some of these attributes are not required but most of them are required, even if they are not filled.

It's recommended to just copy the vanilla start data and modify it as you want if you're willing to make a plugin.

Full Explanation

Here is the start.yaml file syntax.

cheat: <number of cheat time(int)>
health: <health(int)>
armor protection <armor protection(float)>
current mount: <mount uuid(str)> # if you want none, put `" "`
agility: <agility(float)>
gold: <gold(float)>
held item: <item id(str)> # if you want none, put `" "`
held chestplate: <item id(str)> # if you want none, put `" "`
held boots: <item id(str)> # if you want none, put `" "`
held leggings: <item id(str)> # if you want none, put `" "`
held shield: <item id(str)> # if you want none, put `" "`
starting date: <<month>-<day>-<year>(str)>
inventory slots: <slots(int)>
inventory slots remaining: <remaining slots(int)>
elapsed time seconds: <elapsed time(float)>
elapsed time game days: <elapsed time(float)>
walked miles: <miles(int)>
attributes: <attributes list(list)> # if you want none, put "- None" in the list alone
active missions: <missions list(list)> # if you want none, put "[]" after the ":"
done missions: <missions list(list)> # if you want none, put "- None" in the list alone
offered missions: <missions list(list)> # if you want none, put "- None" in the list alone
active effects: <effects(dict)> # here, you just an empty dict "{}" after the ":"
orders: # here just put "None: none" in the orders dict
  None: none
mounts: # here just put "None: none" in the orders dict
  None: none
start dialog:
  dialog: <dialog id(str)>
  heard start dialog: <false | true(bool)>
heard dialogs: <dialogs(list)> # if you want none, put "- None" in the list alone
used keys: <map points digit(list)> # if you want none, put "- None" in the list alone
visited zones: <map zones id(list)> # if you want none, put "- None" in the list alone
met npcs names: <npcs id(list)> # if you want none, put "- None" in the list alone
visited points: <map points digit(list)> # if you want none, put "- None" in the list alone
enemies list: <enemies id(list)>  # if you want none, put "- None" in the list alone
inventory: <items(list)> # if you want none, put "- None" in the list alone
max health: <max health(int)>
x: <x coordinate(int)>
xp: <experience points(float)>
y: <y coordinate(int)>
taken items: <map points digit(list)> # if you want none, put "- None" in the list alone
defeated enemies: <map points digit(list)> # if you want none, put "- None" in the list alone
met npcs: <map points digit(list)> # if you want none, put "- None" in the list alone

• cheat // this is the number of time you eased the cheat code when died. After 3 times, the player will get it save reset.
• health // the health that the player will have when first spawning.
• armor protection // this is the armor protection stat of the player. There is no need to enter any specific value, since it is calculated and update in the game loop. Just put 0.
• current mount // here you will put a mount UUID that exists in the mounts dict lower in the code. If you want none, put " ".
• agility // this is the agility stat of the player. There is no need to enter any specific value, since it is calculated and update in the game loop. Just put 0.
• gold // this is the starting gold of the player.
• held item // this is the weapon the player is currently equipped with. If you want none, put " ".
• held chestplate // this is the chestplate the player is currently equipped with. If you want none, put " ".
• held boots // this is the boots the player is currently equipped with. If you want none, put " ".
• held leggings // this is the leggings the player is currently equipped with. If you want none, put " ".
• held shield // this is the shield the player is currently equipped with. If you want none, put " ".
• starting date // the date where the player is supposed to be in when he begins its journey. Used to calculate the actual game date, with the elapsed game days player stat.
• inventory slots // this is the inventory slots the player have in total. There is no need to enter any specific value, since it is calculated and update in the game loop. Just put 0.
• inventory remaining // this is the inventory slots that remains for the player. There is no need to enter any specific value, since it is calculated and update in the game loop. Just put 0.
• elapsed time seconds // the time in seconds the player has spent playing. Used to calculate the game day.
• elapsed time game days // this is the time in game day the player has spent playing. Used to caltulate the game current time(in-game night, morning, evening...).
• walked miles // the game statistic that tells how many miles you've walked during your journey.
• attributes // this is the list of attributes the player has got during its journey. They are obtained from dialogs and used by dialogs. This is mainly used to know if a dialog should be triggered or not. If you want none, put "- None" in the list alone. Check this wiki page to get more info about that.
• active missions // this is the list of missions that the player has active. If you want none, put "[]" as a value.
• done missions // this is the list of missions that the player has done. If you want none, put "- None" in the list alone.
• offered missions // this is the list of missions that the player got offered. If you want none, put "- None" in the list alone.
• active effects // this is the dictionary that contains the player's active effects. Put "{}" (an empty dictionary) as a value.
• orders // the dict that contains all the orders dict. If you want none, put "None: none" in the orders dict.
  • <order_uuid>
    • paid gold // this is the gold that the player has spent to order.
    • ordered weapon // the item the player ordered.
    • ordered day // this is the in game days of when the payer ordered.
    • ordered blacksmith // this is the blacksmith map location (using 'pointx' format) from where the player order.
    • time needed // this is the time in game days needed to be passed for the order to be ready.
    • has taken back order // this is used to check if this order have been taken back or not. You'll enter either true or false.
• mounts: // the dict that contains all the mounts dict. If you want none, put "None: none" in the mounts dict.
  • <mount_uuid>
    • deposited day // this is the game day where this mount has been deposited. Put 0 if it has not been deposited.
    • is deposited // this is used to check if this mount has been deposited or not. You'll enter either true or false.
    • level // this is the level of the current mount.
    • location // this is the map point where this mount has been deposited (using the pointx fromat).
    • mount // this is the mount type of this mount.
    • name // this is the name of this mount.
    • stats
      • agility addition // this is the agility that this mount adds when ridden.
      • resistance addition // this is the resistance that this mount adds when ridden.
• start dialog
  • dialog // this is the name of the dialog that will be displayed at the first player spawn.
  • heard start dialog // this is to check if the start dialog has already been shown. You'll enter either true or false.
• heard dialogs // this is the list of location that the player has heard dialogs on. If you want none, put "- None" in the list alone.
• used keys // this is the list of location that the player has used keys on. If you want none, put "- None" in the list alone.
• visited zones // this is the list of map zone that player has visited during his journey. If you want none, put "- None" in the list alone.
• met npcs names // this is the list of npcs that the player has encountered during his journey. If you want none, put "- None" in the list alone.
• visited points // this is the list of points the player has been on. If you want none, put "- None" in the list alone.
• enemies list // this is the list of enemies the player has fought during his journey. If you want none, put "- None" in the list alone.
• inventory // this is the list of all player's items. If you want none, put "- None" in the list alone.
• max health // this is the max health of the player.
• x // this is the x coordinates of the player.
• xp // this is the player experience.
• y // this is the y coordinates of the player.
• taken items // this is the list of points where the player has taken items from the ground. If you want none, put "- None" in the list alone.
• defeated enemies // this is the list of points where the player has defeated enemies. If you want none, put "- None" in the list alone.
• met npcs // this is the list of points where the player has encountered npcs on. If you want none, put "- None" in the list alone.