mirror of
https://github.com/Expand-sys/CCash
synced 2025-12-17 08:32:13 +11:00
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
# CCash
|
|
|
|
A webserver hosting a bank system for Minecraft
|
|
|
|
### 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
|
|
- there is no central authority minting the currency, any consumer can introduce more diamonds to the system
|
|
- some resources are passively reapable, making the generation of currency a larger focus then of products
|
|
- locality is required for transaction
|
|
- theft is possible, ownership is possession based
|
|
|
|
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
|
|
|
|
```
|
|
git clone --recurse-submodule https://github.com/EntireTwix/CCash/
|
|
mkdir build
|
|
cd build
|
|
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
|
|
|
|
- [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)
|
|
|
|
# Features
|
|
|
|
### Performance
|
|
|
|
- **NOT** written in Lua
|
|
- written in **C++**, arguably the fastest language
|
|
- **multi-threaded**
|
|
- **parallel hashmaps** a far superior HashMap implementation to the STD, that also benefit from multi-threaded
|
|
- **Passwords are Hashed**, allowing each user to be 12 bytes, which is allows hashmap to be flat
|
|
|
|
### Safety
|
|
|
|
- **Tamper Proof** relative to an in-game implementation
|
|
- **Auto-Saving** and Saves on close
|
|
- **HTTPS** (OpenSSL)
|
|
|
|
### Accessibility
|
|
|
|
- **Web front-end**
|
|
- **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
|
|
|
|
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`
|