### Manual HyDE Installation: Start and Enable System Services

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Execute the install script with the `-s` flag to start and enable system services for HyDE.

```shell
./install.sh -s
```

--------------------------------

### Commit Message: Project Initialization

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'init' type for the initial setup of a new repository or project. This example initializes the project.

```markdown
init: Initialize project
```

--------------------------------

### Install HyDE with Install Script

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

Execute the install script to set up the HyDE project. Use the '-r' flag to only restore dotfiles.

```bash
./install.sh
```

```bash
./install.sh -r
```

--------------------------------

### Install Script Usage

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

This displays the available options for the install script. Use these flags to customize the installation or perform specific actions like testing or restoring configurations.

```bash
Usage: ./install.sh [options]
         i : [i]nstall hyprland without configs
         d : install hyprland [d]efaults without configs --noconfirm
         r : [r]estore config files
         s : enable system [s]ervices
         n : ignore/[n]o [n]vidia actions
         h : re-evaluate S[h]ell
         m : no the[m]e reinstallations
         t : [t]est run without executing (-irst to dry run all)
```

--------------------------------

### Manual HyDE Installation: Skip Theme Installation

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Use the `-m` flag to skip the theme installation process during the HyDE setup.

```shell
./install.sh -m
```

--------------------------------

### Execute HyDE Installation Script

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Runs the main installation script for HyDE after cloning the repository and navigating to the Scripts directory. This script handles the full setup of the HyDE environment.

```shell
./install.sh
```

--------------------------------

### Restore Dotfiles Example

Source: https://github.com/hyde-project/hyde/wiki/installation_management/manage_dots

Example of restoring dotfiles using the restore_cfg.sh script with a local configuration file.

```shell
cd ~/HyDE/Scripts
./restore_cfg.sh ./restore_cfg.psv
```

--------------------------------

### Manual HyDE Installation: Minimal Install with Custom Packages

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Perform a minimal Hyprland installation with custom packages, excluding configurations, by using the `-i` flag and providing a custom applications list.

```shell
./install.sh -i custom_apps.lst
```

--------------------------------

### Automated HyDE Installation with Custom Apps

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Extend the automated installation by including a list of custom applications. Place your desired applications in `Scripts/custom_apps.lst` and pass the file to the install script.

```shell
./install.sh custom_apps.lst
```

--------------------------------

### Manual HyDE Installation: Minimal Install with Confirmation Skip

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Perform a minimal Hyprland installation without configurations, automatically confirming prompts using the `-d` flag.

```shell
./install.sh -d
```

--------------------------------

### Manual HyDE Installation: Minimal Install

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Execute the install script with the `-i` flag for a minimal Hyprland installation without any configurations.

```shell
./install.sh -i
```

--------------------------------

### Install HyDE Project Dependencies and Clone Repository

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Installs necessary packages like git and base-devel, then clones the HyDE project repository. This is the initial step for setting up HyDE on an Arch Linux system.

```shell
sudo pacman -S --needed git base-devel
git clone --depth 1 https://github.com/HyDE-Project/HyDE ~/HyDE
cd ~/HyDE/Scripts
```

--------------------------------

### Install HyDE on Arch Linux

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Download the hydevm script, make it executable, and run it to install HyDE. The script will auto-detect and install missing packages.

```bash
# Download and run (will auto-detect missing packages)
curl -L https://raw.githubusercontent.com/HyDE-Project/HyDE/main/Scripts/hydevm/hydevm.sh -o hydevm
chmod +x hydevm
./hydevm
```

--------------------------------

### Manual HyDE Installation: Skip NVIDIA Installation

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Execute the install script with the `-n` flag to skip the NVIDIA driver installation.

```shell
./install.sh -n
```

--------------------------------

### Import Custom Themes

Source: https://github.com/hyde-project/hyde/wiki/installation_management/manage_dots

Installs themes using a custom themepatcher list file. Provide the path to your custom list file.

```shell
./restore_thm.sh /path/to/my_themes.lst
```

--------------------------------

### Manual HyDE Installation: Dry Run All Options

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Perform a comprehensive test run of all installation options without making any changes by using the `-irst` flags.

```shell
./install.sh -irst
```

--------------------------------

