chore: bump version to v9.5.1

* fix: separate about screen title from translations

* chore: format with ruff's evil twin

.envrc.recommended

@@ -0,0 +1,16 @@
+# vi: ft=bash
+#
+# If you wish to use this file, copy or symlink it to `.envrc` for direnv to read it.
+# This will use the flake development shell.
+
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.5; then
+    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.5/direnvrc" "sha256-RuwIS+QKFj/T9M2TFXScjBsLR6V3A17YVoEW/Q6AZ1w="
+fi
+
+devenv_root_file="$(mktemp -t devenv-root-XXXXXXXX)"
+printf %s "${PWD}" >"${devenv_root_file}"
+if ! use flake . --override-input devenv-root "file+file://${devenv_root_file}"; then
+    printf '%s\n' "devenv could not be built. The devenv environment was not loaded. Make the necessary changes to devenv.nix and hit enter to try again." >&2
+fi
+rm "${devenv_root_file}"
+unset devenv_root_file

.git-blame-ignore-revs

@@ -0,0 +1,7 @@
+# Date: Fri, 3 May 2024 19:40:36 -0700
+# Reformatted using Ruff
+089c8dd50cbf22e75721ecd2c0e0acfd3deca7f3
+
+# Date: Fri, 13 Sep 2024 00:28:00 -0700
+# ci(ruff)!: update ruff linter config, refactor to comply
+b6e216760557c5507b12f210e1e48c531f49ffa3

.github/FUNDING.yml

