BitQuest is a Minecraft server with a Bitcoin-denominated currency and MMORPG elements. This repository is the open source code running on the server.
To play in the official BitQuest server you must own the official Minecraft game for PC/Mac/Linux and add this server address:
play.bitquest.co
This server is still under development, and bugs can, and most likely will, happen. Please report any bugs to a moderator promptly, to ensure they are fixed. Also note that your wallet is not guaranteed, and you may experience issues with your balance. For this reason, it is highly recommended that you do not deposit large amounts, or anything you do not wish to place at risk by being tied to the server. In addition, if you are caught breaking rules and are banned, you forfeit your access to your server wallet, and all funds tied to it. With this said, rules are non-negotiable, and will be strictly enforced. This server is a fair server, and anyone abusing any system set in place will be punished. Please play fair, have fun, and enjoy the server
The BitQuest server and every player has a bitcoin address. Any player can receive and send bitcoin to any address inside or outside the game. This is useful for buying materials, selling crafts, trading, tipping, etcetera.
Every time a player kills an enemy (mob) there is a chance to get loot. If that is the case the server makes a transaction directly from the server address to the player address and the player is notified.
You can send Bitcoin to an external wallet with /transfer:
/transfer <amount> <recipient-bitcoin-address>
Additionally, players can send Bitcoin to other players via /send:
/send <amount> <username>
The BitQuest server has it's own address, used for giving Loot to players
All persistent data is saved in a redis database so the server can respond as quick as possible.
Everybody is welcome to contribute. :D
Here are the instructions to modify, install and run the server as localhost.
Windows: The Windows Subsystem for Linux enables the bash shell which will be used to download the Spigot API. After installing WSL you can follow the Linux instructions below.
You must install Java JRE and JDK
sudo apt install default-jre default-jdk
There is a gradle task that will download and compile the latest Spigot API and other tools needed to compile the project. Using a terminal, go to the project directory and run:
./gradlew setupWorkspace
After the workspace is set up, we can compile using the shadowJar task that will create a file under build/libs. This should be dropped on the plugins folder of your Spigot server, but you can automate the process for testing using Docker (instructions below)
./gradlew shadowJar
A Bitcoin Core testnet node running in your computer or local network with the json-rpc interface activated.
Running locally via Docker is the fastest way to develop and test code. Docker and Docker Compose can be used for testing the compiled plugin on spigot.
- Build BitQuest using the instructions above (./gradlew shadowJar).
- Install Docker, and Docker Compose if you haven't yet.
- Create a docker-compose.yml file with your configuration. A good idea is to create a volume on spigot's 'plugins' pointing to the local directory where .jar files are compiled. Or you can use the following example:
spigot:
container_name: bitquest
environment:
- BITQUEST_ENV=development
- BITCOIN_NODE_HOST=127.0.0.1 # or the IP of your Bitcoin Core node
- BITCOIN_NODE_USERNAME=alice # the username for the RPC-JSON interface
- BITCOIN_NODE_PASSWORD=secret # the password for RPC-JSON
build: .
volumes:
- "./build/libs/:/spigot/plugins"
- ".:/bitquest"
ports:
- "25565:25565"
links:
- redis
redis:
image: redis
- Use docker-compose to spawn a test server
docker-compose up