ranvier-datasource-sqlite/README.md

Enable Ranvier MUD to leverage Sqlite as a datasource. Inserts data for entities into configured table as a serialized json object and retrieves back into a JSON object for game use.

# ranvier-datasource-sqlite
A Sqlite data store for Ranvier MUD as an alternative to flat file storage

To install and use, on the command line in your ranvier folder first do the following:

1) Install sqlite, e.g. on Ubuntu: sudo apt-get install sqlite3
2) Install this node module: npm install ranvier-datasource-sqlite
Note: This will also install the better-sqlite3 module as a dependency
3) Update your ranvier.json to specify the file as a requirement like so:
At the end of JsonDirectory require block add a comma after the }, and add these lines:
"Sqlite": {
	"require": "ranvier-datasource-sqlite.SqliteDataSource"
}

4) Update your ranvier.json file with the needed config for table name,
e.g. for using sqlite as your data store for players, it should look like this:

"players": {
  "source": "Sqlite",
  "config": {
    "database": "ranvierdb",
    "table": "players"
  }
},

5) Start ranvier and it should be working!