mirror of
https://github.com/BlockWorldGroup/Ledger-Databases.git
synced 2025-08-17 19:49:42 +08:00
Add usage instructions
This commit is contained in:
parent
a457682838
commit
416e53eb46
29
README.md
29
README.md
@ -1,3 +1,32 @@
|
|||||||
# Ledger Databases
|
# Ledger Databases
|
||||||
|
|
||||||
Adds support for MySQL and H2 databases in Ledger
|
Adds support for MySQL and H2 databases in Ledger
|
||||||
|
|
||||||
|
## Use
|
||||||
|
|
||||||
|
## Common
|
||||||
|
|
||||||
|
For both MySQL and H2, you will need to place Ledger Databases in your mods folder along with Ledger 1.1.0 or newer
|
||||||
|
|
||||||
|
## H2
|
||||||
|
|
||||||
|
Add the following to the bottom of your Ledger config file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[database_extensions]
|
||||||
|
h2 = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## MySQL
|
||||||
|
|
||||||
|
Add the following to the bottom of your Ledger config file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[database_extensions]
|
||||||
|
mysql = true
|
||||||
|
url = ""
|
||||||
|
username = ""
|
||||||
|
password = ""
|
||||||
|
```
|
||||||
|
|
||||||
|
`url`: Must be URL of database with `/<database_name>` appended. An example URL would be `localhost/ledger`. You can optionally add port information such as `localhost:3000/ledger`
|
||||||
|
@ -29,7 +29,7 @@
|
|||||||
"fabric": "*",
|
"fabric": "*",
|
||||||
"minecraft": "1.17.x",
|
"minecraft": "1.17.x",
|
||||||
"java": ">=16",
|
"java": ">=16",
|
||||||
"ledger": "*",
|
"ledger": ">=1.1.0",
|
||||||
"fabric-language-kotlin": "*"
|
"fabric-language-kotlin": "*"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user