### Install Additional Apps with HyDE

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Add other applications to `Scripts/pkg_user.lst` and pass the file as a parameter to install them alongside HyDE. Refer to `Scripts/pkg_extra.lst` for a list of extra packages.

```shell
./install.sh pkg_user.lst
```

--------------------------------

### Run HyDE with nixGL on Non-NixOS

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Install nixGL and then run HyDE to improve graphics support on non-NixOS systems. Ensure nixGL is installed before executing the HyDE command.

```bash
# Install nixGL first, then run HydeVM
nixGL nix run github:HyDE-Project/HyDE
```

--------------------------------

### Automated HyDE Installation

Source: https://github.com/hyde-project/hyde/wiki/installation

Installs HyDE using the automated script. Ensure git and base-devel are installed first. This script clones the repository and executes the main installation process.

```shell
pacman -S --needed git base-devel
git clone --depth 1 https://github.com/HyDE-Project/HyDE ~/HyDE
cd ~/HyDE/Scripts
./install.sh
```

--------------------------------

### HyDE Installation Script Modes

Source: https://github.com/hyde-project/hyde/wiki/installation

Executes the HyDE installation script with various modes for different installation types. Options include default full installation, minimal installations with custom packages, restoring configurations, enabling services, and dry runs. Never run the script with sudo or as root.

```shell
./install.sh
```

```shell
./install.sh pkg_user.lst
```

```shell
./install.sh -i pkg_user.lst
```

```shell
./install.sh -i
```

```shell
./install.sh -d
```

```shell
./install.sh -r
```

```shell
./install.sh -s
```

```shell
./install.sh -t
```

```shell
./install.sh -m
```

```shell
./install.sh -n
```

```shell
./install.sh -irst
```

```shell
./install.sh -irst
```

--------------------------------

### Clone HyDE Repository for Manual Installation

Source: https://github.com/hyde-project/hyde/wiki/installation

Clones the HyDE repository and navigates to the scripts directory for manual or granular installation. Ensure git is installed. The user needs write and execute permissions for the cloned directory.

```shell
pacman -Sy git
git clone --depth 1 https://github.com/prasanthrangan/hyprdots ~/HyDE
cd ~/HyDE/Scripts
```

--------------------------------

### Check Dependencies with hydevm

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Run this command to check if all necessary dependencies for hydevm are installed and configured correctly.

```bash
hydevm --check-deps
```

--------------------------------

### NixOS Configuration for AMD GPU

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Configure NixOS for AMD GPUs, enabling hardware graphics, installing the AMD Vulkan driver, and ensuring KVM modules are loaded. This setup is recommended for AMD hardware.

```nix
{
  hardware.graphics.enable = true;
  hardware.graphics.extraPackages = with pkgs; [ amdvlk ];
  boot.kernelModules = [ "kvm-intel" ]; # or "kvm-amd" for AMD CPUs
  virtualisation.libvirtd.enable = true;
}
```

--------------------------------

### Install HyDE on NixOS or Nix

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Use the nix run command with the HyDE repository to execute the project. This method utilizes flakes for managing dependencies.

```bash
# Using flakes from HyDE repository
nix run github:HyDE-Project/HyDE
```

--------------------------------

### Manual HyDE Installation: Test Run

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Perform a test run of the installation script without executing any changes using the `-t` flag. This allows you to preview actions before applying them.

```shell
./install.sh -t
```

--------------------------------

### Sample PSV File for Hyde Configuration

Source: https://github.com/hyde-project/hyde/wiki/installation_management/restore

A comprehensive example of a PSV file demonstrating various flags (P, S, O) and configurations for different applications like Hyde core files, editors, terminals, and shells.