@@ -0,0 +1 @@
+patreon: cyanvoxel

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: Bug Report
+description: File a bug or issue report.
+title: '[Bug]: '
+labels: ['Type: Bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        *Please add an appropriate title for this issue.*
+
+        Before reporting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        Validate that you are using an up-to-date version[^1], your issue might already be fixed!
+        Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
+
+        [^1]: This can mean latest release, pre-release, or git commit.
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Make sure you've checked (and actually did) all of the below.
+      options:
+        - label: I am using an up-to-date version.
+          required: true
+        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md).
+          required: true
+        - label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+          required: true
+  - type: input
+    attributes:
+      label: TagStudio Version
+      placeholder: Alpha 9.1.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating System & Version
+      placeholder: TagOS 3.14
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: Clear and concise description of the problem. Attach screenshots if needed, and include any errors you see.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Clear and concise description of what you think should happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Minimal steps neded for the problem to occur.
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Logs
+      description: Provide any logs, if applicable.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,40 @@
+name: Feature Request
+description: Suggest a new feature.
+title: '[Feature Request]: '
+labels: ['Type: Enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        *Please add an appropriate title for this feature request.*
+
+        Before suggesting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        Validate that you are using an up-to-date version[^1], your feature might already be implemented!
+        Questions, guidance, and usage goes in [discussions](https://github.com/TagStudioDev/TagStudio/discussions). Invalid issues will be closed.
+
+        [^1]: This can mean latest release, pre-release, or git commit.
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Make sure you've checked (and actually did) all of the below.
+      options:
+        - label: I am using an up-to-date version.
+          required: true
+        - label: I have read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/docs/index.md).
+          required: true
+        - label: I have searched existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+          required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: Clear and concise description of the problem or missing capability. Attach screenshots if needed, and explain your own use case.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Solution
+      description: Clear and concise description of what you think should happen.
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: Any considered alternative solutions or workarounds. If undesirable, why?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+### Summary
+
+<!--
+^^^ Summarize the changes done and why they were done above.
+
+By submitting this pull request, you certify that you have read the
+[CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md).
+
+IMPORTANT FOR FEATURES: Please verify that a feature request or some other form
+of communication with maintainers was already conducted in terms of approving.
+
+Thank you for your eagerness to contribute!
+-->
+
+### Tasks Completed
+
+<!-- No requirements, just context for reviewers. -->
+
+-   Platforms Tested:
+    -   [ ] Windows x86
+    -   [ ] Windows ARM
+    -   [ ] macOS x86
+    -   [ ] macOS ARM
+    -   [ ] Linux x86
+    -   [ ] Linux ARM
+    <!-- If an unspecified platform was tested, please add it here -->
+-   Tested For:
+    -   [ ] Basic functionality
+    -   [ ] PyInstaller executable <!-- Not necessarily required, but appreciated! -->
+    <!-- If other important criteria was tested for, please add it here -->

.github/workflows/mypy.yaml

@@ -0,0 +1,38 @@
+name: MyPy
+
+on: [ push, pull_request ]
+
+
+jobs:
+  mypy:
+    name: Run MyPy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: latest
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
+          uv pip install --system mypy==1.11.2
+          mkdir tagstudio/.mypy_cache
+
+      - uses: tsuyoshicho/action-mypy@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-check
+          fail_on_error: true
+          workdir: tagstudio
+          level: error
+          mypy_flags: --config-file ../pyproject.toml

.github/workflows/publish_docs.yaml

@@ -0,0 +1,38 @@
+name: Publish Docs 
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'CHANGELOG.md'
+      - '.github/workflows/publish_docs.yaml'
+
+permissions:
+  contents: write
+
+concurrency: 
+  group: publish-docs
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+                  mkdocs-material-
+      - run: pip install mkdocs-material mkdocs-material[imaging]
+      - run: mkdocs gh-deploy --force
+
+

.github/workflows/pytest.yaml

@@ -0,0 +1,75 @@
+name: pytest
+
+on: [ push, pull_request ]
+
+jobs:
+  pytest:
+    name: Run tests
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install system dependencies
+        run: |
+          # dont run update, it is slow
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libxkbcommon-x11-0 \
+            x11-utils \
+            libyaml-dev \
+            libgl1 \
+            libegl1 \
+            libxcb-icccm4 \
+            libxcb-image0 \
+            libxcb-keysyms1 \
+            libxcb-randr0 \
+            libxcb-render-util0 \
+            libxcb-xinerama0 \
+            libopengl0 \
+            libxcb-cursor0 \
+            libpulse0
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system -r requirements.txt
+          uv pip install --system -r requirements-dev.txt
+
+      - name: Run pytest
+        run: |
+          xvfb-run pytest --cov-report xml --cov=tagstudio
+
+      - name: Store coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: 'coverage'
+          path: 'coverage.xml'
+
+  coverage:
+    name: Check Code Coverage
+    runs-on: ubuntu-latest
+    needs: pytest
+
+    steps:
+      - name: Load coverage
+        uses: actions/download-artifact@v4
+        with:
+          name: 'coverage'
+
+      - name: Check Code Coverage
+        uses: yedpodtrzitko/coverage@main
+        with:
+          thresholdAll: 0.4
+          thresholdNew: 0.4
+          thresholdModified: 0.4
+          coverageFile: coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          sourceDir: tagstudio/src

.github/workflows/release.yml

@@ -0,0 +1,106 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+*
+
+jobs:
+  linux:
+    strategy:
+      matrix:
+        build-type: ['', portable]
+        include:
+          - build-type: ''
+            build-flag: ''
+            suffix: ''
+          - build-type: portable
+            build-flag: --portable
+            suffix: _portable
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - run: pip install -Ur requirements.txt pyinstaller
+      - run: pyinstaller tagstudio.spec -- ${{ matrix.build-flag }}
+      - run: tar czfC dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz dist tagstudio
+      - uses: actions/upload-artifact@v4
+        with:
+          name: tagstudio_linux_x86_64${{ matrix.suffix }}
+          path: dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz
+
+  macos:
+    strategy:
+      matrix:
+        os-version: ['13', '14']
+        include:
+          - os-version: '13'
+            arch: x86_64
+          - os-version: '14'
+            arch: aarch64
+    runs-on: macos-${{ matrix.os-version }}
+    env:
+      # even though we run on 12, target towards compatibility
+      MACOSX_DEPLOYMENT_TARGET: '11.0'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - run: pip install -Ur requirements.txt pyinstaller
+      - run: pyinstaller tagstudio.spec
+      - run: tar czfC dist/tagstudio_macos_${{ matrix.arch }}.tar.gz dist TagStudio.app
+      - uses: actions/upload-artifact@v4
+        with:
+          name: tagstudio_macos_${{ matrix.arch }}
+          path: dist/tagstudio_macos_${{ matrix.arch }}.tar.gz
+
+  windows:
+    strategy:
+      matrix:
+        build-type: ['', portable]
+        include:
+          - build-type: ''
+            build-flag: ''
+            suffix: ''
+            file-end: ''
+          - build-type: portable
+            build-flag: --portable
+            suffix: _portable
+            file-end: .exe
+    runs-on: windows-2019
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: 'pip'
+      - run: pip install -Ur requirements.txt pyinstaller
+      - run: PyInstaller tagstudio.spec -- ${{ matrix.build-flag }}
+      - run: Compress-Archive -Path dist/TagStudio${{ matrix.file-end }} -DestinationPath dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
+      - uses: actions/upload-artifact@v4
+        with:
+          name: tagstudio_windows_x86_64${{ matrix.suffix }}
+          path: dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
+
+  publish:
+    needs: [linux, macos, windows]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            tagstudio_linux_x86_64/*
+            tagstudio_linux_x86_64_portable/*
+            tagstudio_macos_x86_64/*
+            tagstudio_macos_aarch64/*
+            tagstudio_windows_x86_64/*
+            tagstudio_windows_x86_64_portable/*

.github/workflows/ruff.yaml

@@ -0,0 +1,20 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          version: 0.6.4
+          args: 'format --check'
+
+  ruff-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          version: 0.6.4
+          args: 'check'

.gitignore

@@ -35,6 +35,7 @@ MANIFEST
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec
+!tagstudio.spec
 
 # Installer logs
 pip-log.txt
@@ -87,9 +88,7 @@ profile_default/
 ipython_config.py
 
 # pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -139,6 +138,9 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
+# macoS
+*.DS_Store
+
 # mkdocs documentation
 /site
 
@@ -161,7 +163,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
 
 ### Python Patch ###
 # Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
@@ -173,6 +175,10 @@ poetry.toml
 # LSP config files
 pyrightconfig.json
 
+# Syncthing
+.stfolder/
+.stignore
+
 ### Qt ###
 # C++ objects and libs
 *.slo
@@ -230,11 +236,11 @@ compile_commands.json
 
 ### VisualStudioCode ###
 .vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/*.code-snippets
+# !.vscode/settings.json
+# !.vscode/tasks.json
+# !.vscode/launch.json
+# !.vscode/extensions.json
+# !.vscode/*.code-snippets
 
 # Local History for Visual Studio Code
 .history/
@@ -246,8 +252,16 @@ compile_commands.json
 # Ignore all local history of files
 .history
 .ionide
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,qt
 
 # TagStudio
 .TagStudio
+!*/tests/**/.TagStudio
+tagstudio/tests/fixtures/library/*
+tagstudio/tests/fixtures/json_library/.TagStudio/*.sqlite
+TagStudio.ini
+*.sqlite-journal
 
-# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,qt
+.envrc
+.direnv
+.devenv

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.6.4
+    hooks:
+      - id: ruff-format
+      - id: ruff

.vscode/launch.json

@@ -1,17 +0,0 @@
-{
-	// Use IntelliSense to learn about possible attributes.
-	// Hover to view descriptions of existing attributes.
-	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "TagStudio",
-			"type": "python",
-			"request": "launch",
-			"program": "${workspaceRoot}\\TagStudio\\tagstudio.py",
-			"console": "integratedTerminal",
-			"justMyCode": true,
-			"args": []
-		}
-	]
-}

Build_MacOS_app.sh

@@ -0,0 +1,69 @@
+#! /usr/bin/env bash
+# GETTING BASE DIR
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+# SETTING UP CONSTANTS
+TAGSTUDIO_NAME="TagStudio"
+TAGSTUDIO_DIR="$SCRIPT_DIR/tagstudio"
+TAGSTUDIO_DIR_RESOURCES="$TAGSTUDIO_DIR/resources"
+TAGSTUDIO_ICON="$TAGSTUDIO_DIR/resources/icon.ico"
+TAGSTUDIO_SRC="$TAGSTUDIO_DIR/src"
+TAGSTUDIO_MAIN="$TAGSTUDIO_DIR/tag_studio.py"
+DIST_PATH="$SCRIPT_DIR/dist"
+BUILD_PATH="$SCRIPT_DIR/build"
+LOGS_PATH="$BUILD_PATH/logs"
+
+printf -- "🏁 Starting Script \n"
+
+# CREATE VENV AND INSTALL REQUIREMENTS
+printf -- "🐍 Creating Python virtual env\n"
+python3 -m venv .venv 
+source .venv/bin/activate
+
+if [ ! -d $LOGS_PATH ]; then
+  printf -- "📁 Creating Logs folder\n"
+  mkdir -p $LOGS_PATH;
+fi
+
+printf -- "💻 Installing Requirements \n"
+pip install -r requirements.txt > "$LOGS_PATH/pip.log" 2>&1
+pip install PyInstaller > "$LOGS_PATH/pip.log" 2>&1
+
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    printf -- "🍏 MacOS Detected \n"
+    SYS_CMD="--windowed"
+    OS=0
+fi
+
+SECONDS=0
+
+# CREATE COMMAND 
+printf -- "⏳ Building App \n"
+
+COMMAND=$( python -m PyInstaller \
+  --name "$TAGSTUDIO_NAME" \
+  --icon "$TAGSTUDIO_ICON" \
+  --add-data "$TAGSTUDIO_DIR_RESOURCES:./resources" \
+  --add-data "$TAGSTUDIO_SRC:./src" \
+  --distpath "$DIST_PATH" \
+  -p "$TAGSTUDIO_DIR" \
+  --noconsole \
+  --workpath "$BUILD_PATH" \
+  -y "$SYS_CMD" "$TAGSTUDIO_MAIN" \
+  > "$LOGS_PATH/pyinstaller.log" 2>&1 )
+
+duration=$SECONDS
+
+if $COMMAND; then
+  printf -- "✅ Build Successfull \n"
+  printf -- "⌛ $((duration)) seconds of build\n"
+    if [[ "$OS" == 0 ]]; then
+      printf -- "📁 Opening App folder \n"
+      open $DIST_PATH
+    fi 
+else
+    printf -- "❌ Error Building the app\nPlease read the logs\navailable at build/logs\n"
+fi
+
+printf -- "🏁 END OF TRANSMISSION"

Build_win.bat

@@ -0,0 +1,31 @@
+@echo off
+set TAGSTUDIO_NAME=TagStudio
+set TAGSTUDIO_DIR=tagstudio
+set TAGSTUDIO_DIR_RESOURCES=%TAGSTUDIO_DIR%/resources
+set TAGSTUDIO_ICON=%TAGSTUDIO_DIR%/resources/icon.ico
+set TAGSTUDIO_SRC=%TAGSTUDIO_DIR%/src
+set TAGSTUDIO_MAIN=%TAGSTUDIO_DIR%/tag_studio.py
+set BUILD_MODE=--onedir
+
+
+if "%1" == "--help" (
+    echo run "%~nx0" for normal Build
+    echo run "%~nx0 --portable" for Build packaged into one file
+    goto end
+)
+if "%1" == "--portable" (
+    echo Building portable executable...
+    set BUILD_MODE=--onefile
+    goto run
+)
+if not "%1" == "" (
+    echo Invalid argument run "%~nx0 --help" for help
+    goto end
+)
+:run
+echo Building executable...
+set COMMAND=PyInstaller --name "%TAGSTUDIO_NAME%" --icon "%TAGSTUDIO_ICON%" --add-data "%TAGSTUDIO_DIR_RESOURCES%:./resources" --add-data "%TAGSTUDIO_SRC%:./src" -p "%TAGSTUDIO_DIR%" --console %BUILD_MODE% "%TAGSTUDIO_MAIN%" -y
+call .venv\Scripts\activate.bat
+%COMMAND%
+deactivate
+:end

CHANGELOG.md

@@ -5,7 +5,56 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [9.1.0-alpha] - 2024-04-22
+## [9.2.0] - 2024-05-14
+
+### Added
+
+- Full macOS and Linux support
+- Ability to apply tags to multiple selections at once
+- Right-click context menu for opening files or their locations
+- Support for all filetypes inside of the library
+- Configurable filetype blacklist
+- Option to automatically open last used library on startup
+- Tool to convert folder structure to tag tree
+- SIGTERM handling in console window
+- Keyboard shortcuts for basic functions
+- Basic support for plaintext thumbnails
+- Default icon for files with no thumbnail support
+- Menu action to close library
+- All tags now show in the "Add Tag" panel by default
+- Modal view to view and manage all library tags
+- Build scripts for Windows and macOS
+- Help menu option to visit the GitHub repository
+- Toggleable "Recent Libraries" list in the entry side panel
+
+### Fixed
+
+- Fixed errors when performing actions with no library open
+- Fixed bug where built-in tags were duplicated upon saving
+- QThreads are now properly terminated on application exit
+- Images with rotational EXIF data are now properly displayed
+- Fixed "truncated" images causing errors
+- Fixed images with large resolutions causing errors
+
+### Changed
+
+- Updated minimum Python version to 3.12
+- Various UI improvements
+  - Improved legibility of the Light Theme (still a WIP)
+  - Updated Dark Theme
+  - Added hand cursor to several clickable elements
+- Fixed network paths not being able to load
+- Various code cleanup and refactoring
+- New application icons
+
+### Known Issues
+- Using and editing multiple entry fields of the same type may result in incorrect field(s) being updated
+- Adding Favorite or Archived tags via the thumbnail badges may apply the tag(s) to incorrect fields
+- Searching for tag names with spaces does not currently function as intended
+	- A temporary workaround it to omit spaces in tag names when  searching
+- Sorting fields using the "Sort Fields" macro may result in edit icons being shown for incorrect fields
+
+## [9.1.0] - 2024-04-22
 
 ### Added
 

CONTRIBUTING.md

@@ -0,0 +1,206 @@
+# Contributing to TagStudio
+
+_Last Updated: January 30th, 2025_
+
+Thank you so much for showing interest in contributing to TagStudio! Here are a set of instructions and guidelines for contributing code or documentation to the project. This document will change over time, so make sure that your contributions still line up with the requirements here before submitting a pull request.
+
+## Getting Started
+
+-   Check the [Feature Roadmap](/docs/updates/roadmap.md) page to see what priority features there are, the [FAQ](/README.md/#faq), as well as the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls).
+-   If you'd like to add a feature that isn't on the feature roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first.
+    -   We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences.
+-   **Please don't** create pull requests that consist of large refactors, _especially_ without discussing them with us first. These end up doing more harm than good for the project by continuously delaying progress and disrupting everyone else's work.
+-   If you wish to discuss TagStudio further, feel free to join the [Discord Server](https://discord.com/invite/hRNnVKhF2G)
+
+### Contribution Checklist
+
+-   I've read the [Feature Roadmap](/docs/updates/roadmap.md) page
+-   I've read the [FAQ](/README.md/#faq), including the "[Features I Likely Won't Add/Pull](/README.md/#features-i-likely-wont-addpull)" section
+-   I've checked the open [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls)
+-   **I've created a new issue for my feature/fix _before_ starting work on it**, or have at least notified others in the relevant existing issue(s) of my intention to work on it
+-   I've set up my development environment including Ruff, Mypy, and PyTest
+-   I've read the [Code Guidelines](#code-guidelines) and/or [Documentation Guidelines](#documentation-guidelines)
+-   **_I mean it, I've found or created an issue for my feature/fix!_**
+
+> [!NOTE]
+> If the fix is small and self-explanatory (i.e. a typo), then it doesn't require an issue to be opened first. Issue tracking is supposed to make our lives easier, not harder. Please use your best judgement to minimize the amount of work involved for everyone involved.
+
+## Creating a Development Environment
+
+### Prerequisites
+
+-   [Python](https://www.python.org/downloads/) 3.12
+-   [Ruff](https://github.com/astral-sh/ruff) (Included in `requirements-dev.txt`)
+-   [Mypy](https://github.com/python/mypy) (Included in `requirements-dev.txt`)
+-   [PyTest](https://docs.pytest.org) (Included in `requirements-dev.txt`)
+
+### Creating a Python Virtual Environment
+
+If you wish to launch the source version of TagStudio outside of your IDE:
+
+> [!IMPORTANT]
+> Depending on your system, Python may be called `python`, `py`, `python3`, or `py3`. These instructions use the alias `python3` for consistency. You can check to see which alias your system uses and if it's for the correct Python version by typing `python3 --version` (or whichever alias) into your terminal.
+
+> [!TIP]
+> On Linux and macOS, you can launch the `tagstudio.sh` script to skip the following process, minus the `requirements-dev.txt` installation step. _Using the script is fine if you just want to launch the program from source._
+
+1. Make sure you're using the correct Python version:
+   -   If the output matches `Python 3.12.x` (where the x is any number) then you're using the correct Python version and can skip to step 2. Otherwise, you can install the correct Python version from the [Python](https://www.python.org/downloads/) website, or you can use a tool like [pyenv](https://github.com/pyenv/pyenv/) to install the correct version without changes to your system:
+      1. Follow pyenv's [install instructions](https://github.com/pyenv/pyenv/?tab=readme-ov-file#installation) for your system.
+      2. Install the appropriate Python version with pyenv by running `pyenv install 3.12` (This will **not** mess with your existing Python installation).
+      3. Navigate to the repository root folder in your terminal and run `pyenv local 3.12`.
+      - You could alternatively use `pyenv shell 3.12` or `pyenv global 3.12` instead to set the Python version for the current terminal session or the entire system respectively, however using `local` is recommended.
+
+2. In the root repository directory, create a python virtual environment:  
+   `python3 -m venv .venv`
+3. Activate your environment:
+
+-   Windows w/Powershell: `.venv\Scripts\Activate.ps1`
+-   Windows w/Command Prompt: `.venv\Scripts\activate.bat`
+-   Linux/macOS: `source .venv/bin/activate`
+       Depending on your system, the regular activation script *might* not work on alternative shells. In this case, refer to the table below for supported shells:
+       |Shell   |Script                   |
+       |-------:|:------------------------|
+       |Bash/ZSH|`.venv/bin/activate`     |
+       |Fish    |`.venv/bin/activate.fish`|
+       |CSH/TCSH|`.venv/bin/activate.csh` |
+       |PWSH    |`.venv/bin/activate.ps1` |
+       
+
+4. Install the required packages:
+
+-   `pip install -r requirements.txt`
+-   If developing (includes Ruff and Mypy): `pip install -r requirements-dev.txt`
+
+_Learn more about setting up a virtual environment [here](https://docs.python.org/3/tutorial/venv.html)._
+
+### Manually Launching (Outside of an IDE)
+
+If you encounter errors about the Python version, or seemingly vague script errors, [pyenv](https://github.com/pyenv/pyenv/) may solve your issue. See step 1 of [Creating a Python Virtual Environment](#creating-a-python-virtual-environment).
+
+-   **Windows** (start_win.bat)
+
+    -   To launch TagStudio, launch the `start_win.bat` file. You can modify this .bat file or create a shortcut and add one or more additional arguments if desired.
+
+-   **Linux/macOS** (TagStudio.sh)
+
+    -   Run the "TagStudio.sh" script and the program should launch! (Make sure that the script is marked as executable if on Linux). Note that launching from the script from outside of a terminal will not launch a terminal window with any debug or crash information. If you wish to see this information, just launch the shell script directly from your terminal with `./TagStudio.sh`.
+
+    -   **NixOS** (Nix Flake)
+        -   Use the provided [Flake](https://nixos.wiki/wiki/Flakes) to create and enter a working environment by running `nix develop`. Then, run the program via `python3 tagstudio/tag_studio.py` from the root directory.
+
+> [!WARNING]
+> Support for NixOS is still a work in progress.
+
+-   **Any** (No Scripts)
+
+    -   Alternatively, with the virtual environment loaded, run the python file at `tagstudio\tag_studio.py` from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tag_studio.py`.
+
+## Workflow Checks
+
+When pushing your code, several automated workflows will check it against predefined tests and style checks. It's _highly recommended_ that you run these checks locally beforehand to avoid having to fight back-and-forth with the workflow checks inside your pull requests.
+
+> [!TIP]
+> To format the code automatically before each commit, there's a configured action available for the `pre-commit` hook. Install it by running `pre-commit install`. The hook will be executed each time on running `git commit`.
+
+### [Ruff](https://github.com/astral-sh/ruff)
+
+A Python linter and code formatter. Ruff uses the `pyproject.toml` as its config file and runs whenever code is pushed or pulled into the project.
+
+#### Running Locally
+
+Inside the root repository directory:
+
+-   Lint code with `ruff check`
+    -   Some linting suggestions can be automatically formatted with `ruff check --fix`
+-   Format code with `ruff format`
+
+Ruff should automatically discover the configuration options inside the [pyproject.toml](https://github.com/TagStudioDev/TagStudio/blob/main/pyproject.toml) file. For more information, see the [ruff configuration discovery docs](https://docs.astral.sh/ruff/configuration/#config-file-discovery).
+
+Ruff is also available as a VS Code [extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff), PyCharm [plugin](https://plugins.jetbrains.com/plugin/20574-ruff), and [more](https://docs.astral.sh/ruff/integrations/).
+
+### [Mypy](https://github.com/python/mypy)
+
+Mypy is a static type checker for Python. It sure has a lot to say sometimes, but we recommend you take its advice when possible. Mypy also uses the `pyproject.toml` as its config file and runs whenever code is pushed or pulled into the project.
+
+#### Running Locally
+
+-   **First time only:** Move into the `/tagstudio` directory with `cd tagstudio` and run the following:
+    -   `mkdir -p .mypy_cache`
+    -   `mypy --install-types --non-interactive`
+-   Check code by moving into the `/tagstudio` directory with `cd tagstudio` _(if you aren't already inside)_ and running `mypy --config-file ../pyproject.toml .`. _(Don't forget the `.` at the end!)_
+
+Mypy is also available as a VS Code [extension](https://marketplace.visualstudio.com/items?itemName=matangover.mypy), PyCharm [plugin](https://plugins.jetbrains.com/plugin/11086-mypy), and [more](https://plugins.jetbrains.com/plugin/11086-mypy).
+
+### PyTest
+
+-   Run all tests by moving into the `/tagstudio` directory with `cd tagstudio` and running `pytest tests/`.
+
+## Code Style
+
+Most of the style guidelines can be checked, fixed, and enforced via Ruff. Older code may not be adhering to all of these guidelines, in which case _"do as I say, not as I do"..._
+
+-   Do your best to write clear, concise, and modular code.
+-   Keep a maximum column with of no more than **100** characters.
+-   Code comments should be used to help describe sections of code that can't speak for themselves.
+-   Use [Google style](https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings) docstrings for any classes and functions you add.
+    -   If you're modifying an existing function that does _not_ have docstrings, you don't _have_ to add docstrings to it... but it would be pretty cool if you did ;)
+-   Imports should be ordered alphabetically.
+-   Lists of values should be ordered using their [natural sort order](https://en.wikipedia.org/wiki/Natural_sort_order).
+    -   Some files have their methods ordered alphabetically as well (i.e. [`thumb_renderer`](https://github.com/TagStudioDev/TagStudio/blob/main/tagstudio/src/qt/widgets/thumb_renderer.py)). If you're working in a file and notice this, please try and keep to the pattern.
+-   When writing text for window titles or form titles, use "[Title Case](https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case)" capitalization. Your IDE may have a command to format this for you automatically, although some may incorrectly capitalize short prepositions. In a pinch you can use a website such as [capitalizemytitle.com](https://capitalizemytitle.com/) to check.
+-   If it wasn't mentioned above, then stick to [**PEP-8**](https://peps.python.org/pep-0008/)!
+
+### Modules & Implementations
+
+-   **Do not** modify legacy library code in the `src/core/library/json/` directory
+-   Avoid direct calls to `os`
+    -   Use `Pathlib` library instead of `os.path`
+    -   Use `platform.system()` instead of `os.name` and `sys.platform`
+-   Don't prepend local imports with `tagstudio`, stick to `src`
+-   Use the `logger` system instead of `print` statements
+-   Avoid nested f-strings
+-   Use HTML-like tags inside Qt widgets over stylesheets where possible
+
+### Commit and Pull Request Style
+
+-   Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) as a guideline for commit messages. This allows us to easily generate changelogs for releases.
+    -   See some [examples](https://www.conventionalcommits.org/en/v1.0.0/#examples) of what this looks like in practice.
+-   Use clear and concise commit messages. If your commit does too much, either consider breaking it up into smaller commits or providing extra detail in the commit description.
+-   Pull requests should have an adequate title and description which clearly outline your intentions and changes/additions. Feel free to provide screenshots, GIFs, or videos, especially for UI changes.
+-   Pull requests should ideally be limited to **a single** feature or fix.
+
+> [!IMPORTANT]
+> Please do not force push if your PR is open for review!
+>
+> Force pushing makes it impossible to discern which changes have already been reviewed and which haven't. This means a reviewer will then have to rereview all the already reviewed code, which is a lot of unnecessary work for reviewers.
+
+> [!TIP]
+> If you're unsure where to stop the scope of your PR, ask yourself: _"If I broke this up, could any parts of it still be used by the project in the meantime?"_
+
+### Runtime Requirements
+
+-   Final code must function on supported versions of Windows, macOS, and Linux:
+    -   Windows: 10, 11
+    -   macOS: 12.0+
+    -   Linux: _Varies_
+-   Final code must **_NOT:_**
+    -   Contain superfluous or unnecessary logging statements
+    -   Cause unreasonable slowdowns to the program outside of a progress-indicated task
+    -   Cause undesirable visual glitches or artifacts on screen
+
+## Documentation Guidelines
+
+Documentation contributions include anything inside of the `docs/` folder, as well as the `README.md` and `CONTRIBUTING.md` files. Documentation inside the `docs/` folder is built and hosted on our static documentation site, [docs.tagstud.io](https://docs.tagstud.io/).
+
+-   Use "[snake_case](https://developer.mozilla.org/en-US/docs/Glossary/Snake_case)" for file and folder names
+-   Follow the folder structure pattern
+-   Don't add images or other media with excessively large file sizes
+-   Provide alt text for all embedded media
+-   Use "[Title Case](https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case)" for title capitalization
+
+## Translation Guidelines
+
+Translations are performed on the TagStudio [Weblate project](https://hosted.weblate.org/projects/tagstudio/).
+
+_Translation guidelines coming soon._

README.md

@@ -1,107 +1,126 @@
-# TagStudio (Preview/Alpha): A User-Focused Document Management System
+# TagStudio: A User-Focused Document Management System
+
+[![Translation](https://hosted.weblate.org/widget/tagstudio/strings/svg-badge.svg)](https://hosted.weblate.org/projects/tagstudio/strings/)
+[![PyTest](https://github.com/TagStudioDev/TagStudio/actions/workflows/pytest.yaml/badge.svg)](https://github.com/TagStudioDev/TagStudio/actions/workflows/pytest.yaml)
+[![MyPy](https://github.com/TagStudioDev/TagStudio/actions/workflows/mypy.yaml/badge.svg)](https://github.com/TagStudioDev/TagStudio/actions/workflows/mypy.yaml)
+[![Ruff](https://github.com/TagStudioDev/TagStudio/actions/workflows/ruff.yaml/badge.svg)](https://github.com/TagStudioDev/TagStudio/actions/workflows/ruff.yaml)
+[![Downloads](https://img.shields.io/github/downloads/TagStudioDev/TagStudio/total.svg?maxAge=2592001)](https://github.com/TagStudioDev/TagStudio/releases)
 
 <p align="center">
-  <img width="60%" src="github_header.png">
+  <img width="60%" src="docs/assets/github_header.png">
 </p>
 
-> [!CAUTION]
-> This is still a **_very_** rough personal project of mine in its infancy. I’m open-sourcing it now in order to accept contributors sooner and to better facilitate the direction of the project from an earlier stage.
-> There **_are_** bugs, and there will **_very likely_** be breaking changes!
+TagStudio is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure. **Read the documentation and more at [docs.tagstud.io](https://docs.tagstud.io)!**
 
-TagStudio is a photo & file organization application with an underlying system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
+> [!NOTE]
+> Thank you for being patient as we've migrated our database backend from JSON to SQL! The previous warnings about the main branch being experimental and unsupported have now been removed, and any pre-existing library save files created with official TagStudio releases are able to be opened and migrated with the new v9.5+ releases!
+
+> [!IMPORTANT]
+> This project is still in an early state. There are many missing optimizations and QoL features, as well as the presence of general quirks and occasional jankiness. Making frequent backups of your library save data is **always** important, regardless of what state the program is in.
+>
+> With this in mind, TagStudio will _NOT:_
+>
+> -   Touch, move, or mess with your files in any way _(unless explicitly using the "Delete File(s)" feature, which is locked behind a confirmation dialog)_.
+> -   Ask you to recreate your tags or libraries after new releases. It's our highest priority to ensure that your data safely and smoothly transfers over to newer versions.
+> -   Cause you to suddenly be able to recall your 10 trillion downloaded images that you probably haven't even seen firsthand before. You're in control here, and even tools out there that use machine learning still needed to be verified by human eyes before being deemed accurate.
 
 <p align="center">
-  <img width="80%" src="screenshot.jpg">
+  <img width="80%" src="docs/assets/screenshot.png" alt="TagStudio Screenshot">
+</p>
+<p align="center">
+  <i>TagStudio Alpha v9.5.0 running on macOS Sequoia.</i>
 </p>
 
 ## Contents
-- [Goals](#goals)
-- [Priorities](#priorities)
-- [Current Features](#current-features)
-- [Installation](#installation)
-- [Usage](#usage)
-- [FAQ](#faq)
+
+-   [Goals](#goals)
+-   [Priorities](#priorities)
+-   [Current Features](#current-features)
+-   [Contributing](#contributing)
+-   [Installation](#installation)
+-   [Usage](#usage)
+-   [FAQ](#faq)
 
 ## Goals
 
-- To achieve a portable, privacy-oriented, open, extensible, and feature-rich system of organizing and rediscovering files.
-- To provide powerful methods for organization, notably the concept of tag composition, or “taggable tags”.
-- To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or otherwise requiring them to change their existing file structures and workflows.
-- To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
-- To make the darn thing look like nice, too. It’s 2024, not 1994.
+-   To achieve a portable, private, extensible, open-format, and feature-rich system of organizing and rediscovering files.
+-   To provide powerful methods for organization, notably the concept of tag inheritance, or “taggable tags” _(and in the near future, the combination of composition-based tags)._
+-   To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or requiring them to change their existing file structures and workflows.
+-   To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
+-   To make the dang thing look nice, too. It’s 2025, not 1995.
 
 ## Priorities
 
-1. **The concept.** Even if TagStudio as a project or application fails, I’d hope that the idea lives on in a superior project. The [goals](#goals) outlined above don’t reference TagStudio once - _TagStudio_ is what references the _goals._
+1. **The concept.** Even if TagStudio as an application fails, I’d hope that the idea lives on in a superior project. The [goals](#goals) outlined above don’t reference TagStudio once - _TagStudio_ is what references the _goals._
 2. **The system.** Frontends and implementations can vary, as they should. The core underlying metadata management system is what should be interoperable between different frontends, programs, and operating systems. A standard implementation for this should settle as development continues. This opens up the doors for improved and varied clients, integration with third-party applications, and more.
 3. **The application.** If nothing else, TagStudio the application serves as the first (and so far only) implementation for this system of metadata management. This has the responsibility of doing the idea justice and showing just what’s possible when it comes to user file management.
-4. (The name.) I think it’s fine for an app or client, but it doesn’t really make sense for a system or standard. I suppose this will evolve with time.
+4. (The name.) I think it’s fine for an app or client, but it doesn’t really make sense for a system or standard. I suppose this will evolve with time...
+
+## Contributing
+
+If you're interested in contributing to TagStudio, please take a look at the [contribution guidelines](/CONTRIBUTING.md) for how to get started!
+
+Translation hosting generously provided by [Weblate](https://weblate.org/en/). Check out our [project page](https://hosted.weblate.org/projects/tagstudio/) to help translate TagStudio!
 
 ## Current Features
 
-- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
-- Add metadata to your library entries, including:
-  - Name, Author, Artist (Single-Line Text Fields)
-  - Description, Notes (Multiline Text Fields)
-  - Tags, Meta Tags, Content Tags (Tag Boxes)
-- Crete rich tags composed of a name, a list of aliases, and a list of “subtags” - being tags in which these tags inherit values from.
-- Search for entries based on tags, metadata, or filename (using `filename: <query>`)
-- Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
+### Libraries
+
+-   Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
+-   Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu.
+
+### Tagging + Custom Metadata
+
+-   Add custom powerful tags to your library entries
+-   Add metadata to your library entries, including:
+    -   Name, Author, Artist (Single-Line Text Fields)
+    -   Description, Notes (Multiline Text Fields)
+-   Create rich tags composed of a name, color, a list of aliases, and a list of “parent tags” - these being tags in which these tags inherit values from.
+-   Copy and paste tags and fields across file entries
+-   Automatically organize tags into groups based on parent tags marked as "categories"
+-   Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created)
+
+### Search
+
+-   Search for file entries based on tags, file path (`path:`), file types (`filetype:`), and even media types! (`mediatype:`). Path searches currently use [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax, so you may need to wrap your filename or filepath in asterisks while searching. This will not be strictly necessary in future versions of the program.
+-   Use and combine boolean operators (`AND`, `OR`, `NOT`) along with parentheses groups, quotation escaping, and underscore substitution to create detailed search queries
+-   Use special search conditions (`special:untagged` and `special:empty`) to find file entries without tags or fields, respectively
+
+### File Entries
+
+-   Nearly all file types are supported in TagStudio libraries - just not all have dedicated thumbnail support.
+-   Preview most image file types, animated GIFs, videos, plain text documents, audio files, Blender projects, and more!
+-   Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location.
+-   Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option.
 
 > [!NOTE]
-> For more information on the project itself, please see the [FAQ](#faq) section and other docs.
+> For more information on the project itself, please see the [FAQ](#faq) section as well as the [documentation](https://docs.tagstud.io/)!
 
 ## Installation
-> [!CAUTION]
-> TagStudio is only currently verified to work on Windows. I've run into issues with the Qt code running on Linux, but I don't know how severe these issues are. There's also likely bugs regarding filenames and portability of the databases across different OSes.
 
-### Prerequisites
+To download TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) section of the GitHub repository and download the latest release for your system under the "Assets" section. TagStudio is available for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. Windows and Linux builds are also available in portable versions if you want a more self-contained executable to move around.
 
-- Python 3.9.6 - ~3.10 *(Not working on 3.12)*
+**We do not currently publish TagStudio to any package managers. Any TagStudio distributions outside of the GitHub releases page are _unofficial_ and not maintained by us.** Installation support will not be given to users installing from unofficial sources. Use these versions at your own risk.
 
-### Creating the Virtual Environment
+> [!IMPORTANT]
+> On macOS, you may be met with a message saying _""TagStudio" can't be opened because Apple cannot check it for malicious software."_ If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says _""TagStudio" was blocked from use because it is not from an identified developer."_ Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
 
-*Skip this step if launching from the .sh script on Linux.*
+> [!IMPORTANT]
+> On Linux with non-Qt based Desktop Environments you may be unable to open TagStudio. You need to make sure that "xcb-cursor0" or "libxcb-cursor0" packages are installed. For more info check [Missing linux dependencies](https://github.com/TagStudioDev/TagStudio/discussions/182#discussioncomment-9452896)
 
-1. In the root repository directory, create a python virtual environment:  
-   `python3 -m venv .venv`
-2. Activate your environment:
+### Third-Party Dependencies
 
-- Windows w/Powershell: `.venv\Scripts\Activate.ps1`
-- Windows w/Command Prompt: `.venv\Scripts\activate.bat`
-- Linux/macOS: `source .venv/bin/activate`
+-   For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. If you encounter any issues with this, please reference our [FFmpeg Help](/docs/help/ffmpeg.md) guide.
 
-3. Install the required packages:  
-   `pip install -r requirements.txt`
+### Optional Arguments
 
-_Learn more about setting up a virtual environment [here](https://docs.python.org/3/tutorial/venv.html)._
-
-### Launching
-
-> [!NOTE]
-> Depending on your system, Python may be called `python`, `py`, `python3`, or `py3`. These instructions use the alias `python3`. 
-
-#### Optional Arguments
+Arguments available to pass to the program, either via the command line or a shortcut.
 
 > `--open <path>` / `-o <path>`
 > Path to a TagStudio Library folder to open on start.
-
-#### Windows
-
-To launch TagStudio, launch the `start_win.bat` file. You can modify this .bat file or create a shortcut and add one or more additional arguments if desired.
-
-Alternatively, with the virtual environment loaded, run the python file at `tagstudio\tagstudio.py` from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tagstudio.py`.
-
-> [!CAUTION]
-> TagStudio on Linux & macOS likely won't function correctly at this time. If you're trying to run this in order to help test, debug, and improve compatibility, then charge on ahead!
-
-#### macOS
-
-With the virtual environment loaded, run the python file at "tagstudio/tagstudio.py" from your terminal. If you're in the project's root directory, simply run `python3 tagstudio/tagstudio.py`. When launching the program in the future, remember to activate the virtual environment each time before launching *(an easier method is currently being worked on).*
-
-#### Linux
-
-Run the "TagStudio.sh" script, and the program should launch! (Make sure that the script is marked as executable). Note that launching from the script from outside of a terminal will not launch a terminal window with any debug or crash information. If you wish to see this information, just launch the shell script directly from your terminal with `sh TagStudio.sh`.
+>
+> `--config-file <path>` / `-c <path>`
+> Path to the TagStudio config file to load.
 
 ## Usage
 
@@ -111,14 +130,19 @@ With TagStudio opened, start by creating a new library or opening an existing on
 
 ### Refreshing the Library
 
-In order to scan for new files or file changes, you’ll need to manually go to File -> Refresh Directories.
+Libraries under 10,000 files automatically scan for new or modified files when opened. In order to refresh the library manually, select "Refresh Directories" under the File menu.
 
-> [!NOTE]
-> In the future, library refreshing will also be automatically done in the background, or additionally on app startup.
+### Adding Tags to File Entries
 
-### Adding Metadata to Entries
+Access the "Add Tag" search box by either clicking on the "Add Tag" button at the bottom of the right sidebar, accessing the "Add Tags to Selected" option from the File menu, or by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd>.
 
-To add a metadata field to a file entry, start by clicking the “Add Field” button under the file preview in the right-hand preview panel. From the dropdown menu, select the type of metadata field you’d like to add to the entry.
+From here you can search for existing tags or create a new one if the one you're looking for doesn't exist. Click the “+” button next to any tags you want to to the currently selected file entries. To quickly add the top result, press the <kbd>Enter</kbd>/<kbd>Return</kbd> key to add the the topmost tag and reset the tag search. Press <kbd>Enter</kbd>/<kbd>Return</kbd> once more to close the dialog box. By using this method, you can quickly add various tags in quick succession just by using the keyboard!
+
+To remove a tag from a file entry, hover over the tag in the preview panel and click on the "-" icon that appears.
+
+### Adding Metadata to File Entries
+
+To add a metadata field to a file entry, start by clicking the “Add Field” button at the bottom of the preview panel. From the dropdown menu, select the type of metadata field you’d like to add to the entry
 
 ### Editing Metadata Fields
 
@@ -126,45 +150,48 @@ To add a metadata field to a file entry, start by clicking the “Add Field” b
 
 Hover over the field and click the pencil icon. From there, add or edit text in the dialog box popup.
 
-#### Tag Box
-
-Click the “+” button at the end of the Tags list, and search for tags to add inside the new dialog popup. Click the “+” button next to whichever tags you want to add. Alternatively, after you search for a tag, press the Enter/Return key to add the add the first item in the list. Press Enter/Return once more to close the dialog box
-
 > [!WARNING]
 > Keyboard control and navigation is currently _very_ buggy, but will be improved in future versions.
 
 ### Creating Tags
 
-To create a new tag, click on Edit -> New Tag from the menu bar. From there, enter a tag name, shorthand name, any tag aliases separated by newlines, any subtags, and an optional color.
+Create a new tag by accessing the "New Tag" option from the Edit menu or by pressing <kbd>Ctrl</kbd>+<kbd>T</kbd>. In the tag creation panel, enter a tag name, optional shorthand name, optional tag aliases, optional parent tags, and an optional color.
 
-- The tag **shorthand** is a type of alias that displays in situations when screen space is more valuable (ex. as a subtag for other tags).
-- **Aliases** are alternate names for a tag. These let you search for terms other than the exact tag name in order to find the tag again.
-- **Subtags** are tags in which this tag is a child tag of. In other words, tags under this section are parents of this tag. For example, if you had a tag for a character from a show, you would make the show a subtag of this character. This would display as “Character (Show)” in most areas of the app. The first tag in this list is used as the tag shown in parentheses for specification.
-- The **color** dropdown lets you select an optional color for this tag to display as.
+-   The tag **name** is the base name of the tag. **_This does NOT have to be unique!_**
+-   The tag **shorthand** is a special type of alias that displays in situations where screen space is more valuable, notably with name disambiguation.
+-   **Aliases** are alternate names for a tag. These let you search for terms other than the exact tag name in order to find the tag again.
+-   **Parent Tags** are tags in which this this tag can substitute for in searches. In other words, tags under this section are parents of this tag.
+    -   Parent tags with the disambiguation check next to them will be used to help disambiguate tag names that may not be unique.
+    -   For example: If you had a tag for "Freddy Fazbear", you might add "Five Nights at Freddy's" as one of the parent tags. If the disambiguation box is checked next to "Five Nights at Freddy's" parent tag, then the tag "Freddy Fazbear" will display as "Freddy Fazbear (Five Nights at Freddy's)". Furthermore, if the "Five Nights at Freddy's" tag has a shorthand like "FNAF", then the "Freddy Fazbear" tag will display as "Freddy Fazbear (FNAF)".
+-   The **color** option lets you select an optional color palette to use for your tag.
+-   The **"Is Category"** property lets you treat this tag as a category under which itself and any child tags inheriting from it will be sorted by inside the preview panel.
+
+#### Tag Manager
+
+You can manage your library of tags from opening the "Tag Manager" panel from Edit -> "Tag Manager". From here you can create, search for, edit, and permanently delete any tags you've created in your library.
 
 ### Editing Tags
 
-To edit a tag, right-click the tag in the tag field of the preview pane and select “Edit Tag”
+To edit a tag, click on it inside the preview panel or right-click the tag and select “Edit Tag” from the context menu.
+
+### Relinking Moved Files
+
+Inevitably some of the files inside your library will be renamed, moved, or deleted. If a file has been renamed or moved, TagStudio will display the thumbnail as a red broken chain link. To relink moved files or delete these entries, select the "Manage Unlinked Entries" option under the Tools menu. Click the "Refresh" button to scan your library for unlinked entries. Once complete, you can attempt to “Search & Relink” any unlinked file entries to their respective files, or “Delete Unlinked Entries” in the event the original files have been deleted and you no longer wish to keep their entries inside your library.
 
 > [!WARNING]
-> There is currently no method to view all tags that you’ve created in your library. This is a top priority for future releases.
-
-### Relinking Renamed/Moved Files
-
-Inevitably, some of the files inside your library will be renamed, moved, or deleted. If a file has been renamed or moved, TagStudio will display the thumbnail as a red tag with a cross through it _(this icon is also used for items with broken thumbnails)._ To relink moved files or delete these entries, go to Tools -> Manage Unlinked Entries. Click the “Refresh” button to scan your library for unlinked entries. Once complete, you can attempt to “Search & Relink” any unlinked entries to their respective files, or “Delete Unlinked Entries” in the event the original files have been deleted and you no longer wish to keep their metadata entries inside your library.
+> There is currently no method to relink entries to files that have been renamed - only moved or deleted. This is a high priority for future releases.
 
 > [!WARNING]
-> There is currently no method to relink entries to files that have been renamed - only moved or deleted. This is a top priority for future releases.
-
-> [!WARNING]
-> If multiple matches for a moved file are found (matches are currently defined as files with a matching filename as the original), TagStudio will currently ignore the match groups. Adding a GUI for manual selection, as well as smarter automated relinking, are top priorities for future versions.
+> If multiple matches for a moved file are found (matches are currently defined as files with a matching filename as the original), TagStudio will currently ignore the match groups. Adding a GUI for manual selection, as well as smarter automated relinking, are high priorities for future versions.
 
 ### Saving the Library
 
-Libraries are saved upon exiting the program. To manually save, select File -> Save Library from the menu bar. To save a backup of your library, select File -> Save Library Backup from the menu bar.
+As of version 9.5, libraries are saved automatically as you go. To save a backup of your library, select File -> Save Library Backup from the menu bar.
 
 ### Half-Implemented Features
 
+These features were present in pre-public versions of TagStudio (9.0 and below) and have yet to be fully implemented.
+
 #### Fix Duplicate Files
 
 Load in a .dupeguru file generated by [dupeGuru](https://github.com/arsenetar/dupeguru/) and mirror metadata across entries marked as duplicates. After mirroring, return to dupeGuru to manage deletion of the duplicate files. After deletion, use the “Fix Unlinked Entries” feature in TagStudio to delete the duplicate set of entries for the now-deleted files
@@ -172,13 +199,6 @@ Load in a .dupeguru file generated by [dupeGuru](https://github.com/arsenetar/du
 > [!CAUTION]
 > While this feature is functional, it’s a pretty roundabout process and can be streamlined in the future.
 
-#### Image Collage
-
-Create an image collage of your photos and videos.
-
-> [!CAUTION]
-> Collage sizes and options are hardcoded.
-
 #### Macros
 
 Apply tags and other metadata automatically depending on certain criteria. Set specific macros to run when the files are added to the library. Part of this includes applying tags automatically based on parent folders.
@@ -193,83 +213,28 @@ Import JSON sidecar data generated by [gallery-dl](https://github.com/mikf/galle
 > [!CAUTION]
 > This feature is not supported or documented in any official capacity whatsoever. It will likely be rolled-in to a larger and more generalized sidecar importing feature in the future.
 
+## Launching/Building From Source
+
+See instructions in the "[Creating Development Environment](/CONTRIBUTING.md/#creating-a-development-environment)" section from the [contribution documentation](/CONTRIBUTING.md).
+
 ## FAQ
 
 ### What State Is the Project Currently In?
 
-As of writing (Alpha v9.1.0) the project is in a “useable” state, however it lacks proper testing and quality of life features. Currently the program has only been verified to work properly on Windows, and is unlikely to properly run on Linux or macOS in its current state, however this functionality is a priority going forward with testers.
+As of writing (Alpha v9.5.0) the project is very usable, however there's some plenty of quirks and missing QoL features. Several additional features and changes are still planned (see: [Feature Roadmap](https://docs.tagstud.io/updates/roadmap/)) that add even more power and flexibility to the tagging and field systems while making it easier to tag in bulk and perform automated operations. Bugfixes and polish are constantly trickling in along with the larger feature releases.
 
 ### What Features Are You Planning on Adding?
 
-Of the several features I have planned for the project, these are broken up into “priority” features and “future” features. Priority features were originally intended for the first public release, however are currently absent from the Alpha v9.x.x builds.
+See the [Feature Roadmap](https://docs.tagstud.io/updates/roadmap/) page for the core features being planned and implemented for TagStudio. For a more up to date look on what's currently being added for upcoming releases, see our GitHub [milestones](https://github.com/TagStudioDev/TagStudio/milestones) for versioned releases.
 
-#### Priority Features
+### Features That Will NOT Be Added
 
-- Improved search
-  - Sortable Search
-  - Boolean Search
-  - Coexisting Text + Tag Search
-  - Searchable File Metadata
-- Tag management view
-- Applying metadata via multi-selection
-- Easier ways to apply tags in bulk
-  - Tag Search Panel
-  - Recent Tags Panel
-  - Top Tags Panel
-  - Pinned Tags Panel
-- Apply tags based on system folders
-- Better (stable, performant) library grid view
-- Improved entry relinking
-- Cached thumbnails
-- Collations
-- Resizable thumbnail grid
-- User-defined metadata fields
-- Multiple directory support
-- SQLite (or similar) save files
-- Reading of EXIF and XMP fields
-- Improved UI/UX
-- Better internal API for accessing Entries, Tags, Fields, etc. from the library.
-- Proper testing workflow
-- Continued code cleanup and modularization
-- Reassessment of save file structure in order to prioritize portability (leading to exportable tags, presets, etc)
+-   Native Cloud Integration
+    -   There are plenty of services already (native or third-party) that allow you to mount your cloud drives as virtual drives on your system. Hosting a TagStudio library on one of these mounts should function similarly to what native integration would look like.
+    -   Supporting native cloud integrations such as these would be an unnecessary "reinventing the wheel" burden for us that is outside the scope of this project.
+-   Native ChatGPT/Non-Local LLM Integration
+    -   This could mean different things depending on your intentions. Whether it's trying to use an LLM to replace the native search, or to trying to use a model for image recognition, I'm not interested in hooking people's TagStudio libraries into non-local LLMs such as ChatGPT and/or turn the program into a "chatbot" interface (see: [Goals/Privacy](#goals)). I wouldn't, however, mind using **locally** hosted models to provide the _optional_ ability for additional searching and tagging methods (especially when it comes to facial recognition) - but this would likely take the form of plugins external to the core program anyway.
 
-#### Future Features
+### Why Is this Already Version 9?
 
-- Support for multiple simultaneous users/clients
-- Draggable files outside the program
-- Ability to ignore specific files
-- A finished “macro system” for automatic tagging based on predetermined criteria.
-- Different library views
-- Date and time fields
-- Entry linking/referencing
-- Audio waveform previews
-- 3D object previews
-- Additional previews for miscellaneous file types
-- Exportable/sharable tags and settings
-- Optional global tags and settings, spanning across libraries
-- Importing & exporting libraries to/from other programs
-- Port to a more performant language and modern frontend (Rust?, Tauri?, etc.)
-- Plugin system
-- Local OCR search
-- Support for local machine learning-based tag suggestions for images
-- Mobile version
-
-#### Features I Likely Won’t Add/Pull
-- Native Cloud Integration 
-  - There are plenty of services already (native or third-party) that allow you to mount your cloud drives as virtual drives on your system. Pointing TagStudio to one of these mounts should function similarly to what native integration would look like.
-- Native ChatGPT/Non-Local LLM Integration
-  - This could mean different things depending on what you're intending. Whether it's trying to use an LLM to replace the native search, or to trying to use a model for image recognition, I'm not interested in hooking people's TagStudio libraries into non-local LLMs such as ChatGPT and/or turn the program into a "chatbot" interface (see: [Goals/Privacy](#goals)). I wouldn't, however, mind using **locally** hosted models to provide the *optional* ability for additional searching and tagging methods (especially when it comes to facial recognition).
-
-### Why Is the Version Already v9?
-
-I’ve been developing this project over several years in private, and have gone through several major iterations and rewrites in that time. This “major version” is just a number at the end of the day, and if I wanted to I couldn’t released this as “Version 0” or “Version 1.0”, but I’ve decided to stick to my original version numbers to avoid needing to go in and change existing documentation and code comments. Version 10 is intended to include all of the “Priority Features” I’ve outlined in the [previous](#what-features-are-you-planning-on-adding) section. I’ve also labeled this version as an Alpha, and will likely reset the numbers when a feature-complete beta is reached.
-
-### Wait, Is There a CLI Version?
-
-As of right now, no. However, I _did_ have a CLI version in the recent past before dedicating my efforts to the Qt GUI version. I’ve left in the currently-inoperable CLI code just in case anyone was curious about it. Also yes, it’s just a bunch of glorified print statements (_the outlook for some form of curses on Windows didn’t look great at the time, and I just needed a driver for the newly refactored code...)._
-
-### Can I Contribute?
-
-**Yes!!** I recommend taking a look at the [Priority Features](#priority-features), [Future Features](#future-features), and [Features I Won't Pull](#features-i-likely-wont-addpull) lists, as well as the project issues to see what’s currently being worked on. Please do not submit pull requests with new feature additions without opening up an issue with a feature request first.
-
-As of writing I don’t have a concrete style guide, just try to stay within or close enough to the PEP 8 style guide and/or match the style of the existing code.
+Over the first few years of private development the project went through several major iterations and rewrites. These major version bumps came quickly, and by the time TagStudio was opened-sourced the version number had already reached v9.0. Instead of resetting to "v0.0" or "v1.0" for this public release I decided to keep my v9.x numbering scheme and reserve v10.0 for when all the core features on the [Feature Roadmap](https://docs.tagstud.io/updates/roadmap/) are implemented. I’ve also labeled this version as an "Alpha" and will drop this once either all of the core features are implemented or the project feels stable and feature-rich enough to be considered "Beta" and beyond.

TagStudio.sh

@@ -1,5 +1,7 @@
-#! /bin/bash
-python3 -m venv .venv
+#! /usr/bin/env bash
+set -e
+cd "$(dirname "$0")"
+! [ -d .venv ] && python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
-python tagstudio/tagstudio.py
+python tagstudio/tag_studio.py

doc/documentation.md

@@ -1,189 +0,0 @@
-# TagStudio Documentation (Alpha v9.1.0)
-
-## _A User-Focused Document Management System_
-
-> [!WARNING]
-> This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
-
-## Contents
-- [Library](#library)
-- [Fields](#fields)
-- [Entries](#entries)
-- [Tags](#tags)
-- [Retrieving Entries](#retrieving-entries-based-on-tag-cluster)
-- [Missing File Resolution](#missing-file-resolution)
-
-## Library
-
-The Library is how TagStudio represents your chosen directory. In this Library or Vault system, all files within this directory are represented by Entries, which then contain metadata Fields. All TagStudio data for a Library is stored within a `.TagStudio` folder at the root of the Library's directory. Internal Library objects include:
-
-- Fields (v9+)
-  - Text Line (Title, Author, Artist, URL)
-  - Text Box (Description, Notes)
-  - Tag Box (Tags, Content Tags, Meta Tags)
-  - Datetime (Date Created, Date Modified, Date Taken) [WIP]
-  - Collation (Collation) [WIP]
-    - `name: str`: Collation Name
-    - `page: int`: Page #
-  - Checkbox (Archive, Favorite) [WIP]
-  - Drop Down (Group of Tags to select one from) [WIP]
-- Entries (v1+)
-- Tags (v7+)
-- Macros (v9/10+)
-
-## Fields
-
-Fields are the the building blocks of metadata stored in Entires. Fields have several base types for representing different types of information, including:
-
-- `text_line`
-  - A string of text, displayed as a single line.
-  - Useful for Titles, Authors, URLs, etc.
-- `text_box`
-  - A long string of text displayed as a box of text.
-  - Useful for descriptions, notes, etc.
-- `datetime` [WIP]
-  - A date and time value.
-- `tag_box`
-  - A box of tags added by the user.
-  - Multiple tag boxes can be used to separate classifications of tags, ex. 'Content Tags' and 'Meta Tags'.
-- `checkbox` [WIP]
-  - A two-state checkbox.
-  - Can be associated with a tag for quick organization.
-- `collation` [WIP]
-  - A collation is a collection of files that are intended to be displayed and retrieved together. Examples may include pages of a book or document that are spread out across several individual files. If you're intention is to associate files across multiple 'collations', use Tags instead!
-
-## Entries
-
-Entries are the representations of your files within the Library. They consist of a reference to the file on your drive, as well as the metadata associated with it.
-
-### Entry Object Structure (v9):
-
-- `id`:
-  - ID for the Entry.
-    - Int, Unique, Required
-    - Used for internal processing
-- `filename`:
-  - The filename with extension of the referenced media file.
-    - String, Required
-- `path`:
-  - The folder path in which the media file is located in.
-    - String, Required, OS Agnostic
-- `fields`:
-  - A list of Field ID/Value dicts.
-    - List of dicts, Optional
-
-NOTE: _Entries currently have several unused optional fields intended for later features._
-
-## Tags
-
-**Tags** are small data objects that represent an attribute of something. A person, place, thing, concept, you name it! Tags in TagStudio allow for more sophisticated Entry organization and searching thanks to their ability to contain alternate names and spellings via `aliases`, relational organization thanks to inherent `subtags`, and more! Tags can be as simple or as powerful as you want to make them, and TagStudio aims to provide as much power to you as possible.
-
-### Tag Object Structure (v9):
-
-- `id`:
-  - ID for the Tag.
-    - Int, Unique, Required
-    - Used for internal processing
-- `name`:
-  - The normal name of the Tag, with no shortening or specification.
-    - String, Required
-    - Doesn't have to be unique
-    - Each word analyzed individually
-    - Used for display, searching, and storing
-- `shorthand`:
-  - The shorthand name for the Tag.
-    - String, Optional
-    - Doesn't have to be unique
-    - Entire string analyzed as-is
-    - Used for display and searching
-- `aliases`:
-  - Alternate names for the Tag.
-    - List of Strings, Optional
-    - Recommended to be unique to this Tag
-    - Entire string analyzed as-is
-    - Used for searching
-- `subtags`:
-  - Other Tags that make up properties of this Tag.
-    - List of Strings, Optional
-    - Used for display (first subtag only) and searching.
-- `color`:
-  - A hex code value for customizing the Tag's display color
-    - String, Optional
-    - Used for display
-
-### Tag Examples:
-
-#### League of Legends
-
-- `name`: "League of Legends"
-- `shorthand`: "LoL"
-- `aliases`: ["League"]
-- `subtags`: ["Game", "Fantasy"]
-
-#### Arcane
-
-- `name`: "Arcane"
-- `shorthand`: ""
-- `aliases`: []
-- `subtags`: ["League of Legends", "Cartoon"]
-
-#### Jinx (LoL)
-
-- `name`: "Jinx Piltover"
-- `shorthand`: "Jinx"
-- `aliases`: ["Jinxy", "Jinxy Poo"]
-- `subtags`: ["League of Legends", "Arcane", "Character"]
-
-#### Zander (Arcane)
-
-- `name`: "Zander Zanderson"
-- `shorthand`: "Zander"
-- `aliases`: []
-- `subtags`: ["Arcane", "Character"]
-
-#### Mr. Legend (LoL)
-
-- `name`: "Mr. Legend"
-- `shorthand`: ""
-- `aliases`: []
-- `subtags`: ["League of Legends", "Character"]
-
-### Query "League of Legends" returns results for:
-
-- League of Legends [because of "League of Legend"'s name]
-- Arcane [because of "Arcane"'s subtag]
-- Jinx (LoL) [because of "Jinx Piltover"'s subtag]
-- Mr. Legend (LoL) [because of "Mr. Legned (LoL)'s subtag"]
-- Zander (Arcane) [because of "Zander Zanderson"'s subtag ("Arcane")'s subtag]
-
-### Query "LoL" returns results for:
-
-- League of Legends [because of "League of Legend"'s shorthand]
-- LoL [because of "League of Legend"'s shorthand]
-- Arcane [because of "Arcane"'s subtag]
-- Jinx (LoL) [because of "Jinx Piltover"'s subtag]
-- Mr. Legend (LoL) [because of "Mr. Legned (LoL)'s subtag"]
-- Zander (Arcane) [because of "Zander Zanderson"'s subtag ("Arcane")'s subtag]
-
-### Query "Arcane" returns results for:
-
-- Arcane [because of "Arcane"'s name]
-- Jinx (LoL) [because of "Jinx Piltover"'s subtag "Arcane"]
-- Zander (Arcane) [because of "Zander Zanderson"'s subtag]
-
-## Retrieving Entries based on Tag Cluster
-
-By default when querying Entries, each Entry's `tags` list (stored in the form of Tag `id`s) is compared against the Tag `id`s in a given Tag cluster (list of Tag `id`s) or appended clusters in the case of multi-term queries. The type of comparison depends on the type of query and whether or not it is an inclusive or exclusive query, or a combination of both. This default searching behavior is done in _O(n)_ time, but can be sped up in the future by building indexes on certain search terms. These indexes can be stored on disk and loaded back into memory in future sessions. These indexes will also need to be updated as new Tags and Entries are added or edited.
-
-## Missing File Resolution
-
-1. Refresh missing file list (`refresh missing`) (Automatically run if library has few entries)
-2. Fix missing files screen (`fix missing`)
-
-### Fix Missing Files Screen
-
-0. **Match Search** (Determines if entries can be fixed) Scans for filename in library directory
-1. **Quick Fixes** (one match found, no existing entry)
-2. **Match Selection** (multiple matches found)
-3. **Merge Conflict Resolution** (match has existing entry)
-   Any remaining missing files can be listed, but they probably really are missing at this point. You can update the path and filename to point to new files if you know where they should actually be pointing to.

docs/CNAME

@@ -0,0 +1 @@
+docs.tagstud.io

docs/help/ffmpeg.md

@@ -0,0 +1,54 @@
+# FFmpeg
+
+FFmpeg is required for thumbnail previews and playback features on audio and video files. FFmpeg is a free Open Source project dedicated to the handling of multimedia (video, audio, etc) files. For more information, see their official website at [ffmpeg.org](https://www.ffmpeg.org/).
+
+## Installation on Windows
+
+### Prebuilt Binaries
+
+Pre-built binaries from trusted sources are available on the [FFmpeg website](https://www.ffmpeg.org/download.html). Under "More downloading options" click on the Windows section, then under "Windows EXE Files" select a source to download a build from. Follow any further download instructions from whichever build website you choose.
+
+![Windows Download Location](../assets/ffmpeg_windows_download.png)
+
+<!-- prettier-ignore -->
+!!! warning
+    Do NOT download the source code by mistake!
+
+To Install:
+
+1. Download 7z or zip file and extract it (right click > Extract All)
+2. Move extracted contents to a unique folder (i.e; `c:\ffmpeg` or `c:\Program Files\ffmpeg`)
+3. Add FFmpeg to your system PATH
+
+    1. In Windows, search for or go to "Edit the system environment variables" under the Control Panel
+    2. Under "User Variables", select "Path" then edit
+    3. Click new and add `<Your folder>\bin` (e.g; `c:\ffmpeg\bin` or `c:\Program Files\ffmpeg\bin`)
+    4. Click "Okay"
+
+### Package Managers
+
+FFmpeg is also available from:
+
+1. WinGet (`winget install ffmpeg`)
+2. Scoop (`scoop install main/ffmpeg`)
+3. Chocolatey (`choco install ffmpeg-full`)
+
+## Installation on Mac
+
+### Homebrew
+
+FFmpeg is available under the macOS section of the [FFmpeg website](https://www.ffmpeg.org/download.html) or can be installed via [Homebrew](https://brew.sh/) using `brew install ffmpeg`.
+
+## Installation on Linux
+
+### Package Managers
+
+FFmpeg may be installed by default on some Linux distributions, but if not, it is available via your distro's package manager of choice:
+
+1. Debian/Ubuntu (`sudo apt install ffmpeg`)
+2. Fedora (`sudo dnf install ffmpeg-free`)
+3. Arch (`sudo pacman -S ffmpeg`)
+
+# Help
+
+For additional help, please join the [Discord](https://discord.gg/hRNnVKhF2G) or create an Issue on the [GitHub repository](https://github.com/TagStudioDev/TagStudio)

docs/index.md

@@ -0,0 +1,52 @@
+---
+title: Home
+---
+
+# Welcome to the TagStudio Documentation!
+
+![TagStudio Alpha](assets/github_header.png)
+
+TagStudio is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
+
+<figure width="60%" markdown="span">
+
+  ![TagStudio screenshot](assets/screenshot.png)
+  
+  <figcaption>TagStudio Alpha v9.5.0 running on macOS Sequoia.</figcaption>
+
+</figure>
+
+## Feature Roadmap
+
+The [Feature Roadmap](updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
+
+## Current Features
+
+### Libraries
+
+-   Create [libraries](./library/index.md) centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
+-   Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu.
+
+### Tagging + Metadata Fields
+
+-   Add custom powerful [tags](./library/tag.md) to your library entries
+-   Add [metadata fields](./library/field.md) to your library entries, including:
+    -   Name, Author, Artist (Single-Line Text Fields)
+    -   Description, Notes (Multiline Text Fields)
+-   Create rich tags composed of a name, color, a list of aliases, and a list of “parent tags” - these being tags in which these tags inherit values from.
+-   Copy and paste tags and fields across file entries
+-   Automatically organize tags into groups based on parent tags marked as "categories"
+-   Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created)
+
+### Search
+
+-   [Search](./library/library_search.md) for file entries based on tags, file path (`path:`), file types (`filetype:`), and even media types! (`mediatype:`)
+-   Use and combine boolean operators (`AND`, `OR`, `NOT`) along with parentheses groups, quotation escaping, and underscore substitution to create detailed search queries
+-   Use special search conditions (`special:untagged`) to find file entries without tags or fields, respectively
+
+### File Entries
+
+-   Nearly all [file](./library/entry.md) types are supported in TagStudio libraries - just not all have dedicated thumbnail support.
+-   Preview most image file types, animated GIFs, videos, plain text documents, audio files, Blender projects, and more!
+-   Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location.
+-   Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option.

docs/install.md

@@ -0,0 +1,27 @@
+# Installation
+
+To download TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) section of the GitHub repository and download the latest release for your system under the "Assets" section. TagStudio is available for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. Windows and Linux builds are also available in portable versions if you want a more self-contained executable to move around.
+
+**We do not currently publish TagStudio to any package managers. Any TagStudio distributions outside of the GitHub releases page are _unofficial_ and not maintained by us.** Installation support will not be given to users installing from unofficial sources. Use these versions at your own risk.
+
+<!-- prettier-ignore -->
+!!! info "For macOS Users"
+    On macOS, you may be met with a message saying _""TagStudio" can't be opened because Apple cannot check it for malicious software."_ If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says _""TagStudio" was blocked from use because it is not from an identified developer."_ Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
+
+<!-- prettier-ignore -->
+!!! info "For Linux Users"
+    On Linux with non-Qt based Desktop Environments you may be unable to open TagStudio. You need to make sure that "xcb-cursor0" or "libxcb-cursor0" packages are installed. For more info check [Missing linux dependencies](https://github.com/TagStudioDev/TagStudio/discussions/182#discussioncomment-9452896)
+
+## Third-Party Dependencies
+
+-   For video thumbnails and playback, you'll also need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. If you encounter any issues with this, please reference our [FFmpeg Help](./help/ffmpeg.md) guide.
+
+## Optional Arguments
+
+Optional arguments to pass to the program:
+
+`--open <path>` / `-o <path>`
+: Path to a TagStudio Library folder to open on start.
+
+`--config-file <path>` / `-c <path>`
+: Path to the TagStudio config file to load.

docs/library/entry.md

@@ -0,0 +1,50 @@
+# File Entries
+
+File entries are the individual representations of your files inside a TagStudio [library](index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio.
+
+## Storage
+
+File entry data is storied within the `ts_library.sqlite` file inside each library's `.TagStudio` folder. No modifications are made to your actual files on disk, and nothing like sidecar files are generated for your files.
+
+## Appearance
+
+File entries appear as file previews both inside the thumbnail grid. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
+
+## Unlinked File Entries
+
+If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display a red chain-link icon for the thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel when a file becomes unlinked.
+
+To fix file entries that have become unlinked, select the "Fix Unlinked Entries" option from the Tools menu. From there, refresh the unlinked entry count and choose whether to search and relink you files, and/or delete the file entires from your library. This will NOT delete or modify any files on disk.
+
+## Internal Structure
+
+-   `id` (`INTEGER`/`int`, `UNIQUE`, `NOT NULL`, `PRIMARY KEY`)
+    -   The ID for the file entry.
+    -   Used for guaranteed unique references.
+-   `folder` (`INTEGER`/`int`, `NOT NULL`, `FOREIGN KEY`)
+    -   _Not currently used, may be removed._
+-   `path` (`VARCHAR`/`Path`, `UNIQUE`, `NOT NULL`)
+    -   The filename and filepath relative to the root of the library folder.
+    -   (E.g. for library "Folder", path = "any_subfolders/filename.txt")
+-   `suffix` (`VARCHAR`/`str`, `NOT NULL`)
+    -   The filename suffix with no leading dot.
+    -   Used for quicker file extension checks.
+-   `date_created` (`DATETIME`/`Datetime`)
+    -   _Not currently used, will be implemented in an upcoming update._
+    -   The creation date of the file (not the entry).
+    -   Generates from `st_birthtime` on Windows and Mac, and `st_ctime` on Linux.
+-   `date_modified` (`DATETIME`/`Datetime`)
+    -   _Not currently used, will be implemented in an upcoming update._
+    -   The latest modification date of the file (not the entry).
+    -   Generates from `st_mtime`.
+-   `date_added` (`DATETIME`/`Datetime`)
+    -   The date the file entry was added to the TagStudio library.
+
+### Table Relationships
+
+-   `tag_entries`
+    -   A relationship between `entry_id` to `tag_id`s from the `tags` table.
+-   `text_fields`
+    -   (TODO: determine the relationship for `entry_id`)
+-   `datetime_fields`
+    -   (TODO: determine the relationship for `entry_id`)

docs/library/entry_groups.md

@@ -0,0 +1,8 @@
+---
+tags:
+  - Upcoming Feature
+---
+
+# Entry Groups
+
+Entries can be grouped via tags marked as “groups” which when applied to different entries will signal TagStudio to treat those entries as a single group inside of searches and browsing.

docs/library/field.md

@@ -0,0 +1,23 @@
+# Fields
+
+Fields are additional types of metadata that you can attach to [file entries](entry.md). Like [tags](tag.md), fields are not stored inside files themselves nor in sidecar files, but rather inside the respective TagStudio [library](index.md) save file.
+
+## Field Types
+
+### Text Line
+
+A string of text, displayed as a single line.
+
+-   e.g: Title, Author, Artist, URL, etc.
+
+### Text Box
+
+A long string of text displayed as a box of text.
+
+-   e.g: Description, Notes, etc.
+
+### Datetime [WIP]
+
+A date and time value.
+
+-   e.g: Date Published, Date Taken, etc.

docs/library/index.md

@@ -0,0 +1,5 @@
+# Library
+
+The library is how TagStudio represents your chosen directory, with every file inside being represented by a [file entry](entry.md). You can have as many or few libraries as you wish, since each libraries' data is stored within a `.TagStudio` folder at its root. From there the library save file itself is stored as `ts_library.sqlite`, with TagStudio versions 9.4 and below using a the legacy `ts_library.json` format.
+
+Note that this means [tags](tag.md) you create only exist _per-library_.

docs/library/library_search.md

@@ -0,0 +1,121 @@
+# Library Search
+
+TagStudio provides various methods to search your library, ranging from TagStudio data such as tags to inherent file data such as paths or media types.
+
+## Boolean Operators
+
+TagStudio allows you to use common [boolean search](https://en.wikipedia.org/wiki/Full-text_search#Boolean_queries) operators when searching your library, along with [grouping](#grouping-and-nesting), [nesting](#grouping-and-nesting), and [character escaping](#escaping-characters). Note that you may need to use grouping in order to get the desired results you're looking for.
+
+### AND
+
+The `AND` operator will only return results that match **both** sides of the operator. `AND` is used implicitly when no boolean operators are given. To use the `AND` operator explicitly, simply type "and" (case insensitive) in-between items of your search.
+
+<!-- prettier-ignore -->
+!!! example
+    Searching for "Tag1 Tag2" will be treated the same as "Tag1 `AND` Tag2" and will only return results that contain both Tag1 and Tag2.
+
+### OR
+
+The `OR` operator will return results that match **either** the left or right side of the operator. To use the `OR` operator simply type "or" (case insensitive) in-between items of your search.
+
+<!-- prettier-ignore -->
+!!! example
+    Searching for "Tag1 `OR` Tag2" will return results that contain either "Tag1", "Tag2", or both.
+
+### NOT
+
+The `NOT` operator will returns results where the condition on the right is **false.** To use the `NOT` operator simply type "not" (case insensitive) in-between items of your search. You can also begin your search with `NOT` to only view results that do not contain the next term that follows.
+
+<!-- prettier-ignore -->
+!!! example
+    Searching for "Tag1 `NOT` Tag2" will only return results that contain "Tag1" while also not containing "Tag2".
+
+### Grouping and Nesting
+
+Searches can be grouped and nested by using parentheses to surround parts of your search query.
+
+<!-- prettier-ignore -->
+!!! example
+    Searching for "(Tag1 `OR` Tag2) `AND` Tag3" will return results any results that contain Tag3, plus one or the other (or both) of Tag1 and Tag2.
+
+### Escaping Characters
+
+Sometimes search queries have ambiguous characters and need to be "escaped". This is most common with tag names which contain spaces, or overlap with existing search keywords such as "[path:](#filename-and-path) of exile". To escape most search terms, surround the section of your search in plain quotes. Alternatively, spaces in tag names can be replaced by underscores.
+
+#### Valid Escaped Tag Searches
+
+-   "Tag Name With Spaces"
+-   Tag_Name_With_Spaces
+
+#### Invalid Escaped Tag Searches
+
+-   Tag Name With Spaces
+    -   Reason: Ambiguity between a tag named "Tag Name With Spaces" and four individual tags called "Tag", "Name", "With", "Spaces".
+
+## Tags
+
+[Tag](#tags) search is the default mode of file entry search in TagStudio. No keyword prefix is required, however using `tag:` will also work. The tag search attempts to match tag [names](tag.md#name), [shorthands](tag.md#shorthand), [aliases](tag.md#aliases), as well as allows for tags to [substitute](tag.md#intuition-via-substitution) in for any of their [parent tags](tag.md#parent-tags).
+
+You may also see the `tag_id:` prefix keyword show up with using the right-click "Search for Tag" option on tags. This is meant for internal use, and eventually will not be displayed or accessible to the user.
+
+## Fields
+
+_[Field](field.md) search is currently not in the program, however is coming in a future version._
+
+## File Entry Search
+
+### Filename and Path
+
+Filename and path search is available via the `path:` keyword and comes in a few different styles. By default, any string that follows the `path:` keyword will be searched as a substring inside a file's complete filepath. This means that given a file `folder/my_file.txt`, searching for `path: my_file` or `path: folder` will both return results for that file.
+
+#### Case Sensitivity
+
+TagStudio uses a "[smartcase](https://neovim.io/doc/user/options.html#'smartcase')"-like system for case sensitivity. This means that a search term typed in `lowercase` will be treated as **case-insensitive**, while a term typed in any `MixedCase` will be treated as **case-sensitive**. This makes it quicker to type searches when case sensitivity isn't required, while also providing a simple option to leverage case sensitivity when desired. Note that this means there's technically no way to currently search for a lowercase term while respecting case sensitivity.
+
+#### Glob Syntax
+
+Optionally, you may use [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax to search filepaths.
+
+#### Examples
+
+Given a file "Artwork/Piece.jpg", the following searches will return results for it:
+
+-   `path: artwork/piece.jpg`
+-   `path: Artwork/Piece.jpg`
+-   `path: piece.jpg`
+-   `path: Piece.jpg`
+-   `path: artwork`
+-   `path: rtwor`
+-   `path: ece.jpg`
+-   `path: iec`
+-   `path: artwork/*`
+-   `path: Artwork/*`
+-   `path: *piece.jpg*`
+-   `path: *Piece.jpg*`
+-   `path: *artwork*`
+-   `path: *Artwork*`
+-   `path: *rtwor*`
+-   `path: *ece.jpg*`
+-   `path: *iec*`
+-   `path: *.jpg`
+
+While the following searches will **NOT:**
+
+-   `path: ARTWORK/Piece.jpg` _(Reason: Mismatched case)_
+-   `path: *aRtWoRk/Piece*` _(Reason: Mismatched case)_
+-   `path: PieCe.jpg` _(Reason: Mismatched case)_
+-   `path: *PieCe.jpg*` _(Reason: Mismatched case)_
+
+## Special Searches
+
+Some predefined searches use the `special:` keyword prefix and give quick results for certain special search queries.
+
+### Untagged
+
+To see all your file entries which don't contain any tags, use the `special: untagged` search.
+
+### Empty
+
+**_NOTE:_** _Currently unavailable in v9.5.0_
+
+To see all your file entries which don't contain any tags _and_ any fields, use the `special: empty` search.

docs/library/tag.md

@@ -0,0 +1,131 @@
+# Tags
+
+Tags are discrete objects that represent some attribute. This could be a person, place, object, concept, and more. Unlike most tagging systems, TagStudio tags are not solely represented by a line of text or a hashtag. Tags in TagStudio consist of several properties and relationships that give extra customization, searching power, and ease of tagging that cannot be achieved by string-based tags alone. TagStudio tags are designed to be as simple or as complex as you'd like, giving options to users of all skill levels and use cases.
+
+## Naming Tags
+
+TagStudio tags do not share the same naming limitations of many other tagging solutions. The key standouts of tag names in TagStudio are:
+
+-   Tag names do **NOT** have to be unique
+-   Tag names are **NOT** limited to specific characters
+-   Tags can have **aliases**, a.k.a. alternate names to go by
+
+### Name
+
+This is the base name of a tag. It does not have to be unique, and can use any characters you wish. If your tag can go by multiple names, for example if it's the name of a person or something that's commonly shortened or abbreviated, then it's recommended that you put the full tag name here.
+
+### Shorthand
+
+This is a special type of alias that's used for shortening the tag name under special circumstances, mostly when screen space is limited. Tag shorthands can be searched for just like tag names and tag aliases.
+
+### Aliases
+
+Aliases are alternate names that the tag can go by. This may include individual first names for people, alternate spellings, shortened names, and more. If there's a common abbreviation or shortened name for your tag, it's recommended to use the [shorthand](#shorthand) field for this instead.
+
+When searching for a tag, aliases (including the shorthand) can also be used to find the tag. This not only includes searching for tags themselves, but for tagged [file entries](entry.md) as well!
+
+### Automatic Disambiguation
+
+Just as in real life, sometimes there are different attributes that share the same name with one another. The process of adding specificity to something in order to not confuse it with something similar is known as [disambiguation](https://en.wikipedia.org/wiki/Word-sense_disambiguation). In TagStudio we give the option to automatically disambiguate tag names based on a specially marked [Parent Tag](#parent-tags). Parent tags are explained in further detail below, but for the purposes of tag names they can lend themselves to clarifying the name of a tag without the user needing to manually change the name or add complicated aliases.
+
+Given a tag named "Freddy", we may confuse it with other "Freddy" tags in our library. There are lots of Freddys in the world, after all. If we're talking about Freddy from "Five Nights at Freddy's", then we may already (and likely should) have a separate "Five Nights at Freddy's" tag added as a parent tag. When the disambiguation box next to a parent tag is selected (see image below) then our tag name will automatically display its name with that parent tag's name (or shorthand if available) in parentheses.
+
+![Tag Disambiguation Example](../assets/tag_disambiguation_example.png)
+
+So if the "Five Night's at Freddy's" tag is added as a parent tag on the "Freddy" tag, and the disambiguation box next to it is checked, then our tag name will automatically be displayed as "Freddy (Five Nights at Freddy's)". Better yet, if the "Five Night's at Freddy's" tag has a shorthand such as "FNAF", then our "Freddy" tag will be displayed as "Freddy (FNAF)". This process preserves our base tag name ("Freddy") and provides an option to get a clean and consistent method to display disambiguating parent categories, rather than having to type this information in manually for each applicable tag.
+
+## Tag Relationships
+
+One of the core properties of tags in TagStudio is their ability to form relationships with other tags, just as attributes have relationships with each other in real life. A rectangle is a square, but a square isn't a rectangle. A certain plumber with a red hat and blue overalls might be part of a well-known media franchise, developed by an equally well-known company. But how do representing these relationships help with tagging images and files? With tag relationships, we can leverage the following principles:
+
+1. [Simplicity via Deduplication](#simplicity-via-deduplication)
+2. [Intuition via Substitution](#intuition-via-substitution)
+3. [Rediscovery via Linking](#rediscovery-via-linking)
+
+### Parent Tags
+
+#### Simplicity via Deduplication
+
+In a system where tags have no relationships, you're required to add as many tags as you possibly can to describe every last element of an image or file. If you want to tag an image of Shrek, you need to add a tag for `Shrek` himself, a `Character` tag since he's a character, a `Movie` and perhaps `Dreamworks` tag since he's a character from a movie, or perhaps a `Book` tag if we're talking about the original character, and then of course tags for every other attribute of Shrek shown or implied. By allowing tags to have inheritance relationships, we can have a single `Shrek` tag inherit from `Character` (Shrek IS a character) as well as from a separate `Shrek (Movie Franchise)` tag that itself inherits from `Movie Franchise` and `Dreamworks`. Now by simply adding the `Shrek` tag to an image, we've effectively also added the `Character`, `Shrek (Move Franchise)`, `Movie Franchise`, and `Dreamworks` attributes all in one go. On the image entry itself we only see `Shrek`, but the rest of the attributes are implied.
+
+![Shrek Tag Details](../assets/built_tag_shrek.png)
+
+#### Intuition via Substitution
+
+Now when searching for for images that have `Dreamworks` and `Character`, any images or files originally just tagged with `Shrek` will appear as you would expect. A little bit of tag setup goes a long way not only saving so much time during tagging, but also to ensure an intuitive way to search your files!
+
+#### Rediscovery via Linking
+
+Lastly, when searching your files with broader categories such as `Character` or `Dreamworks` you may rediscover images and files that you had simply tagged with tags such as `Barbatus` or `Tulio`, since you didn't need to manually tag those files with `Character` or `Dreamworks`, but had forgotten that they are both in fact Dreamworks characters. While you focus on tagging your files with seemingly surface level attributes, your TagStudio library is building rich connections between tags and files that may not be fully apparent until being discovered through various search queries. While you were simply tagging images with `Shrek` and `Tulio`, you may have unlocked an easy way to search for "2D Dreamworks Characters" without having to explicitly tag for that!
+
+### Component Tags
+
+**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
+
+Component tags will be built from a composition-based, or "HAS" type relationship between tags. This takes care of instances where an attribute may "have" another attribute, but doesn't inherit from it. Shrek may be an `Orge`, he may be a `Character`, but he is NOT a `Leather Vest` - even if he's commonly seen _with_ it. Component tags, along with the upcoming [Tag Override](tag_overrides.md) feature, are built to handle these cases in a way that still simplifies the tagging process without adding too much undue complexity for the user.
+
+## Tag Appearance
+
+### Color
+
+Tags use a default uncolored appearance by default, however can take on a number of built-in and user-created colors and color palettes! Tag color palettes can be based on a single color value (see: TagStudio Standard, TagStudio Shades, TagStudio Pastels) or use an optional secondary color use for the text and optionally the tag border (e.g. TagStudio Neon).
+
+![Tag Color Selection](../assets/tag_color_selection.png)
+
+#### User-Created Colors
+
+Custom palettes and colors can be created via the [Tag Color Manager](./tag_color.md). These colors will display alongside the built-in colors inside the tag selection window and are separated by their namespace names. Colors which use the secondary color for the tag border will be outlined in that color, otherwise they will only display the secondary color on the bottom of the swatch to indicate at a glance that the text colors are different.
+
+![Custom Tag Color Selection](../assets/custom_tag_color_selection.png)
+
+### Icon
+
+**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
+
+## Tag Properties
+
+Properties are special attributes of tags that change their behavior in some way.
+
+#### Is Category
+
+When the "Is Category" property is checked, this tag now acts as a category separator inside the preview panel. If this tag or any tags inheriting from this tag (i.e. tags that have this tag as a "[Parent Tag](#parent-tags)"), then these tags will appear under a separated group that's named after this tag. Tags inheriting from multiple "category tags" will still show up under any applicable category. _Read more under: [Tag Categories](../library/tag_categories.md)._
+
+![Tag Category Example](../assets/tag_categories_example.png)
+
+#### Is Hidden
+
+**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
+
+When the "Is Hidden" property is checked, any file entries tagged with this tag will not show up in searches by default. This property comes by default with the built-in "Archived" tag.
+
+## Tag Search Examples
+
+The following are examples of how a set of given tags will respond to various search queries.
+
+| Tag                 | Name                | Shorthand | Aliases                | Parent Tags                                  |
+| ------------------- | ------------------- | --------- | ---------------------- | -------------------------------------------- |
+| _League of Legends_ | "League of Legends" | "LoL"     | ["League"]             | ["Game", "Fantasy"]                          |
+| _Arcane_            | "Arcane"            | ""        | []                     | ["League of Legends", "Cartoon"]             |
+| _Jinx (LoL)_        | "Jinx Piltover"     | "Jinx"    | ["Jinxy", "Jinxy Poo"] | ["League of Legends", "Arcane", "Character"] |
+| _Zander (Arcane)_   | "Zander Zanderson"  | "Zander"  | []                     | ["Arcane", "Character"]                      |
+| _Mr. Legend (LoL)_  | "Mr. Legend"        | ""        | []                     | ["League of Legends", "Character"]           |
+
+**The query "Arcane" will display results tagged with:**
+
+| Tag             | Cause of Inclusion               | Tag Tree Lineage           |
+| --------------- | -------------------------------- | -------------------------- |
+| Arcane          | Direct match of tag name         | "Arcane"                   |
+| Jinx (LoL)      | Search term is set as parent tag | "Jinx (LoL) > Arcane"      |
+| Zander (Arcane) | Search term is set as parent tag | "Zander (Arcane) > Arcane" |
+
+**The query "League of Legends" will display results tagged with:**
+
+| Tag               | Cause of Inclusion                                     | Tag Tree Lineage                               |
+| ----------------- | ------------------------------------------------------ | ---------------------------------------------- |
+| League of Legends | Direct match of tag name                               | "League of Legends"                            |
+| Arcane            | Search term is set as parent tag                       | "Arcane > League of Legends"                   |
+| Jinx (LoL)        | Search term is set as parent tag                       | "Jinx (LoL) > League of Legends"               |
+| Mr. Legend (LoL)  | Search term is set as parent tag                       | "Mr. Legend (LoL) > League of Legends"         |
+| Zander (Arcane)   | Search term is a parent tag of a tag set as parent tag | "Zander (Arcane) > Arcane > League of Legends" |
+
+Note: The query "LoL" will display the same results as the above example since "LoL" is the shorthand for "League of Legends".

docs/library/tag_categories.md

@@ -0,0 +1,17 @@
+---
+tags:
+---
+
+# Tag Categories
+
+The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized inside the preview panel. Tags marked as categories will show themselves and all tags inheriting from it (including recursively) underneath a field-like section with the tag's name. This means that duplicates of tags can appear on entries if the tag inherits from multiple parent categories, however this is by design and reflects the nature multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
+
+![Tag Categories Example](../assets/tag_categories_example.png)
+
+### Built-In Tags and Categories
+
+The built-in tags "Favorite" and "Archived" inherit from the built-in "Meta Tags" category which is marked as a category by default. This behavior of default tags can be fully customized by disabling the category option and/or by adding/removing the tags' Parent Tags.
+
+### Migrating from v9.4 Libraries
+
+Due to the nature of how tags and Tag Felids operated prior to v9.5, the organization style of Tag Categories vs Tag Fields is not 1:1. Instead of tags being organized into fields on a per-entry basis, tags themselves determine their organizational layout via the "Is Property" flag. Any tags _(not currently inheriting from either the "Favorite" or "Archived" tags)_ will be shown under the default "Tags" header upon migrating to the v9.5+ library format. Similar organization to Tag Fields can be achieved by using the built-in "Meta Tags" tag or any other marked with "Is Category" and then setting those tags as parents for other tags to inherit from.

docs/library/tag_color.md

@@ -0,0 +1,71 @@
+# Tag Colors
+
+TagStudio features a variety of built-in tag colors, alongside the ability for users to create their own custom tag color palettes.
+
+## Tag Color Manager
+
+The Tag Color Manager is where you can create and manage your custom tag colors and associated namespaces. To open the Tag Color Manager, go to "File -> Manage Tag Colors" option in the menu bar.
+
+![Tag Color Manager](../assets/tag_color_manager.png)
+
+## Creating a Namespace
+
+TagStudio uses namespaces to group colors into palettes. Namespaces are a way for you to use the same color name across multiple palettes without having to worry about [name collision](https://en.wikipedia.org/wiki/Name_collision) with other palettes. This is especially useful when sharing your color palettes with others!\*
+
+_\* Color pack sharing coming in a future update_
+
+To create your first namespace, either click the "New Namespace" button or the large button prompt underneath the built-in colors.
+
+![Create Namespace](../assets/create_namespace.png)
+
+### Name
+
+The display name of the namespace, used for presentation.
+
+### ID Slug
+
+An internal ID for the namespace which is automatically derived from the namespace name.
+
+Namespaces beginning with "tagstudio" are reserved by TagStudio and will automatically have their text changed.
+
+<!-- prettier-ignore -->
+!!! note
+    It's currently not possible to manually edit the Namespace ID Slug. This will be possible once sharable color packs are added.
+
+## Creating a Color
+
+Once you've created your first namespace, click the "+" button inside the namespace section to create a color. To edit a color that you've previously created, either click on the color name or right click and select "Edit Color" from the context menu.
+
+![Create Color (Primary Color)](../assets/custom_color_primary_only.png)
+
+### Name
+
+The display name for the color, used for presentation. You may occasionally see the color name followed by the [namespace name](#name) in parentheses to disambiguate it from other colors with the same name.
+
+### ID Slug
+
+Similar to [Namespace ID Slugs](#id-slug), the ID Slug is used as an internal ID and is automatically derived from the tag color name.
+
+<!-- prettier-ignore -->
+!!! note
+    It's currently not possible to manually edit the Color ID Slug. This will be possible once sharable color packs are added.
+
+### Primary Color
+
+The primary color is used as the main tag color and by default is used as the background color with the text and border colors being derived from this color.
+
+### Secondary Color
+
+By default, the secondary color is only used as an optional override for the tag text color. This color can be cleared by clicking the adjacent "Reset" button.
+
+![Create Color (Secondary Color)](../assets/custom_color_no_border.png)
+
+The secondary color can also be used as the tag border color by checking the "Use Secondary Color for Border" box.
+
+![Create Color (Use Secondary for Border)](../assets/custom_color_border.png)
+
+## Using Colors
+
+When editing a tag, click the tag color button to bring up the tag color selection panel. From here you can choose any built-in TagStudio color as well as any of your custom colors.
+
+![Tag Color Selection](../assets/tag_color_selection.png)

docs/library/tag_overrides.md

@@ -0,0 +1,20 @@
+---
+tags:
+    - Upcoming Feature
+---
+
+# Tag Overrides
+
+Tag overrides are the ability to add or remove [parent tags](tag.md#parent-tags) from a [tag](tag.md) on a per- [entry](entry.md) basis.
+
+## Examples
+
+<figure markdown="span">
+  ![Example 1](../assets/tag_override_ex-1.png){ height="300" }
+  <figcaption>Ex. 1 - Comparing standard tag composition vs additive and subtractive inheritance overrides.</figcaption>
+</figure>
+
+<figure markdown="span">
+  ![Example 2](../assets/tag_override_ex-2.png){ height="300" }
+  <figcaption>Ex. 2 - Parent tag swap using tag overrides.</figcaption>
+</figure>

docs/updates/changelog.md

@@ -0,0 +1,4 @@
+---
+title: Changelog
+---
+--8<-- "CHANGELOG.md"

docs/updates/roadmap.md

@@ -0,0 +1,217 @@
+# Feature Roadmap
+
+This checklist details the current and remaining features required at a minimum for TagStudio to be considered “Feature Complete”. This list is _not_ a definitive list for additional feature requests and PRs as they come in, but rather an outline of my personal core feature set intended for TagStudio.
+
+## Priorities
+
+Features are broken up into the following priority levels, with nested priorities referencing their relative priority for the overall feature (i.e. A [LOW] priority feature can have a [HIGH] priority element but it otherwise still a [LOW] priority item overall):
+
+-   [HIGH] - Core feature
+-   [MEDIUM] - Important but not necessary
+-   [LOW] - Just nice to have
+
+## Version Milestones
+
+These version milestones are rough estimations for when the previous core features will be added. For a more definitive idea for when features are coming, please reference the current GitHub [milestones](https://github.com/TagStudioDev/TagStudio/milestones).
+
+<!-- prettier-ignore -->
+!!! note
+    This list was created after the release of version 9.4
+
+### v9.5
+
+#### Core
+
+-   [x] SQL backend [HIGH]
+
+#### Tags
+
+-   [x] Deleting Tags [HIGH]
+-   [ ] User-defined tag colors [HIGH]
+    -   [x] ID based, not string or hex [HIGH]
+    -   [x] Color name [HIGH]
+    -   [x] Color value (hex) [HIGH]
+    -   [x] Existing colors are now a set of base colors [HIGH]
+-   [x] [Tag Categories](../library/tag_categories.md) [HIGH]
+    -   [x] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title [HIGH]
+
+#### Search
+
+-   [x] Boolean operators [HIGH]
+-   [x] Filename search [HIGH]
+-   [x] Filetype search [HIGH]
+    -   [x] Search by extension (e.g. ".jpg", ".png") [HIGH]
+        -   [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") [LOW]
+    -   [x] Search by media type (e.g. "image", "video", "document") [MEDIUM]
+-   [x] Sort by date added [HIGH]
+
+#### UI
+
+-   [ ] Translations _(Any applicable)_ [MEDIUM]
+
+#### Performance
+
+-   [x] Thumbnail caching [HIGH]
+
+### v9.6
+
+#### Core
+
+-   [ ] Cached file property table (media duration, word count, dimensions, etc.) [MEDIUM]
+
+#### Library
+
+-   [ ] Multiple Root Directories per Library [HIGH]
+-   [ ] `.ts_ignore` (`.gitignore`-style glob ignoring) [HIGH]
+-   [ ] Sharable Color Packs [MEDIUM]
+    -   [ ] Human-readable (TOML) files containing tag data [HIGH]
+    -   [ ] Importable [HIGH]
+    -   [ ] Exportable [HIGH]
+
+#### Tags
+
+-   [ ] Merging Tags [HIGH]
+-   [ ] [Component/HAS](../library/tag.md#component-tags) subtags [HIGH]
+-   [ ] Tag Icons [HIGH]
+    -   [ ] Small Icons [HIGH]
+    -   [ ] Large Icons for Profiles [MEDIUM]
+    -   [ ] Built-in Icon Packs (i.e. Boxicons) [HIGH]
+    -   [ ] User Defined Icons [HIGH]
+-   [ ] Multiple Languages for Tag Strings [MEDIUM]
+    -   [ ] Title is tag name [HIGH]
+    -   [ ] Title has tag color [MEDIUM]
+    -   [ ] Tag marked as category does not display as a tag itself [HIGH]
+-   [ ] [Tag Overrides](../library/tag_overrides.md) [MEDIUM]
+    -   [ ] Per-file overrides of subtags [HIGH]
+
+#### Fields
+
+-   [ ] Datetime fields [HIGH]
+-   [ ] Custom field names [HIGH]
+
+#### Search
+
+-   [ ] Field content search [HIGH]
+-   [ ] Sort by date created [HIGH]
+-   [ ] Sort by date modified [HIGH]
+-   [ ] Sort by filename [HIGH]
+-   [ ] HAS operator for composition tags [HIGH]
+-   [ ] Search bar rework
+    -   [ ] Improved tag autocomplete [HIGH]
+    -   [ ] Tags appear as widgets in search bar [HIGH]
+
+#### UI
+
+-   [ ] File duration on video thumbnails [HIGH]
+-   [ ] 3D Model Previews [MEDIUM]
+    -   [ ] STL Previews [HIGH]
+-   [ ] Word count/line count on text thumbnails [LOW]
+-   [ ] Settings Menu [HIGH]
+-   [ ] Application Settings [HIGH]
+    -   [ ] Stored in system user folder/designated folder [HIGH]
+-   [ ] Library Settings [HIGH]
+    -   [ ] Stored in `.TagStudio` folder [HIGH]
+-   [ ] Tagging Panel [HIGH]
+
+    Togglebale persistent main window panel or popout. Replaces the current tag manager.
+
+    -   [ ] Top Tags [HIGH]
+    -   [ ] Recent Tags [HIGH]
+    -   [ ] Tag Search [HIGH]
+    -   [ ] Pinned Tags [HIGH]
+
+-   [ ] New tabbed tag building UI to support the new tag features [HIGH]
+
+### v9.7
+
+#### Library
+
+-   [ ] [Entry groups](../library/entry_groups.md) [HIGH]
+    -   [ ] Groups for files/entries where the same entry can be in multiple groups [HIGH]
+    -   [ ] Ability to number entries within group [HIGH]
+    -   [ ] Ability to set sorting method for group [HIGH]
+    -   [ ] Ability to set custom thumbnail for group [HIGH]
+    -   [ ] Group is treated as entry with tags and metadata [HIGH]
+    -   [ ] Nested groups [MEDIUM]
+
+#### Search
+
+-   [ ] Sort by relevance [HIGH]
+-   [ ] Sort by date taken (photos) [MEDIUM]
+-   [ ] Sort by file size [HIGH]
+-   [ ] Sort by file dimension (images/video) [LOW]
+
+#### [Macros](../utilities/macro.md)
+
+-   [ ] Sharable Macros [MEDIUM]
+    -   [ ] Standard notation format (TOML) contacting macro instructions [HIGH]
+    -   [ ] Exportable [HIGH]
+    -   [ ] Importable [HIGH]
+-   [ ] Triggers [HIGH]
+    -   [ ] On new file [HIGH]
+    -   [ ] On library refresh [HIGH]
+    -   [ ] [...]
+-   [ ] Actions [HIGH]
+    -   [ ] Add tag(s) [HIGH]
+    -   [ ] Add field(s) [HIGH]
+    -   [ ] Set field content [HIGH]
+    -   [ ] [...]
+
+#### UI
+
+-   [ ] Custom thumbnail overrides [MEDIUM]
+-   [ ] Toggle File Extension Label [MEDIUM]
+-   [ ] Toggle Duration Label [MEDIUM]
+-   [ ] Custom Tag Badges [LOW]
+-   [ ] Unified Media Player [HIGH]
+    -   [ ] Auto-hiding player controls
+    -   [x] Play/Pause [HIGH]
+    -   [x] Loop [HIGH]
+    -   [x] Toggle Autoplay [MEDIUM]
+    -   [ ] Volume Control [HIGH]
+    -   [x] Toggle Mute [HIGH]
+    -   [ ] Timeline scrubber [HIGH]
+    -   [ ] Fullscreen [MEDIUM]
+-   [ ] Library list view [HIGH]
+-   [ ] Configurable page size [HIGH]
+
+### v9.8
+
+#### Library
+
+-   [ ] Automatic Entry Relinking [HIGH]
+    -   [ ] Detect Renames [HIGH]
+    -   [ ] Detect Moves [HIGH]
+    -   [ ] Detect Deletions [HIGH]
+
+#### Search
+
+-   [ ] OCR search [LOW]
+-   [ ] Fuzzy Search [LOW]
+
+### v9.9
+
+#### Library
+
+-   [ ] Exportable Library Data [HIGH]
+    -   [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
+
+#### Tags
+
+-   [ ] Tag Packs [MEDIUM]
+    -   [ ] Human-readable (TOML) files containing tag data [HIGH]
+    -   [ ] Multiple Languages for Tag Strings [MEDIUM]
+    -   [ ] Importable [HIGH]
+    -   [ ] Exportable [HIGH]
+    -   [ ] Conflict resolution [HIGH]
+
+### v10.0
+
+-   [ ] All remaining [HIGH] and optional [MEDIUM] features
+
+### Post v10.0
+
+#### Core
+
+-   [ ] Core Library/API
+-   [ ] Plugin Support

docs/updates/schema_changes.md

@@ -0,0 +1,46 @@
+# Save Format Changes
+
+This page outlines the various changes made the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
+
+## JSON
+
+| First Used | Last Used                                                               | Format | Location                                      |
+| ---------- | ----------------------------------------------------------------------- | ------ | --------------------------------------------- |
+| v1.0.0     | [v9.4.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.4.2) | JSON   | `<Library Folder>`/.TagStudio/ts_library.json |
+
+The legacy database format for public TagStudio releases [v9.1](https://github.com/TagStudioDev/TagStudio/tree/Alpha-v9.1) through [v9.4.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.4.2). Variations of this format had been used privately since v1.0.0.
+
+Replaced by the new SQLite format introduced in TagStudio [v9.5.0 Pre-Release 1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1).
+
+## DB_VERSION 6
+
+| First Used                                                                      | Last Used                                                                       | Format | Location                                        |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+The first public version of the SQLite save file format.
+
+Migration from the legacy JSON format is provided via a walkthrough when opening a legacy library in TagStudio [v9.5.0 Pre-Release 1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) or later.
+
+## DB_VERSION 7
+
+| First Used                                                                      | Last Used                                                                       | Format | Location                                        |
+| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.0-PR2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | [v9.5.0-PR3](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr3) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+### Changes
+
+-   Repairs "Description" fields to use a TEXT_LINE key instead of a TEXT_BOX key.
+-   Repairs tags that may have a disambiguation_id pointing towards a deleted tag.
+
+## DB_VERSION 8
+
+| First Used                                                                      | Last Used | Format | Location                                        |
+| ------------------------------------------------------------------------------- | --------- | ------ | ----------------------------------------------- |
+| [v9.5.0-PR4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | _Current_ | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+### Changes
+
+-   Adds the `color_border` column to `tag_colors` table. Used for instructing the [secondary color](../library/tag_color.md#secondary-color) to apply to a tag's border as a new optional behavior.
+-   Adds three new default colors: "Burgundy (TagStudio Shades)", "Dark Teal (TagStudio Shades)", and "Dark Lavender (TagStudio Shades)".
+-   Updates Neon colors to use the the new `color_border` property.

docs/usage.md

@@ -0,0 +1,64 @@
+# Usage
+
+## Creating/Opening a Library
+
+With TagStudio opened, start by creating a new library or opening an existing one using File -> Open/Create Library from the menu bar. TagStudio will automatically create a new library from the chosen directory if one does not already exist. Upon creating a new library, TagStudio will automatically scan your folders for files and add those to your library (no files are moved during this process!).
+
+## Refreshing the Library
+
+Libraries under 10,000 files automatically scan for new or modified files when opened. In order to refresh the library manually, select "Refresh Directories" under the File menu.
+
+## Adding Tags to File Entries
+
+Access the "Add Tag" search box by either clicking on the "Add Tag" button at the bottom of the right sidebar, accessing the "Add Tags to Selected" option from the File menu, or by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd>.
+
+From here you can search for existing tags or create a new one if the one you're looking for doesn't exist. Click the “+” button next to any tags you want to to the currently selected file entries. To quickly add the top result, press the <kbd>Enter</kbd>/<kbd>Return</kbd> key to add the the topmost tag and reset the tag search. Press <kbd>Enter</kbd>/<kbd>Return</kbd> once more to close the dialog box. By using this method, you can quickly add various tags in quick succession just by using the keyboard!
+
+To remove a tag from a file entry, hover over the tag in the preview panel and click on the "-" icon that appears.
+
+## Adding Metadata to File Entries
+
+To add a metadata field to a file entry, start by clicking the “Add Field” button at the bottom of the preview panel. From the dropdown menu, select the type of metadata field you’d like to add to the entry
+
+## Editing Metadata Fields
+
+### Text Line / Text Box
+
+Hover over the field and click the pencil icon. From there, add or edit text in the dialog box popup.
+
+## Creating Tags
+
+Create a new tag by accessing the "New Tag" option from the Edit menu or by pressing <kbd>Ctrl</kbd>+<kbd>T</kbd>. In the tag creation panel, enter a tag name, optional shorthand name, optional tag aliases, optional parent tags, and an optional color.
+
+-   The tag **name** is the base name of the tag. **_This does NOT have to be unique!_**
+-   The tag **shorthand** is a special type of alias that displays in situations where screen space is more valuable, notably with name disambiguation.
+-   **Aliases** are alternate names for a tag. These let you search for terms other than the exact tag name in order to find the tag again.
+-   **Parent Tags** are tags in which this this tag can substitute for in searches. In other words, tags under this section are parents of this tag.
+    -   Parent tags with the disambiguation check next to them will be used to help disambiguate tag names that may not be unique.
+    -   For example: If you had a tag for "Freddy Fazbear", you might add "Five Nights at Freddy's" as one of the parent tags. If the disambiguation box is checked next to "Five Nights at Freddy's" parent tag, then the tag "Freddy Fazbear" will display as "Freddy Fazbear (Five Nights at Freddy's)". Furthermore, if the "Five Nights at Freddy's" tag has a shorthand like "FNAF", then the "Freddy Fazbear" tag will display as "Freddy Fazbear (FNAF)".
+-   The **color** option lets you select an optional color palette to use for your tag.
+-   The **"Is Category"** property lets you treat this tag as a category under which itself and any child tags inheriting from it will be sorted by inside the preview panel.
+
+### Tag Manager
+
+You can manage your library of tags from opening the "Tag Manager" panel from Edit -> "Manage Tags". From here you can create, search for, edit, and permanently delete any tags you've created in your library.
+
+## Editing Tags
+
+To edit a tag, click on it inside the preview panel or right-click the tag and select “Edit Tag” from the context menu.
+
+## Relinking Moved Files
+
+Inevitably some of the files inside your library will be renamed, moved, or deleted. If a file has been renamed or moved, TagStudio will display the thumbnail as a red broken chain link. To relink moved files or delete these entries, select the "Manage Unlinked Entries" option under the Tools menu. Click the "Refresh" button to scan your library for unlinked entries. Once complete, you can attempt to “Search & Relink” any unlinked file entries to their respective files, or “Delete Unlinked Entries” in the event the original files have been deleted and you no longer wish to keep their entries inside your library.
+
+<!-- prettier-ignore -->
+!!! warning
+    There is currently no method to relink entries to files that have been renamed - only moved or deleted. This is a high priority for future releases.
+
+<!-- prettier-ignore -->
+!!! warning
+    If multiple matches for a moved file are found (matches are currently defined as files with a matching filename as the original), TagStudio will currently ignore the match groups. Adding a GUI for manual selection, as well as smarter automated relinking, are high priorities for future versions.
+
+### Saving the Library
+
+As of version 9.5, libraries are saved automatically as you go. To save a backup of your library, select File -> Save Library Backup from the menu bar.

docs/utilities/macro.md

@@ -0,0 +1,46 @@
+# Tools & Macros
+
+Tools and macros are features that serve to create a more fluid [library](../library/index.md)-managing process, or provide some extra functionality. Please note that some are still in active development and will be fleshed out in future updates.
+
+## Tools
+
+### Fix Unlinked Entries
+
+This tool displays the number of unlinked [entries](../library/entry.md), and some options for their resolution.
+
+Refresh
+: Scans through the library and updates the unlinked entry count.
+
+Search & Relink
+: Attempts to automatically find and reassign missing files.
+
+Delete Unlinked Entries
+: Displays a confirmation prompt containing the list of all missing files to be deleted before committing to or cancelling the operation.
+
+### Fix Duplicate Files
+
+This tool allows for management of duplicate files in the library using a [DupeGuru](https://dupeguru.voltaicideas.net/) file.
+
+Load DupeGuru File
+: load the "results" file created from a DupeGuru scan
+
+Mirror Entries
+: Duplicate entries will have their contents mirrored across all instances. This allows for duplicate files to then be deleted with DupeGuru as desired, without losing the [field](../library/field.md) data that has been assigned to either. (Once deleted, the "Fix Unlinked Entries" tool can be used to clean up the duplicates)
+
+### Create Collage
+
+This tool is a preview of an upcoming feature. When selected, TagStudio will generate a collage of all the contents in a Library, which can be found in the Library folder ("/your-folder/.TagStudio/collages/"). Note that this feature is still in early development, and doesn't yet offer any customization options.
+
+## Macros
+
+### Auto-fill [WIP]
+
+Tool is in development and will be documented in future update.
+
+### Sort fields
+
+Tool is in development, will allow for user-defined sorting of [fields](../library/field.md).
+
+### Folders to Tags
+
+Creates tags from the existing folder structure in the library, which are previewed in a hierarchy view for the user to confirm. A tag will be created for each folder and applied to all entries, with each subfolder being linked to the parent folder as a [parent tag](../library/tag.md#parent-tags). Tags will initially be named after the folders, but can be fully edited and customized afterwards.

flake.lock

@@ -0,0 +1,563 @@
+{
+  "nodes": {
+    "cachix": {
+      "inputs": {
+        "devenv": "devenv_2",
+        "flake-compat": [
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "devenv",
+          "nixpkgs"
+        ],
+        "pre-commit-hooks": [
+          "devenv",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1712055811,
+        "narHash": "sha256-7FcfMm5A/f02yyzuavJe06zLa9hcMHsagE28ADcmQvk=",
+        "owner": "cachix",
+        "repo": "cachix",
+        "rev": "02e38da89851ec7fec3356a5c04bc8349cae0e30",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "cachix",
+        "type": "github"
+      }
+    },
+    "devenv": {
+      "inputs": {
+        "cachix": "cachix",
+        "flake-compat": "flake-compat_2",
+        "nix": "nix_2",
+        "nixpkgs": "nixpkgs_2",
+        "pre-commit-hooks": "pre-commit-hooks"
+      },
+      "locked": {
+        "lastModified": 1724763216,
+        "narHash": "sha256-oW2bwCrJpIzibCNK6zfIDaIQw765yMAuMSG2gyZfGv0=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "1e4ef61205b9aa20fe04bf1c468b6a316281c4f1",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "devenv-root": {
+      "flake": false,
+      "locked": {
+        "narHash": "sha256-d6xi4mKdjkX2JFicDIv5niSzpyI0m/Hnm8GGAIU04kY=",
+        "type": "file",
+        "url": "file:///dev/null"
+      },
+      "original": {
+        "type": "file",
+        "url": "file:///dev/null"
+      }
+    },
+    "devenv_2": {
+      "inputs": {
+        "flake-compat": [
+          "devenv",
+          "cachix",
+          "flake-compat"
+        ],
+        "nix": "nix",
+        "nixpkgs": "nixpkgs",
+        "poetry2nix": "poetry2nix",
+        "pre-commit-hooks": [
+          "devenv",
+          "cachix",
+          "pre-commit-hooks"
+        ]
+      },
+      "locked": {
+        "lastModified": 1708704632,
+        "narHash": "sha256-w+dOIW60FKMaHI1q5714CSibk99JfYxm0CzTinYWr+Q=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "2ee4450b0f4b95a1b90f2eb5ffea98b90e48c196",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "python-rewrite",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1725024810,
+        "narHash": "sha256-ODYRm8zHfLTH3soTFWE452ydPYz2iTvr9T8ftDMUQ3E=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "af510d4a62d071ea13925ce41c95e3dec816c01d",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1689068808,
+        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "flake-utils_2": {
+      "inputs": {
+        "systems": "systems_2"
+      },
+      "locked": {
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "flake-utils_3": {
+      "inputs": {
+        "systems": "systems_3"
+      },
+      "locked": {
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "devenv",
+          "pre-commit-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nix": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "nixpkgs": [
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
+    "nix-github-actions": {
+      "inputs": {
+        "nixpkgs": [
+          "devenv",
+          "cachix",
+          "devenv",
+          "poetry2nix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1688870561,
+        "narHash": "sha256-4UYkifnPEw1nAzqqPOTL2MvWtm3sNGw1UTYTalkTcGY=",
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "rev": "165b1650b753316aa7f1787f3005a8d2da0f5301",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nix-github-actions",
+        "type": "github"
+      }
+    },
+    "nix2container": {
+      "inputs": {
+        "flake-utils": "flake-utils_3",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1724996935,
+        "narHash": "sha256-njRK9vvZ1JJsP8oV2OgkBrpJhgQezI03S7gzskCcHos=",
+        "owner": "nlewo",
+        "repo": "nix2container",
+        "rev": "fa6bb0a1159f55d071ba99331355955ae30b3401",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nlewo",
+        "repo": "nix2container",
+        "type": "github"
+      }
+    },
+    "nix_2": {
+      "inputs": {
+        "flake-compat": [
+          "devenv",
+          "flake-compat"
+        ],
+        "nixpkgs": [
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-regression": "nixpkgs-regression_2"
+      },
+      "locked": {
+        "lastModified": 1712911606,
+        "narHash": "sha256-BGvBhepCufsjcUkXnEEXhEVjwdJAwPglCC2+bInc794=",
+        "owner": "domenkozar",
+        "repo": "nix",
+        "rev": "b24a9318ea3f3600c1e24b4a00691ee912d4de12",
+        "type": "github"
+      },
+      "original": {
+        "owner": "domenkozar",
+        "ref": "devenv-2.21",
+        "repo": "nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1692808169,
+        "narHash": "sha256-x9Opq06rIiwdwGeK2Ykj69dNc2IvUH1fY55Wm7atwrE=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-qt6": {
+      "locked": {
+        "lastModified": 1718428119,
+        "narHash": "sha256-WdWDpNaq6u1IPtxtYHHWpl5BmabtpmLnMAx0RdJ/vo8=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e6cea36f83499eb4e9cd184c8a8e823296b50ad5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "e6cea36f83499eb4e9cd184c8a8e823296b50ad5",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-regression_2": {
+      "locked": {
+        "lastModified": 1643052045,
+        "narHash": "sha256-uGJ0VXIhWKGXxkeNnq4TvV3CIOkUJ3PAoLZ3HMzNVMw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "215d4d0fd80ca5163643b03a33fde804a29cc1e2",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1710695816,
+        "narHash": "sha256-3Eh7fhEID17pv9ZxrPwCLfqXnYP006RKzSs0JptsN84=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "614b4613980a522ba49f0d194531beddbb7220d3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.11",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_2": {
+      "locked": {
+        "lastModified": 1713361204,
+        "narHash": "sha256-TA6EDunWTkc5FvDCqU3W2T3SFn0gRZqh6D/hJnM02MM=",
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "285676e87ad9f0ca23d8714a6ab61e7e027020c6",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs_3": {
+      "locked": {
+        "lastModified": 1724819573,
+        "narHash": "sha256-GnR7/ibgIH1vhoy8cYdmXE6iyZqKqFxQSVkFgosBh6w=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "71e91c409d1e654808b2621f28a327acfdad8dc2",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "poetry2nix": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nix-github-actions": "nix-github-actions",
+        "nixpkgs": [
+          "devenv",
+          "cachix",
+          "devenv",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1692876271,
+        "narHash": "sha256-IXfZEkI0Mal5y1jr6IRWMqK8GW2/f28xJenZIPQqkY0=",
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "rev": "d5006be9c2c2417dafb2e2e5034d83fabd207ee3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "poetry2nix",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "devenv",
+          "flake-compat"
+        ],
+        "flake-utils": "flake-utils_2",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "devenv",
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable"
+      },
+      "locked": {
+        "lastModified": 1713775815,
+        "narHash": "sha256-Wu9cdYTnGQQwtT20QQMg7jzkANKQjwBD9iccfGKkfls=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "2ac4dcbf55ed43f3be0bae15e181f08a57af24a4",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "devenv-root": "devenv-root",
+        "flake-parts": "flake-parts",
+        "nix2container": "nix2container",
+        "nixpkgs": "nixpkgs_3",
+        "nixpkgs-qt6": "nixpkgs-qt6",
+        "systems": "systems_4"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "systems_2": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "systems_3": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "systems_4": {
+      "locked": {
+        "lastModified": 1689347949,
+        "narHash": "sha256-12tWmuL2zgBgZkdoB6qXZsgJEH9LR3oUgpaQq2RbI80=",
+        "owner": "nix-systems",
+        "repo": "default-linux",
+        "rev": "31732fcf5e8fea42e59c2488ad31a0e651500f68",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default-linux",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,210 @@
+{
+  description = "TagStudio";
+
+  inputs = {
+    devenv.url = "github:cachix/devenv";
+
+    devenv-root = {
+      url = "file+file:///dev/null";
+      flake = false;
+    };
+
+    flake-parts = {
+      url = "github:hercules-ci/flake-parts";
+      inputs.nixpkgs-lib.follows = "nixpkgs";
+    };
+
+    nix2container = {
+      url = "github:nlewo/nix2container";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+
+    # Pinned to Qt version 6.7.1
+    nixpkgs-qt6.url = "github:NixOS/nixpkgs/e6cea36f83499eb4e9cd184c8a8e823296b50ad5";
+
+    systems.url = "github:nix-systems/default-linux";
+  };
+
+  outputs =
+    {
+      flake-parts,
+      nixpkgs,
+      nixpkgs-qt6,
+      self,
+      systems,
+      ...
+    }@inputs:
+    flake-parts.lib.mkFlake { inherit inputs; } {
+      imports = [ inputs.devenv.flakeModule ];
+
+      systems = import systems;
+
+      perSystem =
+        {
+          config,
+          pkgs,
+          system,
+          ...
+        }:
+        let
+          inherit (nixpkgs) lib;
+
+          qt6Pkgs = import nixpkgs-qt6 { inherit system; };
+        in
+        {
+          formatter = pkgs.nixfmt-rfc-style;
+
+          devenv.shells = rec {
+            default = tagstudio;
+
+            tagstudio =
+              let
+                cfg = config.devenv.shells.tagstudio;
+              in
+              {
+                # NOTE: many things were simply transferred over from previous,
+                # there must be additional work in ensuring all relevant dependencies
+                # are in place (and no extraneous). I have already spent much
+                # work making this in the first place and just need to get it out
+                # there, especially after my promises. Would appreciate any help
+                # (possibly PRs!) on taking care of this. Otherwise, just expect
+                # this to get ironed out over time.
+                #
+                # Thank you! -Xarvex
+
+                devenv.root =
+                  let
+                    devenvRoot = builtins.readFile inputs.devenv-root.outPath;
+                  in
+                  # If not overriden (/dev/null), --impure is necessary.
+                  pkgs.lib.mkIf (devenvRoot != "") devenvRoot;
+
+                name = "TagStudio";
+
+                # Derived from previous flake iteration.
+                packages =
+                  (with pkgs; [
+                    cmake
+                    binutils
+                    coreutils
+                    dbus
+                    fontconfig
+                    freetype
+                    gdb
+                    glib
+                    libGL
+                    libGLU
+                    libgcc
+                    libxkbcommon
+                    mypy
+                    ruff
+                    xorg.libxcb
+                    xorg.libX11
+                    zstd
+                  ])
+                  ++ (with qt6Pkgs; [
+                    qt6.full
+                    qt6.qtbase
+                    qt6.qtwayland
+                    qtcreator
+                  ]);
+
+                enterShell =
+                  let
+                    setQtEnv =
+                      pkgs.runCommand "set-qt-env"
+                        {
+                          buildInputs = with qt6Pkgs.qt6; [
+                            qtbase
+                          ];
+
+                          nativeBuildInputs =
+                            (with pkgs; [
+                              makeShellWrapper
+                            ])
+                            ++ (with qt6Pkgs.qt6; [
+                              wrapQtAppsHook
+                            ]);
+                        }
+                        ''
+                          makeShellWrapper "$(type -p sh)" "$out" "''${qtWrapperArgs[@]}"
+                          sed "/^exec/d" -i "$out"
+                        '';
+                  in
+                  ''
+                    source ${setQtEnv}
+                  '';
+
+                scripts.tagstudio.exec = ''
+                  python ${cfg.devenv.root}/tagstudio/tag_studio.py
+                '';
+
+                env = {
+                  QT_QPA_PLATFORM = "wayland;xcb";
+
+                  # Derived from previous flake iteration.
+                  # Not desired given LD_LIBRARY_PATH pollution.
+                  # See supposed alternative below, further research required.
+                  LD_LIBRARY_PATH = lib.makeLibraryPath (
+                    (with pkgs; [
+                      dbus
+                      fontconfig
+                      freetype
+                      gcc-unwrapped
+                      glib
+                      libglvnd
+                      libkrb5
+                      libpulseaudio
+                      libva
+                      libxkbcommon
+                      openssl
+                      stdenv.cc.cc.lib
+                      wayland
+                      xorg.libxcb
+                      xorg.libX11
+                      xorg.libXrandr
+                      zlib
+                      zstd
+                    ])
+                    ++ (with qt6Pkgs.qt6; [
+                      qtbase
+                      qtwayland
+                      full
+                    ])
+                  );
+                };
+
+                languages.python = {
+                  enable = true;
+                  venv = {
+                    enable = true;
+                    quiet = true;
+                    requirements =
+                      let
+                        excludeDeps =
+                          req: deps:
+                          builtins.concatStringsSep "\n" (
+                            builtins.filter (line: !(lib.any (elem: lib.hasPrefix elem line) deps)) (lib.splitString "\n" req)
+                          );
+                      in
+                      ''
+                        ${builtins.readFile ./requirements.txt}
+                        ${excludeDeps (builtins.readFile ./requirements-dev.txt) [
+                          "mypy"
+                          "ruff"
+                        ]}
+                      '';
+                  };
+
+                  # Should be able to replace LD_LIBRARY_PATH?
+                  # Was not quite able to get working,
+                  # will be consulting cachix community. -Xarvex
+                  # libraries = with pkgs; [ ];
+                };
+              };
+          };
+        };
+    };
+}

mkdocs.yml

@@ -0,0 +1,138 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+
+# MkDocs: https://www.mkdocs.org/
+# Material for MkDocs: https://squidfunk.github.io/mkdocs-material/
+
+# To install:
+# pip install mkdocs-material
+
+# To run the preview server:
+# mkdocs serve
+
+site_name: TagStudio
+site_description: "A User-Focused Photo & File Management System"
+site_url: https://docs.tagstud.io/
+repo_url: https://github.com/TagStudioDev/TagStudio
+edit_uri: blob/main/docs/
+repo_name: TagStudioDev/TagStudio
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/TagStudioDev
+    - icon: fontawesome/brands/discord
+      link: https://discord.gg/hRNnVKhF2G
+  tags:
+    Upcoming Feature: upcoming
+
+# by default the navigation is an alphanumerically sorted, 
+# nested list of all the Markdown files found within the /docs directory
+# where index files are always first
+# uncomment the following to configure the navigation manually:
+
+# nav:
+#   - Home:
+#     - index.md
+#     - install.md
+#     - usage.md
+#   - Library:
+#     - library/index.md
+#     - library/entry.md
+#     - library/entry_groups.md
+#     - library/field.md
+#     - library/tag.md
+#     - library/tag_categories.md
+#     - library/tag_overrides.md
+#   - Utilities:
+#     - utilities/macro.md
+#   - Updates:
+#     - updates/changelog.md
+#     - updates/roadmap.md
+#     - updates/db_migration.md
+
+theme:
+  name: material
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)" 
+      scheme: default
+      primary: deep purple
+      accent: deep purple
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)" 
+      scheme: slate
+      primary: deep purple
+      accent: deep purple
+      toggle:
+        icon: material/brightness-4
+        name: SSwitch to system preference
+  logo: assets/icon.png
+  favicon: assets/icon.ico
+  font: false # use system fonts
+  language: en
+  features:
+    - navigation.instant
+    - navigation.indexes
+    - navigation.tracking
+    - navigation.expand
+    - navigation.sections
+    #- navigation.tabs
+    #- content.tabs.link
+    #- navigation.top
+    - search.suggest
+    - content.code.annotate
+    - content.action.edit
+  icon:
+    repo: fontawesome/brands/github
+    tag:
+      upcoming: material/flask-outline
+
+markdown_extensions:
+
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.snippets
+
+plugins:
+  - search
+  - tags
+  - social: # social embed cards
+      enabled: !ENV [CI, false] # enabled only when running in CI (eg GitHub Actions)

pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "TagStudio"
+description = "A User-Focused Photo & File Management System."
+version = "9.5.1"
+license = "GPL-3.0-only"
+readme = "README.md"
+
+[tool.ruff]
+exclude = ["main_window.py", "home_ui.py", "resources.py", "resources_rc.py"]
+line-length = 100
+
+[tool.ruff.lint.per-file-ignores]
+"tagstudio/tests/**" = ["D", "E402"]
+"tagstudio/src/qt/helpers/vendored/**" = ["B", "E", "N", "UP", "SIM115"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint]
+select = ["B", "D", "E", "F", "FBT003", "I", "N", "SIM", "T20", "UP"]
+ignore = ["D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107"]
+
+[tool.pyright]
+ignore = [".venv/**"]
+include = ["tagstudio/**"]
+reportAny = false
+reportImplicitStringConcatenation = false
+# reportOptionalMemberAccess = false
+reportUnannotatedClassAttribute = false
+reportUnknownArgumentType = false
+reportUnknownMemberType = false
+reportUnusedCallResult = false
+
+[tool.mypy]
+strict_optional = false
+disable_error_code = ["func-returns-value", "import-untyped"]
+explicit_package_bases = true
+warn_unused_ignores = true
+check_untyped_defs = true
+mypy_path = ["tagstudio"]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "src.qt.main_window"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "src.qt.ui.home_ui"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "src.core.ts_core"
+ignore_errors = true
+
+[tool.pytest.ini_options]
+#addopts = "-m 'not qt'"
+qt_api = "pyside6"

requirements-dev.txt

@@ -0,0 +1,8 @@
+ruff==0.8.1
+pre-commit==3.7.0
+pytest==8.2.0
+Pyinstaller==6.6.0
+mypy==1.11.2
+syrupy==4.7.1
+pytest-qt==4.4.0
+pytest-cov==5.0.0

requirements.txt

@@ -1,12 +1,20 @@
-click==8.1.3
-climage==0.1.3
+chardet==5.2.0
+ffmpeg-python==0.2.0
 humanfriendly==10.0
-opencv_python==4.8.0.74
+mutagen==1.47.0
+numpy==2.1.0
+opencv_python==4.10.0.84
+pillow-heif==0.16.0
+pillow-jxl-plugin==1.3.0
 Pillow==10.3.0
-pillow_avif_plugin==1.3.1
-PySide6==6.5.1.1
-PySide6_Addons==6.5.1.1
-PySide6_Essentials==6.5.1.1
-Requests==2.31.0
-typing_extensions==3.10.0.0
-ujson==5.8.0
+pydub==0.25.1
+PySide6_Addons==6.8.0.1
+PySide6_Essentials==6.8.0.1
+PySide6==6.8.0.1
+rawpy==0.22.0
+Send2Trash==1.8.3
+SQLAlchemy==2.0.34
+structlog==24.4.0
+typing_extensions>=3.10.0.0,<=4.11.0
+ujson>=5.8.0,<=5.9.0
+vtf2img==0.1.0

start_win.bat

@@ -1,2 +1,2 @@
 @echo off
-.venv\Scripts\python.exe .\TagStudio\tagstudio.py --ui qt %*
+.venv\Scripts\python.exe .\TagStudio\tag_studio.py --ui qt %*

tagstudio.spec

@@ -0,0 +1,86 @@
+# -*- mode: python ; coding: utf-8 -*-
+# vi: ft=python
+
+
+from argparse import ArgumentParser
+import sys
+from PyInstaller.building.api import COLLECT, EXE, PYZ
+from PyInstaller.building.build_main import Analysis
+from PyInstaller.building.osx import BUNDLE
+
+
+parser = ArgumentParser()
+parser.add_argument('--portable', action='store_true')
+options = parser.parse_args()
+
+
+name = 'TagStudio' if sys.platform == 'win32' else 'tagstudio'
+icon = None
+if sys.platform == 'win32':
+    icon = 'tagstudio/resources/icon.ico'
+elif sys.platform == 'darwin':
+    icon = 'tagstudio/resources/icon.icns'
+
+
+a = Analysis(
+    ['tagstudio/tag_studio.py'],
+    pathex=[],
+    binaries=[],
+    datas=[('tagstudio/resources', 'resources'), ('tagstudio/src', 'src')],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    excludes=[],
+    runtime_hooks=[],
+    noarchive=False,
+    optimize=0,
+)
+
+pyz = PYZ(a.pure)
+
+include = [a.scripts]
+if options.portable:
+    include += (a.binaries, a.datas)
+exe = EXE(
+    pyz,
+    *include,
+    [],
+    bootloader_ignore_signals=False,
+    console=False,
+    hide_console='hide-early',
+    disable_windowed_traceback=False,
+    debug=False,
+    name=name,
+    exclude_binaries=not options.portable,
+    icon=icon,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None
+)
+
+coll = None if options.portable else COLLECT(
+    exe,
+    a.binaries,
+    a.datas,
+    name=name,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+)
+
+app = BUNDLE(
+    exe if coll is None else coll,
+    name='TagStudio.app',
+    icon=icon,
+    bundle_identifier='com.cyanvoxel.tagstudio',
+    version='9.5.1',
+    info_plist={
+        'NSAppleScriptEnabled': False,
+        'NSPrincipalClass': 'NSApplication',
+    }
+)

tagstudio/resources/qt/images/pause.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24" fill="#ffffff"><path d="M560-200v-560h160v560H560Zm-320 0v-560h160v560H240Z"/></svg>

tagstudio/resources/qt/images/play.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 -960 960 960" width="24" fill="#ffffff"><path d="M320-200v-560l440 280-440 280Z"/></svg>