This commit is contained in:
EntireTwix 2021-04-19 03:17:23 -07:00
commit a0e7903e25

View file

@ -1,6 +1,6 @@
# CCash
A webserver hosting a bank system for Minecraft
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
@ -14,6 +14,13 @@ 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
#### Demo
(BACKEND)
https://ccash.ryzerth.com/BankF/help
(FRONTEND)
https://ccashfrontend.herokuapp.com
#### Build
```
@ -24,11 +31,28 @@ cmake ..
make -j<threads>
sudo ./bank <admin password> <saving frequency in minutes> <threads>
```
you also have to edit the config file to add your cert locations, I personally use cert bot
#### Dependencies
### Connected Services
- [Parallel HashMap](https://github.com/greg7mdp/parallel-hashmap/tree/master)
- [drogon web framework (and all its dependencies)](https://github.com/an-tao/drogon/tree/master)
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:
- [a Leaderboard (ComputerCraft)](https://pastebin.com/u23BNVvP)
- [Cute frontend](https://github.com/Expand-sys/ccashfrontend)
In-Dev:
- [a Market](https://github.com/STBoyden/market-api-2.0)
Ideas:
- Gambling
- Shipping
- High-level bank operations such as loans
- Some trust based system for transactions similiar to Paypal
`**WARNING** : abruptly killing the program will result in data loss, use Close() method to close safely`
# Features
@ -43,7 +67,7 @@ sudo ./bank <admin password> <saving frequency in minutes> <threads>
### Safety
- **Tamper Proof** relative to an in-game implementation
- **Auto-Saving**, Saves on crash, Saves on close
- **Auto-Saving** and Saves on close
- **HTTPS** (OpenSSL)
### Accessibility
@ -52,24 +76,8 @@ sudo ./bank <admin password> <saving frequency in minutes> <threads>
- **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.
### 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
#### Dependencies
Implemented:
- [a Leaderboard (ComputerCraft)](https://pastebin.com/u23BNVvP)
In-Dev:
- a Market
Ideas:
- Gambling
- Shipping
- High-level bank operations such as loans
- Some trust based system for transactions similiar to Paypal
- Cute frontend
`**WARNING** : abruptly killing the program will result in data loss, use Close() method to close safely`
- [Parallel HashMap](https://github.com/greg7mdp/parallel-hashmap/tree/master)
- [drogon web framework (and all its dependencies)](https://github.com/an-tao/drogon/tree/master)