From 998cae5002e319d4d94fe6ca15a8cefc4092357b Mon Sep 17 00:00:00 2001 From: Kamil Czop Date: Thu, 7 Sep 2023 16:42:47 +0200 Subject: [PATCH] Small addendum to README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 295ae3a..bd03565 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ # Simplified auth -This is serversided modification that allows for authorization using ingame commands, such as /register or /login - -## Licenses: +This is serversided babric modification for Better Than Adventure that allows for authorization using ingame commands, such as /register or /login +
+In current form only possible to use JSON file based "database" +## Licenses Libraries used in this project are using: -- jBcrypt (MIT): https://github.com/jeremyh/jBCrypt \ No newline at end of file +- jBcrypt (MIT): https://github.com/jeremyh/jBCrypt +- halplibe (CC0): https://github.com/Turnip-Labs/bta-halplibe +## Setup +1. Mod to work would require working server instance of Babric BTA server ([available here](https://github.com/Turnip-Labs/babric-instance-repo/releases)) with halplibe version at least 2.1.6 (which was by default included in BTA instance) installed.
+2. Don't forget about read/write privilages on server directory and any other directory specified by config (by default should be available for server but still, this can sometime happen) + +## Config +Currently config allows for setting only +- DatabaseManager -specifies which database engine would be used for storing player data (currently only JSON file). +- Address - when specified json dbmanager, Address would point to directory where "database" file would reside. +- Schema - when specified json dbmanager, it would point at name of json file that would store usernames and encrypted passwords. +Modification in json manager mode should by default create required paths and files. \ No newline at end of file