```shell
 Hyde core files 
P|${HOME}/.config/hyde|config.toml|hyprland
P|${HOME}/.config/hypr|hyde.conf animations.conf windowrules.conf keybindings.conf userprefs.conf monitors.conf|hyprland
P|${HOME}/.config/hypr|nvidia.conf|hyprland nvidia-utils
P|${HOME}/.config/hypr/themes|theme.conf wallbash.conf colors.conf|hyprland
P|${HOME}/.local/state|hyde|hyprland

S|${HOME}/.config/hypr|hyprland.conf|hyprland
S|${HOME}/.local|bin|hyprland
S|${HOME}/.config|gtk-3.0|nwg-look
S|${HOME}/.config|nwg-look|nwg-look
S|${HOME}/.config|xsettingsd|nwg-look
S|${HOME}|.gtkrc-2.0|nwg-look
S|${HOME}/.config|Kvantum|kvantum
S|${HOME}/.config|qt5ct|qt5ct
S|${HOME}/.config|qt6ct|qt6ct
S|${HOME}/.config/hyde|wallbash|hyprland
S|${HOME}/.config/hypr|animations|hyprland

O|${HOME}/.local/share|hyde|hyprland
O|${HOME}/.local/lib|hyde|hyprland

 Editor 
P|${HOME}/.config/Code - OSS/User|settings.json|code
P|${HOME}/.config/Code/User|settings.json|visual-studio-code-bin
P|${HOME}/.config/VSCodium/User|settings.json|vscodium-bin

 Bar 
P|${HOME}/.config/waybar|config.ctl|waybar
S|${HOME}/.config/waybar|modules config.jsonc theme.css style.css|waybar

 Terminal 
P|${HOME}/.config|lsd|lsd
S|${HOME}/.config|fastfetch|fastfetch
S|${HOME}/.config/kitty|hyde.conf theme.conf|kitty
P|${HOME}/.config/kitty|kitty.conf|kitty

 Shell 
P|${HOME}/.config|fish|fish
P|${HOME}|.zshrc .hyde.zshrc .p10k.zsh|zsh zsh-theme-powerlevel10k pokego-bin
S|${HOME}|.zshenv|zsh zsh-theme-powerlevel10k

 File Explorer 
P|${HOME}/.local/state|dolphinstaterc|dolphin
P|${HOME}/.config|baloofilerc|dolphin
S|${HOME}/.config/menus|applications.menu|dolphin
S|${HOME}/.config|dolphinrc|dolphin
S|${HOME}/.config|kdeglobals|dolphin
S|${HOME}/.local/share/kio/servicemenus|hydewallpaper.desktop|dolphin
S|${HOME}/.local/share/kxmlgui5|dolphin|dolphin
S|${HOME}/.local/share|dolphin|dolphin

 Input 
P|${HOME}/.config|libinput-gestures.conf|libinput-gestures

 Wayland 
P|${HOME}/.config|spotify-flags.conf|spotify
P|${HOME}/.config|code-flags.conf|code
P|${HOME}/.config|code-flags.conf|visual-studio-code-bin
P|${HOME}/.config|vscodium-flags.conf|vscodium-bin
P|${HOME}/.config|electron-flags.conf|electron

 Notifications 
S|${HOME}/.config|dunst|dunst

 Gaming 
S|${HOME}/.config|MangoHud|mangohud

 Launcher 
S|${HOME}/.config|rofi|rofi
S|${HOME}/.config|wlogout|wlogout

 Lock Screen 
S|${HOME}/.config|swaylock|swaylock-effects
P|${HOME}/.config/hypr|hyprlock.conf|hyprlock
S|${HOME}/.config/hypr|hyprlock|hyprlock

 Idle daemon 
P|${HOME}/.config/hypr|hypridle.conf|hypridle
```

--------------------------------

### Manual HyDE Installation: Restore Config Files

Source: https://github.com/hyde-project/hyde/wiki/installation_management/installation

Use the `-r` flag to restore HyDE configuration files.

```shell
./install.sh -r
```

--------------------------------

### Commit Message: Deployment Process Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'deploy' type for changes affecting the deployment process. This example updates deployment scripts.

```markdown
deploy: Update deployment scripts
```

--------------------------------

### Commit Message: Bug Fix

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'fix' type to indicate that a bug or issue has been resolved. This example addresses a crash on startup.

```markdown
fix: Fix bug causing application to crash on startup
```

--------------------------------

### Commit Message: Configuration File Change

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'config' type for changes made to project configuration files. This example updates configuration files.

```markdown
config: Update configuration files
```

--------------------------------

### Commit Message: File Rename

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'rename' type for changing the names of files or directories. This example renames files.

```markdown
rename: Rename files
```

--------------------------------

### Commit Message: Build System Change

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'build' type for changes related to the build system or project dependencies. This example updates dependencies.

