Data Storage: Difference between revisions

From Citizens Wiki

Line 13: Line 13:
       {{H:title|Should the NPC be spawned on server startup?|spawned: true}}
       {{H:title|Should the NPC be spawned on server startup?|spawned: true}}
       {{H:title|Type of NPC. Either PLAYER or the mob type|type: PLAYER}}
       {{H:title|Type of NPC. Either PLAYER or the mob type|type: PLAYER}}
       {{H:title|Owner of the NPC. Has all permissions for that NPC by default.|owner: Steve}}
       {{H:title|Owner of the NPC. Can be set to "server".|owner: Steve}}
       {{H:title|Location block. Stores the location of the NPC|location:}}
       {{H:title|Location block. Stores the location of the NPC|location:}}
         {{H:title|World that the NPC is located in|world: world}}
         {{H:title|World that the NPC is located in|world: world}}

Revision as of 20:24, 20 March 2012

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:
     spawned: true
     type: PLAYER
     owner: Steve
     location:
       world: world
       x: '92.65002360423462'
       y: '3.0'
       z: '-264.5621058817138'
       yaw: '87.90003967285156'
       pitch: '21.14999008178711'

Database

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

Configuration

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

database:
 password: 
 username: 
 url: 
 driver: 

See also: Configuration