Skip to content

shmakota/cata_git_mod_manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cataclysm Multitool

Python Windows Linux

A comprehensive utility program primarily created for Cataclysm: Bright Nights (CBN), providing essential tools for game management, mod installation, and backup handling.

image

🚀 Features

📦 Game Launcher

Allows the user to install the latest C:BN nightly or experimental release.

image

🔧 Content Manager

Add multiple GitHub repositories and update them all with a single click.

image

Key Features:

  • Multi-profile support – Easily switch between different mod setups
  • Modpack & Individual Mod Support – Automatically scans nested folders for modinfo.json, ensuring compatibility with complex mod structures. The user can also define a custom subdirectory for the mod or custom install folder name
  • Quick Explorer Access – Allows quick access to the Mod Explorer, or your system's file explorer
  • Auto-Update – Automatically checks for and installs tool updates from GitHub while preserving your settings and mods

🔍 Mod Explorer

Directly view and quickly sort through every JSON entry and Lua scripts a mod adds to the game.

image

Features:

  • Advanced search with inclusion/exclusion filters
  • Filter by ID, Name, Description, or Type
  • Export filtered results to JSON
  • Display balance options, languages, and special entry types

💾 Backup Manager

Name, create and load backups at any time.

image

Features:

  • Create timestamped backups with custom names
  • View backup metadata including mod lists
  • Restore from backups or manage current world saves
  • Browse backup archives with detailed information

📋 Requirements

  • Python 3.x – Python 3.6 or higher recommended
  • All other dependencies are automatically set up by the install script

🖥️ Compatibility

Currently optimized for Cataclysm: Bright Nights with a dedicated launcher/installer. Most tools should work with DDA installations as well.

Supported Platforms:

  • ✅ Windows
  • ✅ Linux

🔧 Installation

  1. Clone the repository:

    git clone https://github.com/shmakota/cata_git_mod_manager.git
    cd cata_git_mod_manager
  2. Run the install/launch script:

    • Linux/Mac: ./run.sh
    • Windows: run.bat
  3. Follow the Usage guide below to set up your profile and install directory.


📖 Usage

  1. Launch the Game – Use the Game Launcher to download the latest version of Cataclysm: Bright Nights
  2. Create a Mod Profile – Set up your mod profile, or download an existing one from the Discord
  3. Add Mod Repositories – Input GitHub URLs pointing to mod or modpack repositories in the Content Manager
  4. Set Install Directory – Configure the Content Manager's profile install directory to point to your game's userdata folder
  5. One-Click Update – The tool pulls the latest versions of all mods from the defined GitHub sources with a single click
  6. Automatic Scanning – The tool automatically locates all valid mods via their modinfo.json, even in nested subfolders. You can also define specific subdirectories if needed

🔗 Community & Links


📝 License

This project is open source. Please refer to the repository for license information.


🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.


Made with ❤️ for the Cataclysm: Bright Nights community

About

A multitool for Cataclysm: Bright Nights that includes scripts for backups, mod updates, mod explorer, and a game updater/launcher.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages