Backup System Mod - README
===========================

🔄 AUTOMATIC WORLD BACKUP SYSTEM FOR MINECRAFT SERVERS 🔄

Backup System is a powerful Minecraft Forge mod that provides automated world 
backup functionality with Dropbox cloud storage integration. Keep your worlds 
safe with scheduled backups that run in the background without interrupting 
gameplay.

FEATURES:
=========
✅ Automated scheduled backups
✅ Dropbox cloud storage integration  
✅ Configurable backup intervals
✅ Multi-dimensional world support (Overworld, Nether, End)
✅ Automatic old backup cleanup
✅ Manual backup commands
✅ JSON configuration system
✅ OP-only security controls
✅ Cross-platform compatibility

REQUIREMENTS:
=============
- Minecraft 1.20.1
- Minecraft Forge 47.3.33 or higher
- Java 17 or higher
- Dropbox account and API token
- Server operator permissions

QUICK START GUIDE:
==================

1. INSTALLATION:
   - Download the latest Backup System mod JAR
   - Place it in your server's mods/ folder
   - Start your Minecraft server

2. CONFIGURATION:
   - Server will create: config/autobackupmod/backup_config.json
   - Get Dropbox token from: https://www.dropbox.com/developers/apps
   - Edit the config file and replace "YOUR_DROPBOX_ACCESS_TOKEN"
   - Save the file

3. ACTIVATE:
   - In-game, run: /backup reload
   - Check status with: /backup status
   - Create manual backup: /backup now

CONFIGURATION OPTIONS:
======================

{
  "dropboxToken": "YOUR_DROPBOX_ACCESS_TOKEN",
  "backupIntervalMinutes": 30,
  "autoBackupEnabled": true,
  "worldFolders": ["world", "world_nether", "world_the_end"],
  "dropboxBackupFolder": "/backup",
  "deleteLocalZipAfterUpload": true,
  "maxBackupsToKeep": 10
}

COMMANDS:
=========
/backup now     - Create immediate backup
/backup status  - Show backup status and settings
/backup reload  - Reload configuration file

(All commands require OP level 2 permissions)

GETTING DROPBOX TOKEN:
======================
1. Go to https://www.dropbox.com/developers/apps
2. Click "Create app"
3. Choose "Scoped access" and "Full Dropbox"
4. Name your app (e.g., "Minecraft Backup")
5. In app settings, generate access token
6. Copy token to config file

TROUBLESHOOTING:
================

❌ "No valid Dropbox token configured"
   → Check token in config file, ensure it's not the placeholder text

❌ "Failed to validate Dropbox token"  
   → Verify internet connection and token permissions

❌ Backups not working
   → Check console logs for errors
   → Verify world folder names match actual folders
   → Ensure sufficient Dropbox storage space

❌ Large backup files
   → Consider customizing worldFolders to exclude unnecessary files
   → Check if world contains excessive data

PERFORMANCE NOTES:
==================
- Backups run in background threads to minimize server impact
- Large worlds will take longer to backup and upload
- Network speed affects upload time to Dropbox
- Automatic cleanup prevents storage buildup

SECURITY CONSIDERATIONS:
========================
- Keep Dropbox token secure and private
- Only grant OP permissions to trusted players
- Monitor Dropbox storage usage regularly
- Consider dedicated Dropbox account for backups

COMPATIBILITY:
==============
✅ Server-side mod only (clients don't need it)
✅ Compatible with vanilla Minecraft clients
✅ Works with most other Forge mods
✅ Supports custom world names and dimensions

SUPPORT:
========
For detailed setup instructions, see CONFIG_GUIDE.txt
For credits and acknowledgments, see CREDITS.txt
For version history, see changelog.txt

DEVELOPMENT INFO:
=================
Built with:
- Minecraft Forge MDK
- Dropbox Core SDK 5.4.0
- Jackson JSON Libraries 2.15.2
- Java 17 & Gradle build system

LICENSE:
========
This mod is released under the MIT License.
See LICENSE.txt for full license terms.

Not affiliated with Mojang Studios, Microsoft, or Dropbox Inc.
Minecraft is a trademark of Microsoft Corporation.

===============================================================================

Thank you for choosing Backup System for your Minecraft server backup needs!

For the latest updates and support, check the mod documentation.

Happy crafting! 🎮