```markdown
build: Update dependencies
```

--------------------------------

### Commit Message: Feature Addition

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'feat' type for adding new features. This example shows how to announce multi-image upload support.

```markdown
feat: Add multi-image upload support
```

--------------------------------

### Commit Message: Security Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'security' type for addressing security vulnerabilities. This example involves updating dependencies to patch security issues.

```markdown
security: Update dependencies to address security issues
```

--------------------------------

### Commit Message: Performance Improvement

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'perf' type to indicate performance enhancements. This example focuses on improving image processing performance.

```markdown
perf: Improve performance of image processing
```

--------------------------------

### Commit Message: Code Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'update' type for general updates to code, dependencies, or other project components. This example updates code.

```markdown
update: Update code
```

--------------------------------

### Commit Message: Style Changes

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'style' type for cosmetic or formatting changes that do not affect code behavior. This example updates colors and formatting.

```markdown
style: Update colors and formatting
```

--------------------------------

### Commit Message: File Removal

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'remove' type to signify the deletion of files or directories from the project. This example removes files.

```markdown
remove: Remove files
```

--------------------------------

### Commit Message: Test Addition

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'test' type when adding or modifying tests for the project. This example adds tests for a new feature.

```markdown
test: Add tests for new feature
```

--------------------------------

### Commit Message: Documentation Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'docs' type when updating project documentation. This example shows updating API endpoint documentation.

```markdown
docs: Update documentation for API endpoints
```

--------------------------------

### NixOS Configuration for Intel iGPU

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Configure NixOS for Intel integrated graphics. This includes enabling hardware acceleration and installing the Intel media driver. Recommended for systems with Intel CPUs.

```nix
{
  hardware.graphics.enable = true;
  hardware.graphics.extraPackages = with pkgs; [ intel-media-driver ];
  boot.kernelModules = [ "kvm-intel" ];
  virtualisation.libvirtd.enable = true;
}
```

--------------------------------

### Commit Message: File Movement

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'move' type to indicate the relocation of files or directories within the project. This example shows moving files to a new directory.

```markdown
move: Move files to new directory
```

--------------------------------

### Commit Message: CI Configuration Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'ci' type for modifications to the continuous integration (CI) system configuration. This example updates CI configuration.

```markdown
ci: Update CI configuration
```

--------------------------------

### Commit Message: Revert Commit

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'revert' type to undo a previous commit. This example shows reverting a commit that added a feature.

```markdown
revert: Revert "Add feature"
```

--------------------------------

### Commit Message: Chore Update

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'chore' type for maintenance tasks that don't fit other categories, such as dependency updates or build system configuration. This example updates dependencies.

```markdown
chore: Update dependencies
```

--------------------------------

### Commit Message: Branch Merge

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'merge' type to denote the merging of branches. This example shows merging a feature branch into the develop branch.

```markdown
merge: Merge branch 'feature/branch-name' into develop
```

--------------------------------

### Commit Message: Code Refactoring

Source: https://github.com/hyde-project/hyde/blob/master/COMMIT_MESSAGE_GUIDELINES.md

Use the 'refactor' type for code changes that improve quality or maintainability without altering functionality. This example shows removing unused code.

```markdown
refactor: Remove unused code
```

--------------------------------

### Configure SwayOSD Service

Source: https://github.com/hyde-project/hyde/wiki/Extended

Add these lines to your configuration to enable the SwayOSD service and its backend for keyboard input. Requires `pkexec` for the backend.

```shell
exec-once = swayosd-server # enable swayosd service
exec-once = $(pkexec swayosd-libinput-backend) # swayosd service for keyboard input (requires to be run in a subshell)
```

--------------------------------

### Download and Run HydeVM on Arch Linux

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Download the hydevm script, make it executable, and run it to set up the HyDE VM. The script auto-detects and prompts for missing packages.

```bash
curl -L https://raw.githubusercontent.com/HyDE-Project/HyDE/main/Scripts/hydevm/hydevm.sh -o hydevm
chmod +x hydevm
./hydevm
```

--------------------------------

### Verify VM Virtualization and KVM Support

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Check if your CPU supports virtualization and if the KVM modules are loaded. These are essential steps to ensure your system is ready for running virtual machines.

