Skip to content

heyfinal/Clone-the-repository

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎮 Bambu Studio Integration

This script automatically configures Bambu Studio to work with your rooted K1 printer:

  • Auto-Detection: Finds your Bambu Studio installation across Windows, macOS, and Linux
  • OctoPrint Compatibility: Sets up the connection using OctoPrint API compatibility
  • Zero Config: Adds your printer to Bambu Studio with the correct settings
  • Backup: Creates backups of your existing configurations before making changes

After installation:

  1. Restart Bambu Studio if it's running
  2. Go to the printer selection dropdown
  3. Select "Creality K1 (Klipper)"
  4. Upload and print directly from Bambu Studio to your K1

Supported Features

  • Direct printing from Bambu Studio to your K1 printer
  • Print monitoring and control
  • Seamless workflow with Bambu's slicing capabilities
  • Upload G-code files directly to the printer# 🚀 K1 Auto-Root
██╗  ██╗ ██╗     █████╗ ██╗   ██╗████████╗ ██████╗       ██████╗  ██████╗  ██████╗ ████████╗
██║ ██╔╝███║    ██╔══██╗██║   ██║╚══██╔══╝██╔═══██╗      ██╔══██╗██╔═══██╗██╔═══██╗╚══██╔══╝
█████╔╝  ╚██║    ███████║██║   ██║   ██║   ██║   ██║█████╗██████╔╝██║   ██║██║   ██║   ██║   
██╔═██╗   ██║    ██╔══██║██║   ██║   ██║   ██║   ██║╚════╝██╔══██╗██║   ██║██║   ██║   ██║   
██║  ██╗  ██║    ██║  ██║╚██████╔╝   ██║   ╚██████╔╝      ██║  ██║╚██████╔╝╚██████╔╝   ██║   
╚═╝  ╚═╝  ╚═╝    ╚═╝  ╚═╝ ╚═════╝    ╚═╝    ╚═════╝       ╚═╝  ╚═╝ ╚═════╝  ╚═════╝    ╚═╝   

Creality K1 Compatible Creality K1 Max Compatible Creality K1C Compatible

Automated script for rooting your Creality K1 series printers and integrating with Bambu Studio

FeaturesInstallationUsageConfigurationFAQContributingAcknowledgments

✨ Features

  • 🔍 Auto-Detection: Automatically finds Creality K1 printers on your network
  • 🔄 Zero Config: Works with minimal user interaction - just run and go!
  • 🎮 Bambu Studio: Automatically configures Bambu Studio with OctoPrint integration
  • 🎵 Fun Experience: Plays epic background music while installing
  • 🔐 Full Root Access: Gives you complete control over your printer
  • 🌐 Web Interfaces: Installs Fluidd and/or Mainsail for remote control
  • 🌍 Remote Access: Sets up OctoEverywhere for accessing your printer from anywhere
  • 📊 Enhanced Features: Installs KAMP, input shaper fix, timelapse, and other improvements

📋 Prerequisites

  • Linux, macOS, or Windows with bash support
  • Network connection to your Creality K1 printer
  • Creality K1, K1C, or K1 Max printer with default firmware
  • Git (optional, will be installed if missing)
  • SSH client

💾 Installation

Quick Start

# Clone the repository
git clone https://github.com/heyfinal/k1-auto-root.git

# Navigate to the directory
cd k1-auto-root

# Make the script executable
chmod +x k1-auto-root.sh

# Run the script
./k1-auto-root.sh

One-Liner (for the brave)

curl -sSL https://raw.githubusercontent.com/heyfinal/k1-auto-root/main/k1-auto-root.sh | bash

🚀 Usage

  1. Run the script
  2. The script will automatically detect Creality K1 printers on your network
  3. Confirm the installation to begin the automated rooting process
  4. Wait for the installation to complete (approximately 10-15 minutes)
  5. Restart your printer when prompted
  6. Access your printer's new web interface at http://PRINTER_IP:4408 (for Fluidd)

⚙️ Configuration

The script uses sensible defaults designed for most users. If you want to customize your installation, you can edit the following variables at the top of the script:

# Default configuration
DEFAULT_PASSWORD="creality_2023"  # Default SSH password for K1 printers
INSTALL_FLUIDD=true               # Install Fluidd web interface
INSTALL_MAINSAIL=false            # Install Mainsail web interface
INSTALL_KAMP=true                 # Install Klipper Adaptive Meshing & Purging
INSTALL_INPUT_SHAPER=true         # Install input shaper fix for better print quality
INSTALL_ENTWARE=true              # Install Entware package manager
INSTALL_KLIPPER_SHELL=true        # Install Klipper Shell Command
INSTALL_TIMELAPSE=true            # Install timelapse functionality
INSTALL_BUZZER=false              # Install buzzer support (for audio alerts)
INSTALL_REMOTE_ACCESS=true        # Install remote access solution
REMOTE_ACCESS_CHOICE="octoeverywhere" # OctoEverywhere or Obico
PLAY_MUSIC=true                   # Play background music during installation
CONFIGURE_BAMBU_STUDIO=true       # Automatically configure Bambu Studio

📱 Accessing Your Printer

After installation, you can access your printer using:

  • Fluidd: http://PRINTER_IP:4408
  • Mainsail: http://PRINTER_IP:4409 (if enabled)
  • OctoEverywhere: Follow setup instructions after installation to access your printer from anywhere

📷 Screenshots

Add your screenshots here after completing the project

❓ FAQ

Will this void my warranty? Yes, rooting your printer will void your warranty with Creality. Proceed at your own risk.
Is it reversible? Yes, you can restore your printer to factory settings by following Creality's firmware update process.
What if the script can't find my printer? You can manually enter your printer's IP address when prompted.
Will this work with non-K1 printers? No, this script is specifically designed for Creality K1, K1C, and K1 Max printers.
Do I need Bambu Studio? No, but it's highly recommended for the best experience. Bambu Studio provides powerful slicing features and the script automatically configures it to work with your rooted printer via OctoPrint compatibility. The integration lets you send prints directly from Bambu Studio to your K1/K1C/K1 Max with full control.

⚠️ Disclaimer

This script modifies your printer's software. While we've tested it thoroughly, we are not responsible for any damage to your device. Use at your own risk and make sure you understand what this script does before running it.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • heyfinal - Creator of this auto-root script
  • Guilouz - Creator of the original Creality Helper Script
  • Creality K1 Community - For testing and feedback

Built with ❤️ for the 3D printing community

Releases

No releases published

Packages

 
 
 

Contributors

Languages