Bot System

From Vintage Story Wiki
Revision as of 21:10, 11 December 2021 by Ninjanomnom (talk | contribs) (Adds the modding category navbox footer)

Vintage Story comes with some rudimentary interface to control creatures and humanoids through commands, which is mostly aimed for video recordings. Here's how to use it:

Spawn in a bot

Only some creatures are supported, here's a list

  • /entity spawn playerbot
  • /entity spawn animalbot-wolf-male
  • /entity spawn animalbot-hyena-male
  • /entity spawn animalbot-hyena-female
  • /entity spawn animalbot-hyena-pup
  • /entity spawn animalbot-chicken-hen
  • /entity spawn animalbot-chicken-rooster
  • /entity spawn animalbot-chicken-baby
  • /entity spawn animalbot-sheep-bighorn-male
  • /entity spawn animalbot-sheep-bighorn-female
  • /entity spawn animalbot-sheep-bighorn-lamb
  • /entity spawn animalbot-locust-corrupt
  • /entity spawn animalbot-hare-female-lightgrey
  • /entity spawn animalbot-piglet
  • /entity spawn animalbot-drifter-normal
  • /entity spawn animalbot-drifter-corrupt
  • /entity spawn animalbot-drifter-nightmare

Select a bot

Right click the creature to select it. You can now tell it to execute commands or define a list of commands to execute in a loop

Instruct the bot

Legend: flexiblepos means either x y z coordinates as defined in the coordinate hud, absolute coordinates through =x =y =z or coordinates relative to the player with ~x ~y ~z, you can also do ~ ~ ~ do use exactly the players position.

Immediate

Type one of either commands to execute a command right away

  • /npc exec tp flexiblepos teleport to given position
  • /npc exec lookat rad look in given direction in radians (0..2PI)
  • /npc exec goto flexiblepos animcode speed [animspeed] walk to given position with given animation, given speed (normal walking speed is about 0.02) and given animation speed (default 1)
  • /npc exec playanim animcode players given animation. Valid ones for animals, if supported by the respective animal: hurt, die, eat, walk, cry, shamble, lowshamble, sleep, sit, listen, hide, idletwitch, drill

Queued

If you want to bot to run or remember a list of commands replace "exec" with "enq" to enqueue commands:

  • /npc enq [tp|lookat|goto|playanim] (see args above)
  • /npc start to start command list
  • /npc stop to stop
  • /npc loop to make the bot endlessly loop through his list of commands
  • /npc clear will clear the command list
  • /npc list show list of queued commands
  • /npc remove [index] remove command of given index as shown in /npc list
  • /npc upd allows you do modify some commands
Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityEntity BehaviorsBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsCollectible BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository