Skip to content

Latest commit

 

History

History
147 lines (96 loc) · 5.76 KB

README.md

File metadata and controls

147 lines (96 loc) · 5.76 KB
Raw

logo

EverCraft

Transform your gameplay to a real economy!

Pay other players with ÊVERs - the native currency of the Everscale blockchain.

Preview

Beta notice

Please keep in mind this is a beta release. Do not keep too many funds in it until the plugin is thoroughly tested by the Everscale community.

Please report any issues at the Issues page.

Features

  • Secure SafeMultisig wallets for each player with no admin access to players' funds
  • Personal key storage encrypted with player's password
  • Player features:
    • Create and export private key with password protection
    • Generate and automatically deploy account
    • Get your deposit address and check your balance
    • Send by username or by Êver address

Installation

Compatibility

Basic

  • Take the recent build of EverCraft.jar and put it in Plugins folder of your Paper installation
  • Create the folder EverCraft in plugins folder
  • Clone the config.yml file using the command below:
$> wget https://raw.githubusercontent.com/vp-mazekine/EverCraft/master/src/main/resources/config.yml --no-check-certificate
  • Configure the plugin as described in the Configuration section below
  • Restart your server and enjoy

Advanced

It is highly recommended setting up your own instance of TON API. This ensures more security for your user funds and provides additional convenience for you if you have several Minecraft servers.

After having it installed, indicate its endpoints in the config.yml file.

Configuration

config.yml file provides you with several configuration options, explained below.

Everscale connectors

In order for the plugin to function, it needs to be properly connected to the Everscale network.

It uses TON API for easy wallet management and TON SDK for external transactions signing.

TON API parameters explained

Key Explanation
api.endpoint The link to where the instance of TON API is located. It can include protocol, hostname and port, but cannot contain path elements and should not end with a slash
api.prefix The repeated path element that will be added to all HTTP requests. Typically equals to /ton/v3
api.key Access key, issued by TON API administrator (e.g., Broxus)
api.secret Secret phrase required for signing API calls, issued by TON API administrator

All parameters are required for plugin to function properly.

TON OS parameters explained

Key Explanation
tonos.network Indicates which Everscale network to use. Typically equals to main.ton.dev

Security

EverCraft uses the two-level encryption of players data and, at the same time, provides the latter with an opportunity to input a password instead of private key each time.

To let it function securely, it needs the following two parameters initialized before using in-game.

You can use a random UUID or any alphanumeric string of 64 bytes and longer.

Key Explanation
storage.password A secure phrase that will encrypt the players data container.
security.salt A secure phrase required to generate a compliant private key.

⚠️ NB

If you change these values in the config.yml after players have created their wallets, they will lose the access to their funds.

Please make a backup of configuration file after saving it.

Localization

The following locales are supported (set one in locale configuration):

Locale Description
en American English

In-game usage

Open the chat console and type any of commands below:

Command Description
/e_register [password] [repeat_password] Creates a new private key and encrypts it with your password.
A personal address will be generated as well
/e_address Get your EVER address to top-up
/e_balance Get your wallet balance
/e_pk [password] Outputs your private key for external use.
Don't forget to clear the chat with F3+D after using it.
/e_new_password [old_password] [new_password] [repeat_new_password] Set new password for your account
/e_send [player] [amount] [password] Send some Êvers to another player
/e_withdraw [address] [amount] [password] Withdraw Êvers to an external address
/e_version Get the installed version of the plugin

Wallet deployment notice

Please make sure you deposit (or ask another player to send) at least 0.3 Êver to your personal address before the first sending, as the system needs to pay gas fees for the wallet deployment.

License

Copyright 2021 Mazekine OU

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Credits

EverCraft uses several open-source masterpieces of Everscale ecosystem: