diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4d0120 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Bank of Skyfall, D&D Edition +## Intro +This is currently a glorified shell script that functions like an interactive CLI application and uses a PostgreSQL database. + +Let's get a couple things, that I know I am going to hear, out of the way first: +#### Will you make a MySQL version? +No. +#### You should use SQLite. Postgres is way overkill for something like this. +Yes. It is. A SQLite version is planned, but I *like* Postgres, so that's what I chose to write for first. +#### Can you set up multiple banks? +Not very easily with this early version, but that will be a thing later on. + +## Setup +First, set up your Postgres DB that you intend to use. I recommend using UNICODE in case a player character insists on using diacritics, or of course, if your native language requires it. I use these options: + +```sh +# Yes, I know some of these options are redundant, but I never remember which ones, it doesn't hurt, and DERPA is easy to remember. +# Please note that your DB password, like is often required, will be stored as plain text in the configuration file. DO NOT RE-USE YOUR PASSWORDS, especially here. +createuser -DERPA [your_user] +createdb -E UNICODE -O [your_user] dnd_bank +``` + +Next, import the table structure included in this repo for a blank bank: +```sh +psql -h [db_host] -p [db_port] -U [your_user] -d [db_name] < dnd_bank.psql +``` + +Finally, set up your configuration file. (This step will be unnecessary via a guided configuration that will be included in a future update) +```sh +cp .dndbank.conf ~/ +vim ~/.dndbank.conf +# Fill out the information +``` + +Now just run the `bank` script and create some accounts. You are good to go! +