```bash
# 1. Check CPU virtualization support
egrep -c '(vmx|svm)' /proc/cpuinfo    # Should return > 0

# 2. Check KVM modules
lsmod | grep kvm                       # Should show kvm and kvm_intel/kvm_amd

# 3. Check OpenGL support
glxinfo | grep "OpenGL"               # Should show your GPU and OpenGL 3.3+
```

--------------------------------

### Customize HydeVM Resources with Environment Variables

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Control VM resources like memory and CPUs, or pass custom QEMU arguments using environment variables.

```bash
# Customize VM resources
VM_MEMORY=8G VM_CPUS=4 hydevm

# Set extra QEMU arguments
VM_EXTRA_ARGS="-display vnc=:1" hydevm

# Override QEMU command entirely, provided $VM_DISK will be substituted with the actual disk image
VM_QEMU_OVERRIDE="qemu-system-x86_64 -m 4G -smp 2 -enable-kvm -drive file=\$VM_DISK,format=qcow2,if=virtio -device virtio-vga -display gtk" hydevm
```

--------------------------------

### Check KVM Access

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Verify that your user has the necessary permissions to access KVM devices. This is crucial for performance in virtualized environments.

```bash
# Check KVM access
ls -la /dev/kvm
# Should show your user has access (via kvm group)
```

--------------------------------

### Clean HyDE Cache

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Remove all cached data for HyDE. Use this command to start with a clean slate if you encounter issues.

```bash
hydevm --clean  # Remove all cached data from $XDG_CACHE_HOME/hydevm/
```

--------------------------------

### Enable Software Rendering for VM

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

If you experience graphics issues, try disabling GL acceleration by setting VM_EXTRA_ARGS. This forces software rendering.

```bash
VM_EXTRA_ARGS="-device VGA -display gtk,gl=off" hydevm
```

--------------------------------

### Clone Repository

Source: https://github.com/hyde-project/hyde/blob/master/CONTRIBUTING.md

Clone your forked repository to your local machine to begin making changes.

```bash
git clone https://github.com/HyDE-Project/HyDE.git
```

--------------------------------

### Enable Libvirtd on NixOS

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Enable the libvirtd service in your NixOS configuration. This is a prerequisite for managing virtual machines.

```nix
virtualisation.libvirtd.enable = true;
```

--------------------------------

### Update and Checkout Dev Branch

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

If you already have the repository, use these commands to fetch the latest changes from the 'dev' branch and switch to it.

```bash
git fetch origin dev
git checkout dev
git pull origin dev
```

--------------------------------

### HydeVM Basic Commands

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Common commands for running HyDE in the VM, managing branches, persistence, and cleaning up cached data.

```bash
# Run master branch
hydevm

# Run specific branch or commit
hydevm feature-branch
hydevm abc123def

# Run with persistence (changes will be saved)
hydevm --persist
hydevm --persist dev-branch

# List cached snapshots
hydevm --list

# Clean all cached data
hydevm --clean

# Check dependencies
hydevm --check-deps

# Install dependencies (Arch only)
hydevm --install-deps
```

--------------------------------

### Verify VirtIO GPU and OpenGL Support

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Commands to verify VirtIO GPU and OpenGL acceleration are working correctly. These checks are crucial after configuring your system for VM graphics.

```bash
# Test OpenGL
glxinfo | grep "OpenGL renderer"

# Verify VirtIO support
modprobe virtio_gpu
lsmod | grep virtio

# Default QEMU args should work perfectly
hydevm
```

--------------------------------

### Run HydeVM on NixOS

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Execute HydeVM on NixOS using Nix commands. This can be done directly from the HyDE repository or from a local clone.

```bash
nix run github:HyDE-Project/HyDE
```

```bash
nix run
```

--------------------------------

### Clone HyDE Repository

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

Use this command to clone the HyDE repository for the first time. This is the initial step before switching to specific branches.

```bash
git clone https://github.com/HyDE-Project/HyDE.git
cd HyDE
```

--------------------------------

### Update and Checkout RC Branch

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

If you already have the repository, use these commands to fetch the latest changes from the 'rc' branch and switch to it.

```bash
git fetch origin rc
git checkout rc
git pull origin rc
```

--------------------------------

### Launch HyDE Game Launcher

