Giter Club home page Giter Club logo

bitquest's Introduction

BitQuest

BitQuest is a Minecraft server with a Bitcoin-denominated currency and MMORPG elements. This repository is the open source code running on the server.

Play BitQuest

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

Important Note

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

How it works?

Everyone is a Bitcoin wallet

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. A player just joined the server The playercan see it's bitcoin balance

And there's loot!

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. A player got loot

Everyone can send money anywhere

You can send Bitcoin to an external wallet with /transfer:

/transfer <amount> <recipient-bitcoin-address>

Player using transfer command Player notification Player's public transaction

Additionally, players can send Bitcoin to other players via /send:

/send <amount> <username>

Server address

The BitQuest server has it's own address, used for giving Loot to players

About the back-end technology

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.

Building the BitQuest Java Plugin

1. Install Requirements

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

2. Setup Workspace

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

3. Compile BitQuest and generate a JAR file

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

Requirements for running

A Bitcoin Core testnet node running in your computer or local network with the json-rpc interface activated.

Running a local BitQuest test server

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.

  1. Build BitQuest using the instructions above (./gradlew shadowJar).
  2. Install Docker, and Docker Compose if you haven't yet.
  3. 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


  1. Use docker-compose to spawn a test server
docker-compose up

More info

https://bitquest.co/

bitquest's People

Contributors

explodi avatar juanj avatar theraccoonbear avatar ragingmouser avatar psilupan avatar chulini avatar jordigoyanes avatar wakiyamap avatar tracker6310 avatar dabtime avatar teogorghin avatar airiellis avatar andrelaszlo avatar findbl0k avatar jeje-50 avatar kordless avatar nullpilot avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.