Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 1.75 KB

README.md

File metadata and controls

65 lines (39 loc) · 1.75 KB
Raw

📁 MC-Sync-Download

Description

This is part of the pack MC-Sync. MC-Sync are two programms that aims to make easier to play minecraft (java edition) with your friends without a real server.

See MC-Sync-Upload

MC-Sync-Download has the function of receiving the world (server) from another person or download it from the firebase cloud (free or paid tier) to make backups.

Purpouse

📖 Learn

  • Create better CLI APPs
  • Interact with NBT files (Minecraft configuration files)
  • Use Firebase Storage
  • Read toml files

✨Create a simple programm to play Minecraft Survival with my friends 👤

Technologies used 📘

  • Go (Golang)

External Packages 📦:

  1. firebase (firebase cloud ☁)
  2. pterm (beautiful UI)
  3. toml (config files ⚙)
  4. godotenv (secrets 🤫)
  5. google api (google cloud options)

Docs

Prerequisites 📌

  • Go 1.18
  • Ngrok (I mention ngrok but you can use other tools that supports tcp tunnels)
  • Firebase Project (Firebase Storage)

Set up 💻

git clone https://github.com/PiterWeb/MC-Sync-Download.git
cd ./MC-Sync-Upload
go mod tidy

Configure the project with the .env , serviceAccountKey.json and accounts.toml files.

Build 🔨

go build .

An executable for your OS will be created

Play 🪀

Share the executables and also ngrok with your friends

When you open the world in LAN go to ngrok and type:

ngrok tcp <port> --region <region to host>

And send the ngrok domain name to your friends as an IP for the server (Example: 74329sadoijjiosad.ngrok.io )