Source: https://github.com/hyde-project/hyde/blob/master/KEYBINDINGS.md

Add this line to your userprefs.conf to bind a custom key to launch the HyDE Game Launcher. The default binding is SUPER + SPACE.

```ini
bind = $mainMod, SPACE, exec, $HOME/.local/lib/hyde/gamelauncher.sh
```

--------------------------------

### Troubleshoot VM Graphics with Software Rendering

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Use this command to force software rendering for graphics in the VM, which can resolve display issues. It specifies the virtio-vga device and disables GL acceleration.

```bash
VM_EXTRA_ARGS="-device virtio-vga -display gtk,gl=off" hydevm
```

--------------------------------

### Include HyDE Boilerplate Configuration

Source: https://github.com/hyde-project/hyde/wiki/configuration/hyprland

This line should be placed at the top of your `~/.config/hypr/hyprland.conf` to source HyDE's default settings.

```ini
source = ~/.local/share/hyde/hyprland.conf
```

--------------------------------

### Checkout Dev Branch

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

Switch to the 'dev' branch to test the latest features and bug fixes before they are merged into the release candidate.

```bash
git checkout dev
```

--------------------------------

### Add User to KVM Group on Arch Linux

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

If KVM is not available, add the current user to the 'kvm' group on Arch Linux to grant necessary permissions.

```bash
# Arch Linux
sudo usermod -a -G kvm $USER
```

--------------------------------

### Create New Branch

Source: https://github.com/hyde-project/hyde/blob/master/CONTRIBUTING.md

Create a new branch for your changes to keep them isolated. Replace 'your-branch-name' with a descriptive name for your branch.

```bash
git checkout -b your-branch-name
```

--------------------------------

### Run HyDE with Software Rendering

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Force HyDE to use software rendering by setting specific environment variables. This is a fallback option if hardware acceleration is not working or causing issues.

```bash
# Force software rendering
VM_EXTRA_ARGS="-device VGA -display gtk,gl=off" hydevm
```

--------------------------------

### Update Dotfiles Only

Source: https://github.com/hyde-project/hyde/wiki/installation_management/manage_dots

Restores dotfiles from the repository to your $HOME. The first argument is the path to the restore configuration file, and the second is an optional path to the HyDE clone.

```shell
./restore_cfg.sh </path/to/file.psv > <optional /path/to/hyde/clone`
```

--------------------------------

### Contributing to NVIDIA DKMS Drivers

Source: https://github.com/hyde-project/hyde/wiki/nvidia

Guidelines for contributing new driver versions and hardware support. Ensure the filename format is `nvidia-<version>-dkms` and the file contains the NVIDIA table in the specified format.

```markdown
| NVE0 | NVE4 | GK104 | Description |
|------|------|-------|-------------|
| NV50 | NV50 | G80 | GeForce 8800 (GTS, GTX, Ultra), Quadro FX (4600 (SDI), 5600) |
```

--------------------------------

### NixOS Configuration for NVIDIA Proprietary Drivers

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Set up NixOS with NVIDIA's proprietary drivers for VM acceleration. This includes enabling hardware graphics, specifying the NVIDIA driver package, and enabling modesetting. Note that proprietary drivers may cause issues.

```nix
{
  hardware.graphics.enable = true;
  hardware.nvidia.package = config.boot.kernelPackages.nvidiaPackages.stable;
  hardware.nvidia.modesetting.enable = true;
  services.xserver.videoDrivers = [ "nvidia" ];
  boot.kernelModules = [ "kvm-intel" ]; # or "kvm-amd"
  virtualisation.libvirtd.enable = true;
}
```

--------------------------------

### Generate NVIDIA Table Script

Source: https://github.com/hyde-project/hyde/wiki/nvidia

Command to generate the NVIDIA-TABLE.md file using a Python script. Ensure you are in the project's root directory.

```bash
python ./gen_table.py
```

--------------------------------

### Checkout RC Branch

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

Switch to the 'rc' branch for final testing and bug fixes before a new release. This branch should only contain stabilization changes.

```bash
git checkout rc
```

--------------------------------

### Update HyDE Project

Source: https://github.com/hyde-project/hyde/blob/master/README.md

Update HyDE by fetching the latest changes from the master branch and resetting the local repository to match. The `./install.sh -r` command is then used to restore configurations. Local changes will be discarded.

```shell
cd ~/HyDE/Scripts
git fetch --update-shallow --depth 1 origin master
git reset --hard origin/master
./install.sh -r
```

--------------------------------

### Override HyDE QEMU Command

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Completely override the default QEMU command arguments used by HyDE. This provides full control over VM settings, including memory, CPU, disk, and display configurations. The script will substitute $VM_DISK with the appropriate disk image.

```bash
# Override entire QEMU command
VM_QEMU_OVERRIDE="qemu-system-x86_64 -m 4G -smp 2 -enable-kvm -cpu host -machine q35 -device intel-iommu -drive file=\$VM_DISK,format=qcow2,if=virtio -device virtio-vga-gl -display gtk,gl=on,grab-on-hover=on -usb -device usb-tablet -device ich9-intel-hda -device hda-output -vga none" hydevm

