Update README.md

This commit is contained in:
William Katz 2021-05-03 23:37:16 -07:00 committed by GitHub
parent 8578ac869e
commit e8152dc2bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,8 +2,6 @@
A webserver hosting a bank system for Minecraft, able to be used from web browser or from CC/OC if you're playing modded.
### Description
the currency model most Minecraft Servers adopt if any, is resource based, usually diamonds, this model is fraught with issues however:
- the primary issue is minecraft worlds are infinite leading to hyper inflation as everyone accrues more diamonds
@ -14,7 +12,7 @@ the currency model most Minecraft Servers adopt if any, is resource based, usual
CCash solves these issues and adds a level of abstraction, the main philosophy of CCash is to have fast core operations that other services build on
### Build
## Build
drogon depedencies
```
sudo apt install libjsoncpp-dev
@ -40,24 +38,23 @@ finally, run the program
sudo ./bank <admin password> <saving frequency in minutes> <threads>
```
### Connected Services
## Connected Services
Go to `{ip}/BankF/help` to see the bank's methods. Using the Bank's API allows (you/others) to (make/use) connected services that utilize the bank, a couple ideas are
#### Implemented:
### Implemented:
- [Web Frontend](https://github.com/Expand-sys/ccashfrontend)
![image](https://user-images.githubusercontent.com/31377881/116965729-4ab44500-ac63-11eb-9f11-dc04be6b3d63.png)
- [CC API](https://github.com/Reactified/rpm/blob/main/packages/ccash-api/api.lua)
- [CC Frontend](https://github.com/Reactified/rpm/blob/main/packages/ccash-wallet/wallet.lua)
![image](https://user-images.githubusercontent.com/31377881/116967157-8b618d80-ac66-11eb-8f2e-4a6297ef0b16.png)
- [CC API](https://github.com/Reactified/rpm/blob/main/packages/ccash-api/api.lua)
#### In-Dev:
### In-Dev:
- [a Market](https://github.com/STBoyden/market-api-2.0)
#### Ideas:
### Ideas:
- Gambling
- Shipping
@ -66,7 +63,7 @@ Go to `{ip}/BankF/help` to see the bank's methods. Using the Bank's API allows (
`**WARNING** : abruptly killing the program will result in data loss, use Close() method to close safely`
# Features
## Features
### Performance
@ -87,7 +84,7 @@ Go to `{ip}/BankF/help` to see the bank's methods. Using the Bank's API allows (
- **RESTful** API for connected services like a market, gambling, or anything else you can think of
- able to be used millions of blocks away, across dimensions, servers, **vanilla or modded**. In contrast to an in-game modded implementation that would be range limited.
#### Dependencies
## Dependencies
- [Parallel HashMap](https://github.com/greg7mdp/parallel-hashmap/tree/master)
- [Drogon](https://github.com/an-tao/drogon/tree/master)