Zerocraft Sync

Zerocraft Sync is committed to providing users with a smooth and effortless experience. By harnessing the capabilities of Zerotier VPN and GitHub, we've implemented a solution that enables Minecraft Bedrock hosts to seamlessly synchronize world data. No longer do users have to wait for a specific host to access their desired world data. With our application, users can initiate the process, and their world data will be automatically stored in a GitHub repository to be used later when starting up the server.

Features

Sync World Data: Effortlessly save and download world data to keep up to date no matter who is hosting!
Server Status: Easy way to view if server is currently online and being hosted.
Easy Start and Stop: Streamline server management with quick-access buttons, making it easy to initiate and halt your server as needed.
Server Shutdown Countdown: Clients on the server will be given a 10 second warning and a countdown letting others know the server is going down.
Console: Toggle the console view for a detailed rendering of the bedrock_console, giving you direct access to server commands.

Getting Started

Prerequisites

node.js

Dependencies

archiver
axios
simple-git

Requirements for Server Setup

** Only need to do this once per server**

Github Account
Github Repository (for world data, can be whatever name you want)
Github Gist (this will store the server_status.json)
Github Access Token (That can edit Gist and Repository)
Minecraft Bedrock Dedicated Server (download this from the Minecraft website)

Installation

Clone this repository: https://github.com/programmingKyle/zerocraft-sync
cd zerocraft-sync
npm install

-- or --

Download zip file below and extract
Launch zerocraft-sync

Github Setup

** Remember this only has to be done once per server this is just a way for all your hosts to have the same information **
Recommended you create a new Github account for your server. You will be giving an access token to whoever else you want to host.

Register account
Login to Github
Create a repository with desired name
- Here you can go ahead and upload your worlds/Bedrock level folder (there should only be the Bedrock level folder in the repo)
Create a Github Gist for the server_status.json and add contents

server_status.json file contents

{
  "status": "OFFLINE",
  "servername": null,
  "ip": null,
  "port": null
}

How to Setup Access Token

Login to Github
Click profile picture
Click Settings
Scroll down and click Developer Settings
Click Tokens(classic)
Click Generate new token
Next check "repo" giving full control of private repositories.
Check "gist" giving control to your private gists as well
Access Token's expiration is up to you.
Save and put the code in a place you'll rememeber.

Minecraft Server Setup

Simply download the dedicated server here:
https://www.minecraft.net/en-us/download/server/bedrock
Create a new folder somewhere on your PC
Extract Minecraft server contents to the new folder
Make sure that this directory is selected when selected server directory in settings (in Zerocraft Sync)

How To Use

First in the zerocraft-sync directory open a terminal and input 'npm start' or launch the .exe file
From there user will be prompted to input server settings. Fill out all inputs and then click save. From there you can use the start and stop button.

How To Use Console

When you are the host and the server is online there will be a console toggle button to the right of the server messages. There it will open a new window where you can use the console just like bedrock_server.exe. The only command that isn't accepted is 'stop' for obvious reasons.

Thank you

If everything is filled out correctly and setup you should see changes happening to the gist and repo as you start and stop the server.
Thank you for checking out Zerocraft Sync. Any contributions are welcome.
If you have issues feel free to send a message!