# The script will substitute $VM_DISK with the appropriate disk image
```

--------------------------------

### Run HyDE with NVIDIA GPU - Disable GL Acceleration

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

If experiencing graphics issues with NVIDIA proprietary drivers, try disabling GL acceleration by setting specific environment variables. This forces the VM to use a different display method.

```bash
# If graphics issues occur, disable GL acceleration
VM_EXTRA_ARGS="-device virtio-vga -display gtk,gl=off" hydevm
```

--------------------------------

### NixOS Configuration for Nouveau Drivers

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

Configure NixOS to use the open-source Nouveau drivers for NVIDIA GPUs. This is an alternative if proprietary drivers cause problems. It enables hardware graphics and specifies the Nouveau video driver.

```nix
{
  hardware.graphics.enable = true;
  services.xserver.videoDrivers = [ "nouveau" ];
  boot.kernelModules = [ "kvm-intel" ]; # or "kvm-amd"
  virtualisation.libvirtd.enable = true;
}
```

--------------------------------

### Automated HyDE Update

Source: https://github.com/hyde-project/hyde/wiki/installation_management/manage_dots

Use this command to pull the latest changes and restore configurations. Configurations may be overwritten but are backed up.

```shell
cd ~/HyDE/Scripts
git pull origin master
./install.sh -r
```

--------------------------------

### Commit Changes

Source: https://github.com/hyde-project/hyde/blob/master/CONTRIBUTING.md

Commit your changes with a descriptive message following the project's commit message guidelines. The 'feat:' prefix indicates a new feature.

```bash
git commit -m "feat: add a new feature"
```

--------------------------------

### PSV File Structure

Source: https://github.com/hyde-project/hyde/wiki/installation_management/restore

Defines the 4-column structure of the Pipe Separated Values (PSV) file used for configuration restoration. Each column represents a specific aspect of the configuration item.

```shell
flag|path|target|dependency
```

--------------------------------

### Automated HyDE Update

Source: https://github.com/hyde-project/hyde/wiki/manage_dots

Use these commands to pull the latest changes and restore configurations for an automated update.

```shell
cd ~/HyDE/Scripts
git pull
./install.sh -r
```

--------------------------------

### Update Master Branch

Source: https://github.com/hyde-project/hyde/blob/master/TESTING.md

Ensure your local 'master' branch is up-to-date before switching to other branches. This is a prerequisite for fetching the latest changes.

```bash
git checkout master
git pull
```

--------------------------------

### Push Changes

Source: https://github.com/hyde-project/hyde/blob/master/CONTRIBUTING.md

Push your committed changes to your forked repository on GitHub. Ensure you replace 'your-branch-name' with the actual name of your branch.

```bash
git push origin your-branch-name
```

--------------------------------

### Add Contributor to HyDE Project

Source: https://github.com/hyde-project/hyde/blob/master/CONTRIBUTORS.md

Use this format to add your name to the contributor list. Ensure you follow the specified structure for GitHub usernames and quotes.

```markdown
- [@your-github-username](https://github.com/your-github-username) - "Your favorite quote"
```

--------------------------------

### Kill HyDE HTTP Server

Source: https://github.com/hyde-project/hyde/blob/master/Scripts/hydevm/README.md

If the HTTP server is causing problems, use this command to forcefully terminate the process.

```bash
pkill -f "python3 -m http.server"
```