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.coThis 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 outside wallet or other players using the Minecraft console command:
/transfer <amount> <recipient-bitcoin-address>
/transfer <recipient-email>With this method the recipient will receive an email notifying that a bitcoin transaction has been made to a XAPO wallet linked to his email.
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. All transactions in the game are on-chain using Blockcypher's microtransactions API or in case of player-to-email XAPO API.
Everybody is welcome to contribute. :D
Here are the instructions to modify, install and run the server as localhost.
To setup the workspace you need to run a gradle script that only runs on bash. You can get a distribution of bash by installing git from the git-scm website.
Warning: building BitQuest is not currently supoported on Windows 10 Anniversary edition bash. If you have that feature installed, your build will fail. If you are building using Windows 10 Anniversary edition, it's recommended to uninstall the Windows Subsytem for Linux feature first.
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
Running locally via Docker is the fastest way to develop and test code. Docker is also the recommended way to run BitQuest in production, however configuration is different. Docker works by creating a "container" that runs your code that is very similar in concept to a Virtual machine. The file docker-compose.yml can be used to create this image and run a local server "synced" with your builds, so you won't need to restart the server to update changes.
- Build BitQuest using the instructions above (./gradlew shadowJar).
- Install Docker, the container runtime (For Windows and Mac, Beta version is recommended): Get Docker
- Install docker-compose, to orchestrate our dev environment: Get docker-compose
- Create development.yml file, where your local variables will be. This is done to protect API and private keys you might want to use to test. (development.yml is in .gitignore so it won't be uploaded to github) A good starting point is:
spigot:
environment:
- SPIGOT_ENV=development
To start your test server with docker-compose you can now run:
docker-compose up
The server will run with a local volume pointing to your latest jar built with Gradle. That means you can /reload inside the server and watch changes without restarting the Spigot container.
To run BitQuest might want to do the same steps as with a local test server, but specify a Bitcoin address for your local loot wallet, a BlockCypher API key and (optional) your Mojang account UUID so you are admin in your own server (otherwise you won't have op). To do this, you'll need to create a development.yml file that docker-compose will use to configure your local BitQuest instance.
Here's an example of a development.yml file (please note we use spaces instead of tabs):
spigot:
environment:
- BITQUEST_ENV=development
- BITCOIN_ADDRESS=1ERWGdhjHpmanu2ftScpvM8KM4P8Yrxct2
- BITCOIN_PRIVATE_KEY=a2a2f8b8308e699901d60c567a15633a88362c8f67c9f8a2dc02720c2e18d8a2
- BLOCKCYPHER_API_KEY=some_api_key
- ADMIN_UUID=921baf7a-893b-4249-b6a7-ae010ff75551
You will be able to connect to localhost in Minecraft, and every time you run the shadowJar gradle task, following a /reloadcommand inside the game, you'll be playing in your newest compiled code, without restarting or rebuilding the container.
More info about BitQuest at https://bitquest.co/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent