fix(v5): add back example file for custom Klipper repository management

.gitignore

@@ -10,3 +10,4 @@ __pycache__
 *.code-workspace
 *.iml
 kiauh.cfg
+klipper_repos.txt

.vs/ProjectSettings.json

@@ -1,3 +0,0 @@
-{
-  "CurrentProjectSetting": null
-}

.vs/VSWorkspaceState.json

@@ -1,11 +0,0 @@
-{
-  "ExpandedNodes": [
-    "",
-    "\\kiauh",
-    "\\kiauh\\components\\droidklipp",
-    "\\kiauh\\core",
-    "\\kiauh\\core\\menus"
-  ],
-  "SelectedNode": "\\kiauh\\core\\menus\\main_menu.py",
-  "PreviewInSolutionExplorer": false
-}

README.md

@@ -71,14 +71,14 @@ sudo apt-get update && sudo apt-get install git -y
 Once git is installed, use the following command to download KIAUH into your home-directory:
 
 ```shell
-cd ~ && git clone https://github.com/CodeMasterCody3D/kiauhPlusDroidKlipp.git
+cd ~ && git clone https://github.com/dw-0/kiauh.git
 ```
 
 * **Step 3:** \
 Finally, start KIAUH by running the next command:
 
 ```shell
-./kiauhPlusDroidKlipp/kiauh.sh
+./kiauh/kiauh.sh
 ```
 
 * **Step 4:** \

kiauh/components/droidklipp/droidklipp.py

@@ -1,47 +0,0 @@
-import os
-import subprocess
-
-def install_droidklipp():
-    try:
-        print("Are you sure you want to install DroidKlipp? (Y/N)")
-        user_confirmation = input().strip().lower()
-
-        if user_confirmation != 'y':
-            print("DroidKlipp installation aborted.")
-            return
-
-        print("Installing DroidKlipp...")
-        subprocess.run(['sudo', 'apt', 'install', '-y', 'adb', 'tmux'], check=True)
-
-        # Define the DroidKlipp repository URL and directory
-        droidklipp_repo_url = "https://github.com/CodeMasterCody3D/DroidKlipp.git"
-        droidklipp_dir = os.path.expanduser('~/DroidKlipp')
-
-        # Check if DroidKlipp directory exists, if not create it
-        if not os.path.isdir(droidklipp_dir):
-            print("DroidKlipp folder not found, creating directory...")
-            os.makedirs(droidklipp_dir)
-
-        # Clone the repository if not already cloned
-        if not os.path.isdir(os.path.join(droidklipp_dir, '.git')):
-            print("Cloning the DroidKlipp repository...")
-            subprocess.run(['git', 'clone', droidklipp_repo_url, droidklipp_dir], check=True)
-        else:
-            print("DroidKlipp repository already exists.")
-
-        # Change to the DroidKlipp directory
-        os.chdir(droidklipp_dir)
-
-        # Set executable permissions for the installation script
-        subprocess.run(['sudo', 'chmod', '+x', 'droidklipp.sh'], check=True)
-
-        # Run the installation script
-        subprocess.run(['./droidklipp.sh'], check=True)
-
-        print("DroidKlipp installation complete!")
-    except subprocess.CalledProcessError as e:
-        print(f"Error during installation: {e}")
-    except Exception as e:
-        print(f"Unexpected error: {e}")
-
-# Ensure you call this with proper confirmation before installation

kiauh/core/menus/install_menu.py

@@ -11,7 +11,6 @@ from __future__ import annotations
 import textwrap
 from typing import Type
 
-from components.droidklipp.droidklipp import install_droidklipp
 from components.crowsnest.crowsnest import install_crowsnest
 from components.klipper.services.klipper_setup_service import KlipperSetupService
 from components.klipperscreen.klipperscreen import install_klipperscreen
@@ -42,6 +41,7 @@ class InstallMenu(BaseMenu):
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
+
         self.previous_menu = previous_menu if previous_menu is not None else MainMenu
 
     def set_options(self) -> None:
@@ -53,9 +53,7 @@ class InstallMenu(BaseMenu):
             "5": Option(method=self.install_mainsail_config),
             "6": Option(method=self.install_fluidd_config),
             "7": Option(method=self.install_klipperscreen),
-            "8": Option(method=self.install_droidklipp),  # Add DroidKlipp option
+            "8": Option(method=self.install_crowsnest),
-            "9": Option(method=self.install_crowsnest),
-            
         }
 
     def print_menu(self) -> None:
@@ -64,17 +62,15 @@ class InstallMenu(BaseMenu):
             ╟───────────────────────────┬───────────────────────────╢
             ║ Firmware & API:           │ Touchscreen GUI:          ║
             ║  1) [Klipper]             │  7) [KlipperScreen]       ║
-            ║  2) [Moonraker]           │  8) [DroidKlipp]          ║
+            ║  2) [Moonraker]           │                           ║
-            ║                           │                           ║
             ║                           │ Webcam Streamer:          ║
-            ║ Webinterface:             │  9) [Crowsnest]           ║
+            ║ Webinterface:             │  8) [Crowsnest]           ║
             ║  3) [Mainsail]            │                           ║
             ║  4) [Fluidd]              │                           ║
             ║                           │                           ║
             ║ Client-Config:            │                           ║
             ║  5) [Mainsail-Config]     │                           ║
             ║  6) [Fluidd-Config]       │                           ║
-            ║                           │                           ║ 
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
@@ -111,6 +107,3 @@ class InstallMenu(BaseMenu):
 
     def install_crowsnest(self, **kwargs) -> None:
         install_crowsnest()
-
-    def install_droidklipp(self, **kwargs) -> None:
-        install_droidklipp()

kiauh/core/menus/main_menu.py

@@ -12,7 +12,6 @@ import sys
 import textwrap
 from typing import Callable, Type
 
-from components.droidklipp.droidklipp import install_droidklipp
 from components.crowsnest.crowsnest import get_crowsnest_status
 from components.klipper.klipper_utils import get_klipper_status
 from components.klipperscreen.klipperscreen import get_klipperscreen_status

kiauh/utils/common.py

@@ -9,8 +9,6 @@
 
 from __future__ import annotations
 
-from components.droidklipp.droidklipp import install_droidklipp
-
 import re
 from datetime import datetime
 from pathlib import Path

klipper_repos.txt.example

@@ -0,0 +1,18 @@
+# This file acts as an example file.
+#
+# 1) Make a copy of this file and rename it to 'klipper_repos.txt'
+# 2) Add your custom Klipper repository to the bottom of that copy
+# 3) Save the file
+#
+# Back in KIAUH you can now go into -> [Settings] and use action '2' to set a different Klipper repository
+#
+# Make sure to always separate the repository and the branch with a ','.
+# <repository>,<branch> -> https://github.com/Klipper3d/klipper,master
+# If you omit a branch, it will always default to 'master'
+#
+# You are allowed to omit the 'https://github.com/' part of the repository URL
+# Down below are now a few examples of what is considered as valid:
+https://github.com/Klipper3d/klipper,master
+https://github.com/Klipper3d/klipper
+Klipper3d/klipper,master
+Klipper3d/klipper