Data Storage

Data storage in Citizens2 is handled in one of two ways: YAML flatfile, or a SQL database.

saves.yml

saves.yml is used by default to store all data on created NPCs.

Structure

Mouseover to view info:

# Citizens NPC Storage
npc:
  '0':
   name: My_First_NPC
   traits:
     age:
       age: 0
       locked: true
     spawned: true
     type: PLAYER
     owner: Steve
     lookclose: true
     location:
       world: world
       x: '92.65002360423462'
       y: '3.0'
       z: '-264.5621058817138'
       yaw: '87.90003967285156'
       pitch: '21.14999008178711'
     text:
       talk-close: true
       random-talker: true
       0: Hello, there. I'm My_First_NPC.
     waypoints:
       waypoints:
         '0':
           location:
             world: MyWorld
             x: 60
             y: 64
             z: 80
             pitch: 90
             yaw: 0
         '1':
           location:
             world: MyWorld
             x: 65
             y: 64
             z: 82
             pitch: 45
             yaw: 0

Database

Database usage can be configured inside of the config.yml. Database usage requires more setup, but may be quicker, more secure and more resilient when dealing with large numbers of NPCs.

SQL storage is not currently functioning correctly

Configuration

A quote from the config.yml (mouseover to view info):

database:
 password: 
 username: 
 url: 
 driver: 

See also: Configuration

    - Database settings -
    driver: the database type - eg. mysql, sqlite, postgres, h2
    url: the database url - eg. sqlite://path/to/your/database.db
    MySQL uses the database IP address - eg. mysql://localhost:2222/database

    The username and password settings are required to connect to certain types of databases such as MySQL.