Skip to content

elmatike/world-syncer

Repository files navigation

🔄 World Syncer Mod (Fabric)

Minecraft Version Loader Dependencies

World Syncer is an advanced, automated Fabric mod for Minecraft 1.21.4 that seamlessly backs up and synchronizes your single-player world saves with your GitHub repositories. Play on your PC at home, leave the world, and instantly pick up exactly where you left off on your laptop or Steam Deck!

World Syncer es un mod avanzado y automatizado de Fabric para Minecraft 1.21.4 que realiza copias de seguridad y sincroniza tus mundos de un solo jugador con tus repositorios de GitHub. ¡Juega en tu PC de escritorio, sal del mundo y continúa exactamente donde lo dejaste en tu laptop o Steam Deck al instante!


✨ Features / Características

  • ⚡ Automated Backup (Auto-Push): Automatically stages, commits with timestamps, and pushes your world saves to GitHub whenever you leave a world. No manual copy-pasting or zip archiving required!
  • 🔄 Instant Sync (Auto-Pull): Automatically checks for updates and pulls the latest save file from GitHub when you open the "Select World" screen. Play on multiple devices with 100% confidence!
  • 🛠️ Auto-Provisioning: If a repository doesn't exist on your GitHub for a synced world, the mod will automatically call the GitHub API and provision a secure private repository for it on-the-fly!
  • ⚙️ In-Game Configuration: Fully managed configuration screens integrated into ModMenu and powered by Cloth Config. Toggle sync for specific worlds and paste your API tokens securely.
  • 🔒 Smart Exclusions (.gitignore): Automatically filters out temporary lock files (session.lock), local log files (logs/), crash reports, and backup files (level.dat_old) to save cloud space and prevent merge conflicts.

🛠️ Setup & Installation / Configuración e Instalación

1. Requirements / Requisitos

Make sure you have the following installed in your mods folder:


2. Generate a GitHub Access Token / Generar Token de Acceso

To allow the mod to securely connect and upload worlds to your GitHub account:

  1. Go to GitHub Settings > Developer Settings > Personal access tokens > Tokens (classic).
  2. Click Generate new token -> Generate new token (classic).
  3. Give it a description (e.g. World Syncer Mod).
  4. Check the repo scope (this permits the mod to create repositories and push/pull your saves).
  5. Generate and copy the token (starts with ghp_).

3. Mod Configuration / Configuración en el Juego

  1. Launch Minecraft and click on the Mods button on the main menu.
  2. Find World Syncer and click the gear/configure icon.
  3. Paste your GitHub Personal Access Token (PAT) in the token field.
  4. Load your single-player world list, select a world, and toggle backing up ON in the configuration screen!

📂 Files Automatically Excluded / Archivos Excluidos

The mod automatically configures an internal .gitignore for your world folders to ignore the following:

  • session.lock (lock files preventing simultaneous world openings)
  • logs/ & crash-reports/ (bulky local diagnostics)
  • *.tmp & temporary archives
  • level.dat_old & player backup data (*.dat_old)

Created with ❤️ by elmatike. Feel free to fork, open issues, or contribute! Creado con ❤️ por elmatike. ¡Siéntete libre de clonarlo, reportar fallos o contribuir!

About

Fabric mod for Minecraft that automatically backs up and synchronizes your world saves with private/public GitHub repositories.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors