Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Commit

Permalink
Small addendum to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Myknakryu committed Sep 7, 2023
1 parent e877272 commit 998cae5
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<br/>
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
- 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.<br/>
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.

0 comments on commit 998cae5

Please sign in to comment.