docs: fix typos in README

* Translated using Weblate (Japanese)

Currently translated at 100.0% (357 of 357 strings)

Translated using Weblate (Japanese)

Currently translated at 100.0% (356 of 356 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: wany-oh <wany-oh@users.noreply.hosted.weblate.org>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/ja/
Translation: TagStudio/Strings

* Translated using Weblate (Hungarian)

Currently translated at 100.0% (357 of 357 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Szíjártó Levente Pál <szijartoleventepal@gmail.com>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/hu/
Translation: TagStudio/Strings

* Translated using Weblate (Dutch)

Currently translated at 35.0% (125 of 357 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Lily H <flannyha@gmail.com>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/nl/
Translation: TagStudio/Strings

* Translated using Weblate (Spanish)

Currently translated at 99.1% (353 of 356 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Joan <joancanalscrehuet@gmail.com>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/es/
Translation: TagStudio/Strings

* Translated using Weblate (French)

Currently translated at 100.0% (357 of 357 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Med <45147847+kitsumed@users.noreply.github.com>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/fr/
Translation: TagStudio/Strings

* Translated using Weblate (Norwegian Bokmål)

Currently translated at 89.6% (320 of 357 strings)

Co-authored-by: Hosted Weblate <hosted@weblate.org>
Co-authored-by: Neemek <sindodeg@gmail.com>
Translate-URL: https://hosted.weblate.org/projects/tagstudio/strings/nb_NO/
Translation: TagStudio/Strings

---------

Co-authored-by: wany-oh <wany-oh@users.noreply.hosted.weblate.org>
Co-authored-by: Szíjártó Levente Pál <szijartoleventepal@gmail.com>
Co-authored-by: Lily H <flannyha@gmail.com>
Co-authored-by: Joan <joancanalscrehuet@gmail.com>
Co-authored-by: Med <45147847+kitsumed@users.noreply.github.com>
Co-authored-by: Neemek <sindodeg@gmail.com>

.envrc.recommended

@@ -1,16 +0,0 @@
-# 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,2 @@
+---
+patreon: cyanvoxel

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,3 +1,4 @@
+---
 name: Bug Report
 description: File a bug or issue report.
 title: '[Bug]: '
@@ -8,7 +9,7 @@ body:
       value: |
         *Please add an appropriate title for this issue.*
 
-        Before reporting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        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.
 
@@ -20,7 +21,7 @@ body:
       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/doc/index.md).
+        - 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
@@ -51,7 +52,7 @@ body:
   - type: textarea
     attributes:
       label: Steps to Reproduce
-      description: Minimal steps neded for the problem to occur.
+      description: Minimal steps needed for the problem to occur.
       placeholder: |
         1.
         2.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,3 +1,4 @@
+---
 name: Feature Request
 description: Suggest a new feature.
 title: '[Feature Request]: '
@@ -8,7 +9,7 @@ body:
       value: |
         *Please add an appropriate title for this feature request.*
 
-        Before suggesting, read the [documentation](https://github.com/TagStudioDev/TagStudio/blob/main/doc/index.md) and search existing [issues](https://github.com/TagStudioDev/TagStudio/issues).
+        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.
 
@@ -20,7 +21,7 @@ body:
       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/doc/index.md).
+        - 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

.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/apprun.yaml

@@ -1,51 +0,0 @@
-name: PySide App Test
-
-on: [ push, pull_request ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up 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 \
-            libegl1-mesa \
-            libxcb-icccm4 \
-            libxcb-image0 \
-            libxcb-keysyms1 \
-            libxcb-randr0 \
-            libxcb-render-util0 \
-            libxcb-xinerama0 \
-            libopengl0 \
-            libxcb-cursor0 \
-            libpulse0
-
-      - name: Install dependencies
-        run: |
-          pip install -Ur requirements.txt
-
-      - name: Run TagStudio app and check exit code
-        run: |
-          xvfb-run --server-args="-screen 0, 1920x1200x24 -ac +extension GLX +render -noreset"  python tagstudio/tag_studio.py --ci -o /tmp/
-          exit_code=$?
-          if [ $exit_code -eq 0 ]; then
-            echo "TagStudio ran successfully"
-          else
-            echo "TagStudio failed with exit code $exit_code"
-            exit 1
-          fi

.github/workflows/mypy.yaml

@@ -1,37 +1,34 @@
+---
 name: MyPy
 
-on: [ push, pull_request ]
-
+on: [push, pull_request]
 
 jobs:
   mypy:
     name: Run MyPy
     runs-on: ubuntu-latest
-
     steps:
-      - name: Checkout code
+      - name: Checkout repo
         uses: actions/checkout@v4
 
-      - uses: reviewdog/action-setup@v1
+      - name: Setup reviewdog
+        uses: reviewdog/action-setup@v1
         with:
           reviewdog_version: latest
 
-      - uses: actions/setup-python@v5
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
-          cache: 'pip'
+          cache: pip
 
-      - name: Install dependencies
+      - name: Install Python dependencies
         run: |
-          pip install -r requirements.txt
-          pip install mypy==1.10.0
-          mkdir tagstudio/.mypy_cache
+          python -m pip install --upgrade uv
+          uv pip install --system .[mypy]
 
-      - uses: tsuyoshicho/action-mypy@v4
+      - name: Execute MyPy
+        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,49 @@
+---
+name: Publish Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/publish_docs.yaml
+      - docs/**
+      - mkdocs.yml
+      - CHANGELOG.md
+
+permissions:
+  contents: write
+
+concurrency:
+  group: publish-docs
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    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 Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[mkdocs]
+
+      - 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-
+
+      - name: Execute mkdocs
+        run: mkdocs gh-deploy --force

.github/workflows/pytest.yaml

@@ -1,22 +1,74 @@
+---
 name: pytest
 
 on: [push, pull_request]
 
 jobs:
   pytest:
-    name: Run tests
-    runs-on: ubuntu-latest
+    name: Run pytest
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+          cache: pip
 
-      - name: Run tests
+      - name: Install Python dependencies
         run: |
-          pytest tagstudio/tests/
+          python -m pip install --upgrade uv
+          uv pip install --system .[pytest]
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libegl1 \
+            libgl1 \
+            libopengl0 \
+            libpulse0 \
+            libxcb-cursor0 \
+            libxcb-icccm4 \
+            libxcb-image0 \
+            libxcb-keysyms1 \
+            libxcb-randr0 \
+            libxcb-render-util0 \
+            libxcb-xinerama0 \
+            libxkbcommon-x11-0 \
+            libyaml-dev \
+            x11-utils
+
+      - name: Execute pytest
+        run: |
+          xvfb-run pytest --cov-report xml --cov=tagstudio
+
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage
+          path: coverage.xml
+
+  coverage:
+    name: Check coverage
+    runs-on: ubuntu-latest
+    needs: pytest
+
+    steps:
+      - name: Fetch coverage
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage
+
+      - name: Check 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

@@ -1,3 +1,4 @@
+---
 name: Release
 
 on:
@@ -19,15 +20,27 @@ jobs:
             suffix: _portable
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        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
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+      - name: Execute PyInstaller
+        run: |
+          pyinstaller tagstudio.spec -- ${{ matrix.build-flag }}
+          tar czfC dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz dist tagstudio
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
           name: tagstudio_linux_x86_64${{ matrix.suffix }}
           path: dist/tagstudio_linux_x86_64${{ matrix.suffix }}.tar.gz
@@ -35,26 +48,41 @@ jobs:
   macos:
     strategy:
       matrix:
-        os-version: ['12', '14']
+        os-version: ['13', '14']
         include:
-          - os-version: '12'
+          - 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
+      # INFO: Even though we run on 13, target towards compatibility
       MACOSX_DEPLOYMENT_TARGET: '11.0'
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        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
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+
+      - name: Execute PyInstaller
+        run: |
+          pyinstaller tagstudio.spec
+          tar czfC dist/tagstudio_macos_${{ matrix.arch }}.tar.gz dist TagStudio.app
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
           name: tagstudio_macos_${{ matrix.arch }}
           path: dist/tagstudio_macos_${{ matrix.arch }}.tar.gz
@@ -72,30 +100,51 @@ jobs:
             build-flag: --portable
             suffix: _portable
             file-end: .exe
-    runs-on: windows-2019
+
+    runs-on: windows-2022
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        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
+          cache: pip
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system .[pyinstaller]
+
+      - name: Execute PyInstaller
+        run: |
+          PyInstaller tagstudio.spec -- ${{ matrix.build-flag }}
+          Compress-Archive -Path dist/TagStudio${{ matrix.file-end }} -DestinationPath dist/tagstudio_windows_x86_64${{ matrix.suffix }}.zip
+      - name: Upload artifact
+        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
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Fetch artifacts
+        uses: actions/download-artifact@v4
+
+      - name: Publish release
+        uses: softprops/action-gh-release@v2
         with:
           files: |
             tagstudio_linux_x86_64/*

.github/workflows/ruff.yaml

@@ -1,11 +1,31 @@
+---
 name: Ruff
-on: [ push, pull_request ]
+
+on: [push, pull_request]
+
 jobs:
-  ruff:
+  ruff-format:
+    name: Run Ruff format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: chartboost/ruff-action@v1
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Execute Ruff format
+        uses: astral-sh/ruff-action@v3
         with:
-          version: 0.4.2
-          args: 'format --check'
+          version: 0.11.0
+          args: format --check
+
+  ruff-check:
+    name: Run Ruff check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Execute Ruff check
+        uses: astral-sh/ruff-action@v3
+        with:
+          version: 0.11.8
+          args: check

.gitignore

@@ -55,7 +55,6 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
-tagstudio/tests/fixtures/library/*
 
 # Translations
 *.mo
@@ -89,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.
@@ -141,6 +138,9 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
+# macoS
+*.DS_Store
+
 # mkdocs documentation
 /site
 
@@ -163,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
@@ -175,6 +175,10 @@ poetry.toml
 # LSP config files
 pyrightconfig.json
 
+# Syncthing
+.stfolder/
+.stignore
+
 ### Qt ###
 # C++ objects and libs
 *.slo
@@ -232,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/
@@ -248,12 +252,19 @@ 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
-# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,qt
+*.sqlite-journal
 
 .envrc
 .direnv
 .devenv
+
+result
+result-*

.pre-commit-config.yaml

@@ -1,6 +1,26 @@
+---
 repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.4.2
+  - repo: local
     hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+
+      - id: ruff
+        name: ruff
+        entry: ruff check
+        language: system
+        types_or: [python, pyi, jupyter]
+        args: [--force-exclude]
+        require_serial: true
+
       - id: ruff-format
+        name: ruff-format
+        entry: ruff format
+        language: system
+        types_or: [python, pyi, jupyter]
+        args: [--force-exclude, --check]
+        require_serial: true

.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/tag_studio.py",
-			"console": "integratedTerminal",
-			"justMyCode": true,
-			"args": []
-		}
-	]
-}

Build_MacOS_app.sh

@@ -1,69 +0,0 @@
-#! /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

@@ -1,31 +0,0 @@
-@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

@@ -1,61 +0,0 @@
-# TagStudio Changelog
-
-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.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
-
-- Initial public release

CHANGELOG.md

@@ -0,0 +1 @@
+docs/changelog.md

CONTRIBUTING.md

@@ -1,170 +0,0 @@
-# Contributing to TagStudio
-
-_Last Updated: June 10th, 2024_
-
-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 [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/doc/updates/planned_features.md) page, [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 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.
-
-### Contribution Checklist
-
-- I've read the [Planned Features](https://github.com/TagStudioDev/TagStudio/blob/main/doc/updates/planned_features.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 _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 and Mypy
-- I've read the [Code Guidelines](#code-guidelines) and/or [Documentation Guidelines](#documentation-guidelines)
-- **_I mean it, I've found or created a new issue for my feature!_**
-
-## 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. In the root repository directory, create a python virtual environment:  
-   `python3 -m venv .venv`
-2. Activate your environment:
-
-- Windows w/Powershell: `.venv\Scripts\Activate.ps1`
-- Windows w/Command Prompt: `.venv\Scripts\activate.bat`
-- Linux/macOS: `source .venv/bin/activate`
-
-3. 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)
-
-- **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)
-    > [!WARNING]
-    > Support for NixOS is still a work in progress.
-    - 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.
-
-- **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
-
-- Lint code with by moving into the `/tagstudio` directory with `cd tagstudio` and running `ruff --config ../pyproject.toml`.
-- Format code with `ruff format` inside the repository directory
-
-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!)_
-
-> [!CAUTION]
-> There's a known issue between PySide v6.6.3 and Mypy where Mypy will detect issues with the `.pyi` files inside of PySide and prematurely stop checking files. This issue is not present in PySide v6.6.2, which _should_ be compatible with everything else if you wish to try using that version in the meantime.
-
-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 Guidelines
-
-### 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.
-- Try to keep a maximum column with of no more than **100** characters.
-- Code comments should be used to help describe sections of code that don'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 (in newly created python files).
-- When writing text for window titles, form titles, or dropdown options, 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/)!
-  > [!WARNING]
-  > Column width limits, docstring formatting, and import sorting aren't currently checked in the Ruff workflow but likely will be in the near future.
-
-### Implementations
-
-- Avoid direct calls to `os`
-  - Use `Pathlib` library instead of `os.path`
-  - Use `sys.platform` instead of `os.name`
-- Don't prepend local imports with `tagstudio`, stick to `src`
-- Use `logging` instead of `print` statements
-- Avoid nested `f-string`s
-
-#### Runtime
-
-- Code must function on supported versions of Windows, macOS, and Linux:
-  - Windows: 10, 11
-  - macOS: 12.0+
-  - Linux: TBD
-- Avoid use of unnecessary logging statements in final submitted code.
-- Code should not cause unreasonable slowdowns to the program outside of a progress-indicated task.
-
-#### Git/GitHub Specifics
-
-- 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.
-- Use imperative-style present-tense commit messages. Examples:
-  - "Add feature foo"
-  - "Change method bar"
-  - "Fix function foobar"
-- 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.
-
-## Documentation Guidelines
-
-Documentation contributions include anything inside of the `doc/` folder, as well as the `README.md` and `CONTRIBUTING.md` files.
-
-- 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
-
-_TBA_

CONTRIBUTING.md

@@ -0,0 +1 @@
+docs/contributing.md

README.md

@@ -1,82 +1,92 @@
-# TagStudio (Alpha): A User-Focused Document Management System
+# TagStudio: A User-Focused Photo & File Management System
+
+[![Downloads](https://img.shields.io/github/downloads/TagStudioDev/TagStudio/total.svg?maxAge=2592001)](https://github.com/TagStudioDev/TagStudio/releases)
+[![Translations](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)
 
 <p align="center">
-  <img width="60%" src="github_header.png">
+  <img width="60%" src="docs/assets/ts-9-3_logo_text.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.
-
-<figure align="center">
-  <img width="80%" src="screenshot.jpg" alt="TagStudio Screenshot" align="center">
-
-  <figcaption><i>TagStudio Alpha v9.1.0 running on Windows 10.</i></figcaption>
-</figure>
+<p align="center">
+  <img width="80%" src="docs/assets/screenshot.png" alt="TagStudio Screenshot">
+</p>
+<p align="center">
+  <i>TagStudio Alpha v9.5.5 running on macOS Sequoia.</i>
+</p>
 
 ## Contents
 
-- [Goals](#goals)
-- [Priorities](#priorities)
-- [Current Features](#current-features)
-- [Contributing](#contributing)
-- [Installation](#installation)
-- [Usage](#usage)
-- [FAQ](#faq)
+-   [Feature Highlights](#feature-highlights)
+-   [Basic Usage](#basic-usage)
+-   [Installation](#installation)
+-   [Goals & Priorities](#goals--priorities)
+-   [FAQ](#faq)
 
-## Goals
+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!
 
-- 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.
+## Feature Highlights
 
-## Priorities
+### Libraries
 
-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._
-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.
+A TagStudio library contains all of your tags, fields for a set of files based on one of your system directories. Similar to how Obsidian [vaults](https://help.obsidian.md/vault) function, TagStudio libraries act as a layer on top of your existing folders and file structure, and don't require your to move or duplicate files.
 
-## Current Features
+TagStudio places a `.TagStudio` folder in the folder you open as a library. Files included in your library are referred to as "entries", and are kept track of inside of a SQLite database inside the `.TagStudio` folder along with tags and other library data.
 
-- 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)
-- Create 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~~ (TBA), or filenames/filetypes (using `filename: <query>`)
-- Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
+### File Entries
 
-> [!NOTE]
-> For more information on the project itself, please see the [FAQ](#faq) section as well as the [documentation](/doc/index.md).
+All file types are supported in TagStudio libraries, just not all have dedicated preview support. For a full list of filetypes with supported previews, see the "[Supported Previews](https://docs.tagstud.io/preview-support)" page on the documentation site. There's also playback support for videos, audio files, and supported animated image formats.
 
-## Contributing
+For a generalized list of what's currently supported:
 
-If you're interested in contributing to TagStudio, please take a look at the [contribution guidelines](/CONTRIBUTING.md) for how to get started!
+-   **Images**
+    -   Raster Images (JPEG, PNG, etc.)
+    -   Vector (SVG)
+    -   Animated (GIF, WEBP, APNG)
+    -   RAW Formats
+-   **Videos**
+-   **Plaintext Files**
+-   **Documents** _(If supported)_
+-   **eBooks** _(If supported)_
+-   **Photoshop PSDs**, **Blender Projects**, **Krita Projects**, and more!
 
-## Installation
+### [Tags](https://docs.tagstud.io/tags) and [Fields](https://docs.tagstud.io/fields)
 
-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.
+Tags represent an object or 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.
 
-> [!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.
+Tags currently consist of the following attributes:
 
-#### Optional Arguments
+-   **Name**: The full name for your tag. **_This does NOT have to be unique!_**
+-   **Shorthand Name**: The shortest alternate name for your tag, used for abbreviations.
+-   **Aliases**: Alternate names your tag goes by.
+-   **Color**: The display color of your tag.
+-   **Parent Tags**: Other tags in which this tag inherits from. In practice, this means that this tag can be substituted in searches for any listed parent tags.
+    -   Parent tags checked with the "disambiguation" checkbox 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)".
+-   **Is Category**: A property that when checked, treats this tag as a category in the preview panel.
 
-Optional arguments to pass to the program.
+Fields, like tags, are additional pieces of custom metadata that you can add to your file entries. Fields currently have several hardcoded names (e.g. "Title", "Author", "Series") but custom field names are planned for an upcoming update.
 
-> `--open <path>` / `-o <path>`
-> Path to a TagStudio Library folder to open on start.
+Field types currently include:
 
-> `--config-file <path>` / `-c <path>`
-> Path to the TagStudio config file to load.
+-   **Text Lines**: Single lines of text.
+-   **Text Boxes**: Multi-line pieces of text.
+-   **Datetimes**: Dates and times.
 
-## Usage
+### [Search](https://docs.tagstud.io/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
+
+## Basic Usage
+
+> [!TIP]
+> For more usage instructions, see the [documentation site](https://docs.tagstud.io/libraries)!
 
 ### Creating/Opening a Library
 
@@ -84,161 +94,141 @@ 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.
-
-> [!NOTE]
-> In the future, library refreshing will also be automatically done in the background, or additionally on app startup.
-
-### Adding Metadata to Entries
-
-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.
-
-### 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.
-
-#### 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.
+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 or by pressing <kbd>Ctrl</kbd></kbd>+<kbd>R</kbd> (macOS: <kbd>⌘ Command</kbd>+<kbd>R</kbd>).
 
 ### 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> (macOS: <kbd>⌘ Command</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.
+#### Tag Manager
+
+You can manage your library of tags from opening the "Tag Manager" panel from Edit -> "Tag Manager" or by pressing <kbd>Ctrl</kbd>+<kbd>M</kbd> (macOS: <kbd>⌘ Command</kbd>+<kbd>M</kbd>). 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 Renamed/Moved Files
+### Adding Tags to File Entries
 
-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.
+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> (macOS: <kbd>⌘ Command</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 the currently selected file entries. To quickly add the top result, press the <kbd>Enter</kbd>/<kbd>Return</kbd> key to add the top-most 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 Fields 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 Fields
+
+Hover over the field and click the pencil icon. From there, add or edit text in the dialog box popup.
+
+### 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 relink entries to files that have been renamed - only moved or deleted. This is a top priority for future releases.
+> 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]
-> 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
+See instructions in the "[Creating Development Environment](/CONTRIBUTING.md/#creating-a-development-environment)" section from the [contributing](https://docs.tagstud.io/contributing) page.
 
-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.
+## Installation
 
-### Half-Implemented Features
+To download executable builds of TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) page of the GitHub repository and download the latest release for your system under the "Assets" section at the bottom of the release.
 
-#### Fix Duplicate Files
+TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
 
-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
+For detailed instructions, installation help, and instructions for developing for TagStudio, please see the "[Installation](https://docs.tagstud.io/install)" page on our documentation website.
 
+> [!IMPORTANT]
+> If you're interested in contributing to TagStudio, please take a look at the [contribution guidelines](https://docs.tagstud.io/contributing) for how to get started!
+
+### 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](/docs/help/ffmpeg.md) guide. For faster library scanning and refreshing, it's also recommended you install [ripgrep](https://github.com/BurntSushi/ripgrep).
+
+<!-- prettier-ignore -->
 > [!CAUTION]
-> While this feature is functional, it’s a pretty roundabout process and can be streamlined in the future.
+> **We do not currently publish TagStudio to any package managers. Any TagStudio distributions outside of the GitHub [Releases](https://github.com/TagStudioDev/TagStudio/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!
 
-#### Image Collage
+## Goals & Priorities
 
-Create an image collage of your photos and videos.
+TagStudio aims to create an **open** and **robust** format for file tagging that isn't burdened by the limitations of traditional tagging and file metadata systems. **TagStudio** is the first proof-of-concept implementation of this system.
 
-> [!CAUTION]
-> Collage sizes and options are hardcoded, and there's no GUI indicating the process of the collage creation.
+See the [**Roadmap**](docs/roadmap.md) on the documentation site for a complete list of planned features and estimated timeline.
 
-#### Macros
+### Overall Goals
 
-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.
+-   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.
 
-> [!CAUTION]
-> Macro options are hardcoded, and there’s currently no way for the user to interface with this (still incomplete) system at all.
+### Project Priorities
 
-#### Gallery-dl Sidecar Importing
-
-Import JSON sidecar data generated by [gallery-dl](https://github.com/mikf/gallery-dl).
-
-> [!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).
+1. **The concept.** Even if TagStudio as an application fails, I’d hope that the idea lives on in a superior project. The 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.
 
 ## FAQ
 
-### What State Is the Project Currently In?
+### Will TagStudio move, modify, or mess with my files?
 
-As of writing (Alpha v9.3.0) the project is in a useable state, however it lacks proper testing and quality of life features.
+**No**, outside of _explicit_ functionality such as "Move File(s) to Trash".
 
-### What Features Are You Planning on Adding?
+### Will TagStudio require me to recreate my tags or library in future updates?
 
-> [!IMPORTANT]
-> See the [Planned Features](/doc/updates/planned_features.md) documentation for the latest feature lists. The lists here are currently being migrated over there with individual pages for larger features.
+**No.** It's our highest priority to ensure that your data safely and smoothly transfers over to newer versions.
 
-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.
+### What state is the project currently in?
 
-#### Priority Features
+As of writing (Alpha v9.5.5) the project is very usable, however there's still some quirks and missing QoL features. Several additional features and changes are still planned (see: [roadmap](https://docs.tagstud.io/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 polishes are constantly trickling in along with the larger feature releases.
 
-- Improved search
-  - Sortable Search
-  - Boolean Search
-  - Coexisting Text + Tag Search
-  - Searchable File Metadata
-- Comprehensive Tag management tab
-- Easier ways to apply tags in bulk
-  - Tag Search Panel
-  - Recent Tags Panel
-  - Top Tags Panel
-  - Pinned Tags Panel
-- Better (stable, performant) library grid view
-- Improved entry relinking
-- Cached thumbnails
-- Tag-like Groups
-- 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
-- Exportable/importable library data including "Tag Packs"
+### What features are you planning on adding?
 
-#### Future Features
+See the [roadmap](https://docs.tagstud.io/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.
 
-- Support for multiple simultaneous users/clients
-- Draggable files outside the program
-- Comprehensive filetype whitelist
-- 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
-- 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 _(FAR future)_
+The most important remaining features before I consider the program to be "feature complete" are:
 
-#### Features I Likely Won’t Add/Pull
+-   Custom names for Fields
+-   List views for files
+-   Multiple root directory support for libraries
+-   Improved file entry relinking
+-   File entry groups
+-   Sorting by file date modified and created
+-   Macros
+-   Improved search bar with visualized tags and improved autocomplete
+-   Side panel for easier tagging (pinned tags, recent tags, tag search, tag palette)
+-   Improved tag management interface
+-   Improved and finalized Tag Categories
+-   Fixed and improved mixed entry data displays (see: [#337](https://github.com/TagStudioDev/TagStudio/issues/337))
+-   Sharable tag data
+-   Separate core library + API
 
-- 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).
+### What features will NOT be added?
 
-### Why Is the Version Already v9?
+-   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/Claude/Gemini/_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: [Overall Goals/Privacy](#overall-goals)).
+    -   With that being said, the future TagStudio API should be well-suited to connect to any sort of service you'd like, including machine learning models if so you choose. I just won't _personally_ add any native integrations with online services.
 
-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.
+### Is a Rust port coming?
 
-### Wait, Is There a CLI Version?
+Not from us, or at least _not quite_. There are plans to break off the core TagStudio library into its own MIT-licensed module that can be used in other applications and plugins, and ideally this would be written in Rust. While I understand there's a lot of vocal support and volunteers willing to help with this, it's something that's better off coming at my/our own pace in order to ensure it's done correctly to align with the project's intentions and to remain maintainable in the future.
 
-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...)._
+### Windows Defender thinks TagStudio is a virus or a trojan, why?
+
+Unfortunately, executable Python applications "compiled" with something like PyInstaller are notorious for raising false positives in anti-virus software, most commonly Windows Defender (see: [#276](https://github.com/TagStudioDev/TagStudio/issues/276) and related issues). There's really not much we can do about this on our end, as the malware matches frequently change and sample submissions to Microsoft are slow and often ineffective. If you're effected by this, you may need to allow TagStudio to bypass your anti-virus software.
+
+### Why is TagStudio already on version 9.x?
+
+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 [roadmap](https://docs.tagstud.io/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.

STYLE.md

@@ -0,0 +1 @@
+docs/style.md

TagStudio.sh

@@ -1,7 +0,0 @@
-#! /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/tag_studio.py

contrib/.envrc-nix

@@ -0,0 +1,19 @@
+# shellcheck shell=bash
+
+# If you wish to use this file, symlink or copy it to `.envrc` for direnv to read it.
+# This will use the Nix flake development shell.
+#
+# ln -s contrib/.envrc-nix .envrc
+
+if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
+    source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
+fi
+
+watch_file nix/shell.nix pyproject.toml
+
+use flake
+
+# Only watch now, or direnv will execute again if created or modified by itself.
+watch_file "${UV_PROJECT_ENVIRONMENT:-.venv}"/bin/activate
+
+# vi: ft=bash

contrib/.envrc-uv

@@ -0,0 +1,32 @@
+# shellcheck shell=bash
+
+# If you wish to use this file, symlink or copy it to `.envrc` for direnv to read it.
+# This will use a virtual environment created by uv.
+#
+# ln -s contrib/.envrc-uv .envrc
+
+watch_file .python-version pyproject.toml uv.lock
+
+venv="$(expand_path "${UV_PROJECT_ENVIRONMENT:-.venv}")"
+
+if [ ! -f "${venv}"/bin/activate ]; then
+    printf '%s\n' 'Generating virtual environment...' >&2
+    rm -rf "${venv}"
+    uv venv "${venv}"
+fi
+
+# Only watch now, or direnv will execute again if created or modified by itself.
+watch_file "${venv}"/bin/activate
+
+# shellcheck disable=SC1091
+source "${venv}"/bin/activate
+
+if [ ! -f "${venv}"/pyproject.toml ] || ! diff --brief pyproject.toml "${venv}"/pyproject.toml >/dev/null; then
+    printf '%s\n' 'Installing dependencies, pyproject.toml changed...' >&2
+    uv pip install --quiet --editable '.[dev]'
+    cp pyproject.toml "${venv}"/pyproject.toml
+fi
+
+pre-commit install
+
+# vi: ft=bash

contrib/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "TagStudio",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceRoot}/src/tagstudio/main.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": [
+                "-o",
+                "~/Documents/Example"
+            ]
+        }
+    ]
+}

doc/index.md

@@ -1,24 +0,0 @@
-# Welcome to the TagStudio Documentation!
-
-> [!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.
-
-<div align="center">
-	<img src="../github_header.png" alt="TagStudio Alpha" height="100">
-	<img src="https://i0.wp.com/www.bapl.org/wp-content/uploads/2019/02/old-under-construction-gif.gif" alt="Under Construction" height="100">
-</div>
-
-## Table of Contents
-
-- [Library](/doc/library/library.md)
-- [Entries](/doc/library/entry.md)
-- [Fields](/doc/library/field.md)
-- [Tags](/doc/library/tag.md)
-- [Tools & Macros](/doc/utilities/macro.md)
-- [Planned Features](/doc/updates/planned_features.md)
-
----
-
-### [Database Migration](/doc/updates/db_migration.md)
-
-The "Database Migration", "DB Migration", or "SQLite Migration" is an upcoming update to TagStudio which will replace the current JSON [library](/doc/library/library.md) with a SQL-based one, and will additionally include some fundamental changes to how some features such as [tags](/doc/library/tag.md) will work.

doc/library/entry.md

@@ -1,25 +0,0 @@
-# Entry
-
-Entries are the units that fill a [library](/doc/library/library.md). Each one corresponds to a file, holding a reference to it along with the metadata associated with it.
-
-### Entry Object Structure
-
-1. `id`:
-   - Int, Unique, **Required**
-   - The ID for the Entry.
-   - Used for internal processing
-2. `filename`:
-   - String, **Required**
-   - The filename with extension of the referenced media file.
-3. `path`:
-   - String, **Required**, OS Agnostic
-   - The folder path in which the media file is located in.
-4. [`fields`](/doc/library/field.md):
-   - List of dicts, Optional
-   - A list of Field ID/Value dicts.
-
-NOTE: _Entries currently have several unused optional fields intended for later features._
-
-## Retrieving Entries based on [Tag](/doc/library/tag.md) 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.

doc/library/entry_groups.md

@@ -1,3 +0,0 @@
-# Entry Groups (Upcoming Feature)
-
-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.

doc/library/field.md

@@ -1,34 +0,0 @@
-# Field
-
-Fields are the building blocks of metadata stored in [entries](/doc/library/entry.md). Fields have several base types for representing different kinds of information, including:
-
-#### `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.
-
-#### `tag_box`
-
-- A box of [tags](/doc/library/tag.md) defined and added by the user.
-- Multiple tag boxes can be used to separate classifications of tags.
-  - e.g: Content Tags, Meta Tags, etc.
-
-#### `datetime` [WIP]
-
-- A date and time value.
-  - e.g: Date Created, Date Modified, Date Taken, etc.
-
-#### `checkbox` [WIP]
-
-- A simple two-state checkbox.
-- Can be associated with a tag for quick organization.
-  - e.g: Archive, Favorite, etc.
-
-#### `collation` [obsolete]
-
-- Previously used for associating files to be used in a [collation](/doc/utilities/macro.md#create-collage), will be removed in favor of a more flexible feature in future updates.

doc/library/library.md

@@ -1,11 +0,0 @@
-# Library
-
-The library is how TagStudio represents your chosen directory, with every file inside of it being displayed as an [entry](/doc/library/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.
-Note that this means [tags](/doc/library/tag.md) you create only exist _per-library_.
-
-### Library Contents
-
-- [Entries](/doc/library/entry.md)
-- [Fields](/doc/library/field.md)
-- [Tags](/doc/library/tag.md)
-- [Macros](/doc/utilities/macro.md)

doc/library/tag.md

@@ -1,85 +0,0 @@
-# Tag
-
-Tags are user-defined attributes made up of one or more keywords, aliases, and relationships to other tags. A person, place, thing, concept, you name it! Tags allow for a more sophisticated way to organize and search [entries](/doc/library/entry.md) thanks to their aliases, parent tags, and more.
-Tags can be as simple or complex as wanted, so that any user can tune TagStudio to fit their needs.
-
-Among the things that make tags so useful, aliases give the ability to contain alternate names and spellings, making searches intuitive and expansive. Furthermore, parent-tags/subtags offer relational organization capabilities for the structuring and connection of the [library's](/doc/library/library.md) contents.
-
-## Tag Object Structure
-
-#### `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
-- Used for display, searching, and storing
-
-#### `shorthand`
-
-The shorthand name for the tag. Works like an alias but is used for specific display purposes.
-
-- String, Optional
-- Doesn't have to be unique
-- Used for display and searching
-
-#### `aliases`
-
-Alternate names for the tag.
-
-- List of Strings, Optional
-- Recommended to be unique to this tag
-- Used for searching
-
-#### `subtags`
-
-Other Tags that make up properties of this tag. Also called "parent tags".
-
-- List of Strings, Optional
-- Used for display (first parent tag only) and searching.
-
-#### `color`
-
-A color name string for customizing the tag's display color
-
-- String, Optional
-- Used for display
-
-## Tag Search Examples:
-
-Using for example, a library of files including some tagged with the following tags:
-
-| 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".

doc/library/tag_categories.md

@@ -1,3 +0,0 @@
-# Tag Categories (Upcoming Feature)
-
-Replaces [Tag Fields](/doc/library/field.md#tag_box). Tags are able to be marked as a “category” which then displays as tag fields currently do, with any tags inheriting from that category being displayed underneath.

doc/library/tag_overrides.md

@@ -1,16 +0,0 @@
-# Tag Overrides (Upcoming Feature)
-
-Tag overrides are the ability to add or remove [parent tags](/doc/library/tag.md#subtags) from a [tag](/doc/library/tag.md) on a per- [entry](/doc/library/entry.md) basis. Relies on the [Database Migration](/doc/updates/db_migration.md) update being complete.
-
-## Examples
-
-<figure>
-  <img src="../assets/tag_override_ex-1.png" alt="Example 1" height="300">
-  <figcaption>Ex. 1 - Comparing standard tag composition vs additive and subtractive inheritance overrides.</figcaption>
-</figure>
-
-<figure>
-  <img src="../assets/tag_override_ex-2.png" alt="Example 2" height="300">
-
-  <figcaption>Ex. 2 - Parent tag swap using tag overrides.</figcaption>
-</figure>

doc/updates/db_migration.md

@@ -1,43 +0,0 @@
-# Database Migration
-
-The database migration is an upcoming refactor to TagStudio's library data storage system. The database will be migrated from a JSON-based one to a SQLite-based one. Part of this migration will include a reworked schema, which will allow for several new features and changes to how [tags](/doc/library/tag.md) and [fields](/doc/library/field.md) operate.
-
-## Schema
-
-<img src="../assets/db_schema.png" alt="Database Schema" width="500">
-
-### `alias` Table
-
-_Description TBA_
-
-### `entry` Table
-
-_Description TBA_
-
-### `entry_attribute` Table
-
-_Description TBA_
-
-### `entry_page` Table
-
-_Description TBA_
-
-### `location` Table
-
-_Description TBA_
-
-### `tag` Table
-
-_Description TBA_
-
-### `tag_relation` Table
-
-_Description TBA_
-
-## Resulting New Features and Changes
-
-- Multiple Directory Support
-- [Tag Categories](/doc/library/tag_categories.md) (Replaces [Tag Fields](/doc/library/field.md#tag_box))
-- [Tag Overrides](/doc/library/tag_overrides.md)
-- User-Defined [Fields](/doc/library/field.md)
-- Tag Icons

doc/updates/planned_features.md

@@ -1,59 +0,0 @@
-# Planned Features
-
-The following lists outline the planned major and minor features for TagStudio, in no particular order.
-
-# Major Features
-
-- [SQL Database Migration](/doc/updates/db_migration.md)
-- Multiple Directory Support
-- [Tags Categories](/doc/library/tag_categories.md)
-- [Entry Groups](/doc/library/entry_groups.md)
-- [Tag Overrides](/doc/library/tag_overrides.md)
-- Tagging Panel
-  - Top Tags
-  - Recent Tags
-  - Tag Search
-  - Pinned Tags
-- Configurable Default Fields (May be part of [Macros](/doc/utilities/macro.md))
-- Deep File Extension Control
-- Settings Menu
-- Custom User Colors
-- Search Engine Rework
-  - Boolean Search
-  - Tag Objects In Search
-  - Search For Fields
-  - Sortable Search Results
-- Automatic Entry Relinking
-  - Detect Renames
-  - Detect Moves
-- Thumbnail Caching
-- User-Defined Fields
-- Exportable Library/Tag Data
-  - Exportable Human-Readable Library
-  - Exportable/Importable Human-Readable “Tag Packs”
-  - Exportable/Importable Color Palettes
-- Configurable Thumbnail Labels
-  - Toggle Extension Label
-  - Toggle File Size Label
-- Configurable Thumbnail Tag Badges
-  - Customize tags that appear instead of just “Archive” and “Favorite”
-- OCR Search
-
-## Minor Features
-
-- Deleting Tags
-- Merging Tags
-- Tag Icons
-- Tag/Field Copy + Paste
-- Collage UI
-- Resizable Thumbnail Grid
-- Draggable Files Outside The Program
-- File Property Caching
-- 3D Previews
-- Audio Waveform Previews
-  - Toggle Between Waveform And Album Artwork
-- PDF Previews
-- SVG Previews
-- Full Video Player
-- Duration Properties For Video + Audio Files
-- Optional Starter Tag Packs

doc/utilities/macro.md

@@ -1,43 +0,0 @@
-# Tools & Macros
-
-Tools and macros are features that serve to create a more fluid [library](/doc/library/library.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](/doc/library/entry.md), and some options for their resolution.
-
-1. Refresh
-   - Scans through the library and updates the unlinked entry count.
-2. Search & Relink
-   - Attempts to automatically find and reassign missing files.
-3. 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.
-
-1. Load DupeGuru File
-   - load the "results" file created from a DupeGuru scan
-2. 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](/doc/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](/doc/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](/doc/library/tag.md#subtags). Tags will initially be named after the folders, but can be fully edited and customized afterwards.

docs/CNAME

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

docs/assets/icon_mono.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 739 739" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <g transform="matrix(0.986683,0,0,0.986683,-136.081,-136.081)">
+        <path d="M535.939,863.161C515.931,843.153 203.505,529.713 183.497,509.705C169.086,495.294 161.469,476.645 160.649,457.754C160.046,443.845 138.078,230.102 137.923,217.139C137.681,196.785 145.323,176.356 160.839,160.839C177.115,144.564 198.795,136.951 220.125,138.016C232.439,138.63 447.036,159.52 461.817,160.931C479.3,162.6 496.329,170.12 509.705,183.497C523.113,196.904 849.753,522.531 863.161,535.939C893.716,566.494 893.716,616.108 863.161,646.663L646.663,863.161C616.108,893.716 566.494,893.716 535.939,863.161ZM321.355,223.613C296.045,198.303 254.947,198.303 229.636,223.613C204.326,248.924 204.326,290.022 229.636,315.332C254.947,340.643 296.045,340.643 321.355,315.332C346.666,290.022 346.666,248.924 321.355,223.613ZM362.109,606.786C409.476,654.152 424.103,598.401 454.027,606.786C468.584,610.865 453.72,642.505 443.028,673.551C425.086,725.641 484.094,757.817 516.601,720.743C545.603,687.667 503.579,655.692 520.581,632.527C537.795,609.074 563.542,633.319 565.542,665.527C568.921,719.955 535.825,735.585 543.999,774.591C553.59,820.348 624.181,827.565 638,774.591C647.736,737.269 603.102,705.31 628.352,644.476C636.209,625.545 662.786,619.154 669.759,644.476C673.976,659.791 660.264,670.152 666.759,693.55C674.41,721.114 725.088,732.96 740.374,693.55C746.873,676.793 734.853,651.273 731.597,640.406C714.283,582.611 826.807,582.426 762.374,517.789C703.034,458.263 493.6,249.017 493.6,249.017C479.164,234.58 457.464,234.58 443.028,249.017L249.017,443.028C234.58,457.464 234.58,479.164 249.017,493.6C249.017,493.6 340.149,584.825 362.109,606.786Z" style="fill:white;"/>
+    </g>
+    <g transform="matrix(0.986683,0,0,0.986683,-136.081,-136.081)">
+        <path d="M733.962,560.164C740.987,553.139 740.987,541.733 733.962,534.708L482.173,282.92C475.148,275.895 463.742,275.895 456.717,282.92L431.261,308.376C424.237,315.4 424.237,326.807 431.261,333.831L683.05,585.62C690.075,592.645 701.481,592.645 708.506,585.62L733.962,560.164ZM439.639,559.207C446.664,552.182 446.664,540.776 439.639,533.751L335.491,429.602C328.466,422.578 317.059,422.578 310.035,429.602L284.579,455.058C277.554,462.083 277.554,473.489 284.579,480.514L388.728,584.663C395.752,591.688 407.159,591.688 414.184,584.663L439.639,559.207ZM584.306,556.624C591.331,549.599 591.331,538.192 584.306,531.168L409.115,355.977C402.091,348.953 390.684,348.953 383.66,355.977L358.204,381.433C351.179,388.458 351.179,399.864 358.204,406.889L533.394,582.079C540.419,589.104 551.825,589.104 558.85,582.079L584.306,556.624ZM298.425,246.543C311.081,259.198 311.081,279.747 298.425,292.402C285.77,305.058 265.221,305.058 252.566,292.402C239.911,279.747 239.911,259.198 252.566,246.543C265.221,233.888 285.77,233.888 298.425,246.543Z" style="fill:white;"/>
+    </g>
+</svg>

docs/colors.md

@@ -0,0 +1,75 @@
+---
+icon: material/palette
+---
+
+# :material-palette: 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. You can access the Tag Color Manager from the "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/contributing.md

@@ -0,0 +1,155 @@
+---
+icon: material/file-plus
+---
+
+# :material-file-plus: Contributing
+
+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](roadmap.md) page to see what priority features there are, the [FAQ](https://github.com/TagStudioDev/TagStudio/blob/main/README.md#faq), as well as the project's [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](roadmap.md) page
+-   I've read the [FAQ](https://github.com/TagStudioDev/TagStudio/blob/main/README.md#faq)
+-   I've checked the project's [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 CONTRIBUTING.md/Contributing page on the documentation site as well as the and/or [Style Guide](style.md)
+-   **_I mean it, I've found or created an issue for my feature/fix!_**
+
+<!-- prettier-ignore -->
+!!! 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 for everyone involved.
+
+## Creating a Development Environment
+
+If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarly with existing Python toolchains.
+
+If you know what you're doing and have developed for Python projects in the past, you can get started quickly with the "Brief Instructions" below. Otherwise, please see the full instructions on the documentation website for "[Creating a Development Environment](https://docs.tagstud.io/install/#creating-a-development-environment)".
+
+### Brief Instructions
+
+1.  Have [Python 3.12](https://www.python.org/downloads/) and PIP installed. Also have [FFmpeg](https://ffmpeg.org/download.html) installed if you wish to have audio/video playback and thumbnails.
+2.  Clone the repository to the folder of your choosing:
+    ```
+    git clone https://github.com/TagStudioDev/TagStudio.git
+    ```
+3.  Use a dependency manager such as [uv](https://docs.astral.sh/uv/) or [Poetry 2.0](https://python-poetry.org/blog/category/releases/) to install the required dependencies, or alternatively create and activate a [virtual environment](https://docs.tagstud.io/install/#manual-installation) with `venv`.
+
+4.  If using a virtual environment instead of a dependency manager, install an editable version of the program and development dependencies with the following PIP command:
+
+    ```
+    pip install -e ".[dev]"
+    ```
+
+    Otherwise, modify the command above for use with your dependency manager of choice. For example if using uv, you may use this:
+
+    ```
+    uv pip install -e ".[dev]"
+    ```
+
+## 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.
+
+<!-- prettier-ignore -->
+!!! 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)** Run the following:
+    -   `mkdir -p .mypy_cache`
+    -   `mypy --install-types --non-interactive`
+-   You can now check code by running `mypy --config-file pyproject.toml .` in the repository root. _(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 running `pytest tests/` in the repository root.
+
+## Code Style
+
+See the [Style Guide](style.md)
+
+### 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.
+
+<!-- prettier-ignore -->
+!!! 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 re-review all the already reviewed code, which is a lot of unnecessary work for reviewers.
+
+<!-- prettier-ignore -->
+!!! 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: 13.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 "[dash-case / kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_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._

docs/developing.md

@@ -0,0 +1,192 @@
+---
+icon: material/code-braces
+---
+
+# :material-code-braces: Developing
+
+If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarity with existing Python toolchains.
+
+<!-- prettier-ignore -->
+!!! tip "Contributing"
+    If you wish to contribute to TagStudio's development, please read our [CONTRIBUTING.md](https://github.com/TagStudioDev/TagStudio/blob/main/CONTRIBUTING.md)!
+
+## Installing Python
+
+Python [3.12](https://www.python.org/downloads) is required to develop for TagStudio. Any version matching "Python 3.12.x" should work, with "x" being any number. Alternatively you can use a tool such as [pyenv](https://github.com/pyenv/pyenv) to install this version of Python without affecting any existing Python installations on your system. Tools such as [uv](#installing-with-uv) can also install Python versions.
+
+<!-- prettier-ignore -->
+!!! info "Python Aliases"
+    Depending on your system, Python may be called `python`, `py`, `python3`, or `py3`. These instructions use the alias `python` for consistency.
+
+If you already have Python installed on your system, you can check the version by running the following command:
+
+```sh
+python --version
+```
+
+---
+
+### Installing with pyenv
+
+If you choose to install Python using pyenv, please refer to the following instructions:
+
+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.
+
+---
+
+## Cloning from GitHub
+
+The repository can be cloned/downloaded via `git` in your terminal, or by downloading the zip file from the "Code" button on the [repository page](https://github.com/TagStudioDev/TagStudio).
+
+```sh
+git clone https://github.com/TagStudioDev/TagStudio.git
+```
+
+## Installing Dependencies
+
+To install the required dependencies, you can use a dependency manager such as [uv](https://docs.astral.sh/uv) or [Poetry 2.0](https://python-poetry.org). Alternatively you can create a virtual environment and manually install the dependencies yourself.
+
+### Installing with uv
+
+If using [uv](https://docs.astral.sh/uv), you can install the dependencies for TagStudio with the following command:
+
+```sh
+uv pip install -e ".[dev]"
+```
+
+A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.envrc-uv`](https://github.com/TagStudioDev/TagStudio/blob/main/contrib/.envrc-uv).
+
+---
+
+### Installing with Poetry
+
+If using [Poetry](https://python-poetry.org), you can install the dependencies for TagStudio with the following command:
+
+```sh
+poetry install --with dev
+```
+
+---
+
+### Manual Installation
+
+If you choose to manually set up a virtual environment and install dependencies instead of using a dependency manager, please refer to the following instructions:
+
+<!-- prettier-ignore -->
+!!! tip "Virtual Environments"
+    Learn more about setting up a virtual environment with Python's [official tutorial](https://docs.python.org/3/tutorial/venv.html).
+
+1.  In the root repository directory, create a python virtual environment:
+
+    ```sh
+    python -m venv .venv
+    ```
+
+2.  Activate your environment:
+
+    -   Windows w/Powershell: `.venv\Scripts\Activate.ps1`
+    -   Windows w/Command Prompt: `.venv\Scripts\activate.bat`
+    -   Linux/macOS: `source .venv/bin/activate`
+
+    <!-- prettier-ignore -->
+    !!! info "Supported Shells"
+        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`  |
+        | PowerShell | `.venv/bin/activate.ps1`  |
+
+3.  Use the following PIP command to create an editable installation and install the required development dependencies:
+
+    ```sh
+    pip install -e ".[dev]"
+    ```
+
+## Nix(OS)
+
+If using [Nix](https://nixos.org/), there is a development environment already provided in the [flake](https://wiki.nixos.org/wiki/Flakes) that is accessible with the following command:
+
+```sh
+nix develop
+```
+
+A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/.envrc-nix`](https://github.com/TagStudioDev/TagStudio/blob/main/contrib/.envrc-nix).
+
+## Tooling
+
+### Editor Integration
+
+The entry point for TagStudio is `src/tagstudio/main.py`. You can target this file from your IDE to run or connect a debug session. The example(s) below show off example launch scripts for different IDEs. Here you can also take advantage of [launch arguments](./usage.md/#launch-arguments) to pass your own test [libraries](libraries.md) to use while developing. You can find more editor configurations in [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib).
+
+<!-- prettier-ignore -->
+=== "VS Code"
+    ```json title=".vscode/launch.json"
+    {
+        "version": "0.2.0",
+        "configurations": [
+            {
+                "name": "TagStudio",
+                "type": "python",
+                "request": "launch",
+                "program": "${workspaceRoot}/src/tagstudio/main.py",
+                "console": "integratedTerminal",
+                "justMyCode": true,
+                "args": ["-o", "~/Documents/Example"]
+            }
+        ]
+    }
+    ```
+
+### pre-commit
+
+There is a [pre-commit](https://pre-commit.com/) configuration that will run through some checks before code is committed. Namely, mypy and the Ruff linter and formatter will check your code, catching those nits right away.
+
+Once you have pre-commit installed, just run:
+
+```sh
+pre-commit install
+```
+
+From there, Git will automatically run through the hooks during commit actions!
+
+### direnv
+
+You can automatically enter this development shell, and keep your user shell, with a tool like [direnv](https://direnv.net/). Some reference `.envrc` files are provided in the repository at [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib).
+
+Two currently available are for [Nix](#nixos) and [uv](#installing-with-uv), to use one:
+
+```sh
+ln -s .envrc-$variant .envrc
+```
+
+You will have to allow usage of it.
+
+<!-- prettier-ignore -->
+!!! warning "direnv Security Framework"
+    These files are generally a good idea to check, as they execute commands on directory load. direnv has a security framework to only run `.envrc` files you have allowed, and does keep track on if it has changed. So, with that being said, the file may need to be allowed again if modifications are made.
+
+```sh
+cat .envrc # You are checking them, right?
+direnv allow
+```
+
+## Building
+
+To build your own executables of TagStudio, first follow the steps in "[Installing Dependencies](#installing-dependencies)." Once that's complete, run the following PyInstaller command:
+
+```
+pyinstaller tagstudio.spec
+```
+
+If you're on Windows or Linux and wish to build a portable executable, then pass the following flag:
+
+```
+pyinstaller tagstudio.spec -- --portable
+```
+
+The resulting executable file(s) will be located in a new folder named "dist".

docs/entries.md

@@ -0,0 +1,54 @@
+---
+icon: material/file
+---
+
+# :material-file: Entries
+
+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](tags.md) and metadata that you attach to it inside TagStudio.
+
+## Storage
+
+File entry data is stored 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 thumbnails inside the grid display. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
+
+## Unlinked Entries
+
+If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display its unlinked status with a red chain-link icon instead of its thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel.
+
+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 entries 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).
+    -   Generated 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).
+    -   Generated 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/fields.md

@@ -0,0 +1,27 @@
+---
+icon: material/text-box
+---
+
+# :material-text-box: Fields
+
+Fields are additional types of metadata that you can attach to [file entries](./entries.md). Like [tags](tags.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
+
+A date and time value.
+
+-   e.g: Date Published, Date Taken, etc.

docs/help/ffmpeg.md

@@ -0,0 +1,58 @@
+---
+icon: material/movie-open-cog
+---
+
+# :material-movie-open-cog: Installing 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 distribution 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/ignore.md

@@ -0,0 +1,322 @@
+---
+title: Ignoring Files
+icon: material/file-document-remove
+---
+
+# :material-file-document-remove: Ignoring Files & Directories
+
+<!-- prettier-ignore -->
+!!! warning "Legacy File Extension Ignoring"
+    TagStudio versions prior to v9.5.4 use a different, more limited method to exclude or include file extensions from your library and subsequent searches. Opening a pre-exiting library in v9.5.4 or later will non-destructively convert this to the newer, more extensive `.ts_ignore` format.
+
+    If you're still running an older version of TagStudio in the meantime, you can access the legacy system by going to "Edit -> Manage File Extensions" in the menubar.
+
+TagStudio offers the ability to ignore specific files and directories via a `.ts_ignore` file located inside your [library's](libraries.md) `.TagStudio` folder. This file is designed to use very similar [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>)-style pattern matching as the [`.gitignore`](https://git-scm.com/docs/gitignore) file used by Git™[^1]. It can be edited within TagStudio or opened to edit with an external program by going to the "Edit -> Ignore Files" option in the menubar.
+
+This file is only referenced when scanning directories for new files to add to your library, and does not apply to files that have already been added to your library.
+
+<!-- prettier-ignore -->
+!!! tip
+    If you just want some specific examples of how to achieve common tasks with the ignore patterns (e.g. ignoring a single file type, ignoring a specific folder) then jump to the "[Use Cases](#use-cases)" section!
+
+<!-- prettier-ignore-start -->
+=== "Example .ts_ignore file"
+```toml title="My Library/.TagStudio/.ts_ignore"
+# TagStudio .ts_ignore file.
+
+# Code
+__pycache__
+.pytest_cache
+.venv
+.vs
+
+# Projects
+Minecraft/**/Metadata
+Minecraft/Website
+!Minecraft/Website/*.png
+!Minecraft/Website/*.css
+
+# Documents
+*.doc
+*.docx
+*.ppt
+*.pptx
+*.xls
+*.xlsx
+```
+<!-- prettier-ignore-end -->
+
+## Pattern Format
+
+<!-- prettier-ignore -->
+!!! note ""
+    _This section sourced and adapted from Git's[^1] `.gitignore` [documentation](https://git-scm.com/docs/gitignore)._
+
+### Internal Processes
+
+When scanning your library directories, the `.ts_ignore` file is read by either the [`wcmatch`](https://facelessuser.github.io/wcmatch/glob/) library or [`ripgrep`](https://github.com/BurntSushi/ripgrep) in glob mode depending if you have the later installed on your system and it's detected by TagStudio. Ripgrep is the preferred method for scanning directories due to its improved performance and identical pattern matching to `.gitignore`. This mixture of tools may lead to slight inconsistencies if not using `ripgrep`.
+
+---
+
+### Comments ( `#` )
+
+A `#` symbol at the start of a line indicates that this line is a comment, and match no items. Blank lines are used to enhance readability and also match no items.
+
+-   Can be escaped by putting a backslash ("`\`") in front of the `#` symbol.
+
+<!-- prettier-ignore-start -->
+=== "Example comment"
+    ```toml
+    # This is a comment! I can say whatever I want on this line.
+    file_that_is_being_matched.txt
+
+    # file_that_is_NOT_being_matched.png
+    file_that_is_being_matched.png
+    ```
+=== "Organizing with comments"
+    ```toml
+    # TagStudio .ts_ignore file.
+
+    # Minecraft Stuff
+    Minecraft/**/Metadata
+    Minecraft/Website
+    !Minecraft/Website/*.png
+    !Minecraft/Website/*.css
+
+    # Microsoft Office
+    *.doc
+    *.docx
+    *.ppt
+    *.pptx
+    *.xls
+    *.xlsx
+    ```
+=== "Escape a # symbol"
+    ```toml
+    # To ensure a file named '#hashtag.jpg' is ignored:
+    \#hashtag.jpg
+    ```
+<!-- prettier-ignore-end -->
+
+---
+
+### Directories ( `/` )
+
+The forward slash "`/`" is used as the directory separator. Separators may occur at the beginning, middle or end of the `.ts_ignore` search pattern.
+
+-   If there is a separator at the beginning or middle (or both) of the pattern, then the pattern is relative to the directory level of the particular `.TagStudio` library folder itself. Otherwise the pattern may also match at any level below the `.TagStudio` folder level.
+
+-   If there is a separator at the end of the pattern then the pattern will only match directories, otherwise the pattern can match both files and directories.
+
+<!-- prettier-ignore-start -->
+=== "Example folder pattern"
+    ```toml
+    # Matches "frotz" and "a/frotz" if they are directories.
+    frotz/
+    ```
+=== "Example nested folder pattern"
+    ```toml
+    # Matches "doc/frotz" but not "a/doc/frotz".
+    doc/frotz/
+    ```
+<!-- prettier-ignore-end -->
+
+---
+
+### Negation ( `!` )
+
+A `!` prefix before a pattern negates the pattern, allowing any files matched matched by previous patterns to be un-matched.
+
+-   Any matching file excluded by a previous pattern will become included again.
+-   **It is not possible to re-include a file if a parent directory of that file is excluded.**
+
+<!-- prettier-ignore-start -->
+=== "Example negation"
+    ```toml
+    # All .jpg files will be ignored, except any located in the 'Photos' folder.
+    *.jpg
+    Photos/!*.jpg
+    ```
+=== "Escape a ! Symbol"
+    ```toml
+    # To ensure a file named '!wowee.jpg' is ignored:
+    \!wowee.jpg
+    ```
+<!-- prettier-ignore-end -->
+
+---
+
+### Wildcards
+
+#### Single Asterisks ( `*` )
+
+An asterisk "`*`" matches anything except a slash.
+
+<!-- prettier-ignore-start -->
+=== "File examples"
+    ```toml
+    # Matches all .png files in the "Images" folder.
+    Images/*.png
+
+    # Matches all .png files in all folders
+    *.png
+    ```
+=== "Folder examples"
+    ```toml
+    # Matches any files or folders directly in "Images/" but not deeper levels.
+    #   Matches file "Images/mario.jpg"
+    #   Matches folder "Images/Mario"
+    #   Does not match file "Images/Mario/cat.jpg"
+    Images/*
+    ```
+<!-- prettier-ignore-end -->
+
+#### Question Marks ( `?` )
+
+The character "`?`" matches any one character except "`/`".
+
+<!-- prettier-ignore-start -->
+=== "File examples"
+    ```toml
+    # Matches any .png file starting with "IMG_" and ending in any four characters.
+    #   Matches "IMG_0001.png"
+    #   Matches "Photos/IMG_1234.png"
+    #   Does not match "IMG_1.png"
+    IMG_????.png
+
+    # Same as above, except matches any file extension instead of only .png
+    IMG_????.*
+    ```
+=== "Folder examples"
+    ```toml
+    # Matches all files in any direct subfolder of "Photos" beginning in "20".
+    #   Matches "Photos/2000"
+    #   Matches "Photos/2024"
+    #   Matches "Photos/2099"
+    #   Does not match "Photos/1995"
+    Photos/20??/
+    ```
+<!-- prettier-ignore-end -->
+
+#### Double Asterisks ( `**` )
+
+Two consecutive asterisks ("`**`") in patterns matched against full pathname may have special meaning:
+
+-   A leading "`**`" followed by a slash means matches in all directories.
+-   A trailing "`/**`" matches everything inside.
+-   A slash followed by two consecutive asterisks then a slash ("`/**/`") matches zero or more directories.
+-   Other consecutive asterisks are considered regular asterisks and will match according to the previous rules.
+
+<!-- prettier-ignore-start -->
+=== "Leading **"
+    ```toml
+    # Both match file or directory "foo" anywhere
+    **/foo
+    foo
+
+    # Matches file or directory "bar" anywhere that is directly under directory "foo"
+    **/foo/bar
+    ```
+=== "Trailing /**"
+    ```toml
+    # Matches all files inside directory "abc" with infinite depth.
+    abc/**
+    ```
+=== "Middle /**/"
+    ```toml
+    # Matches "a/b", "a/x/b", "a/x/y/b" and so on.
+    a/**/b
+    ```
+<!-- prettier-ignore-end -->
+
+#### Square Brackets ( `[a-Z]` )
+
+Character sets and ranges are specific and powerful forms of wildcards that use characters inside of brackets (`[]`) to leverage very specific matching. The range notation, e.g. `[a-zA-Z]`, can be used to match one of the characters in a range.
+
+<!-- prettier-ignore -->
+!!! tip
+    For more in-depth examples and explanations on how to use ranges, please reference the [`glob`](https://man7.org/linux/man-pages/man7/glob.7.html) man page.
+
+<!-- prettier-ignore-start -->
+=== "Range examples"
+    ```toml
+    # Matches all files that start with "IMG_" and end in a single numeric character.
+        # Matches "IMG_0.jpg", "IMG_7.png"
+        # Does not match "IMG_10.jpg", "IMG_A.jpg"
+    IMG_[0-9]
+
+    # Matches all files that start with "IMG_" and end in a single alphabetic character
+    IMG_[a-z]
+    ```
+=== "Set examples"
+    ```toml
+    # Matches all files that start with "IMG_" and in any character in the set.
+        # Matches "draft_a.docx", "draft_b.docx", "draft_c.docx"
+        # Does not match "draft_d.docx"
+    draft_[abc]
+
+    # Matches all files that start with "IMG_" and end in a single alphabetic character
+    IMG_[a-z]
+    ```
+<!-- prettier-ignore-end -->
+
+---
+
+## Use Cases
+
+### Ignoring Files by Extension
+
+<!-- prettier-ignore -->
+=== "Ignore all .jpg files"
+    ```toml
+    *.jpg
+    ```
+=== "Ignore all files EXCEPT .jpg files"
+    ```toml
+    *
+    !*.jpg
+    ```
+=== "Ignore all .jpg files in specific folders"
+    ```toml
+    ./Photos/Worst Vacation/*.jpg
+    Music/Artwork Art/*.jpg
+    ```
+
+<!-- prettier-ignore -->
+!!! tip "Ensuring Complete Extension Matches"
+    For some filetypes, it may be nessisary to specify different casing and alternative spellings in order to match with all possible variations of an extension in your library.
+
+    ```toml title="Ignore (Most) Possible JPEG File Extensions"
+    # The JPEG Cinematic Universe
+    *.jpg
+    *.jpeg
+    *.jfif
+    *.jpeg_large
+    *.JPG
+    *.JPEG
+    *.JFIF
+    *.JPEG_LARGE
+    ```
+
+### Ignoring a Folder
+
+<!-- prettier-ignore -->
+=== "Ignore all "Cache" folders"
+    ```toml
+    # Matches any folder called "Cache" no matter where it is in your library.
+    cache/
+    ```
+=== "Ignore a "Downloads" folder"
+    ```toml
+    # "Downloads" must be a folder on the same level as your ".TagStudio" folder.
+    #   Does not match with folders name "Downloads" elsewhere in your library
+    #   Does not match with a file called "Downloads"
+    /Downloads/
+    ```
+=== "Ignore .jpg files in specific folders"
+    ```toml
+    Photos/Worst Vacation/*.jpg
+    /Music/Artwork Art/*.jpg
+    ```
+
+[^1]: The term "Git" is a licensed trademark of "The Git Project", a member of the Software Freedom Conservancy. Git is released under the [GNU General Public License version 2.0](https://opensource.org/license/GPL-2.0), an open source license. TagStudio is not associated with the Git Project, only including systems based on some therein.

docs/index.md

@@ -0,0 +1,111 @@
+---
+title: Home
+hide:
+    - toc
+    - navigation
+---
+
+#
+
+<link rel="stylesheet" href="stylesheets/home.css">
+
+<figure markdown="span">
+  ![TagStudio](./assets/ts-9-3_logo_text.png){ width=80% }<h2>A User-Focused Photo & File Management System</h2>
+</figure>
+
+<br>
+
+<figure markdown="span">
+  ![TagStudio screenshot](./assets/screenshot.png){ width=80% }
+  <figcaption>TagStudio Alpha v9.5.5 running on macOS Sequoia.</figcaption>
+</figure>
+
+<div class="grid" markdown>
+
+![TagStudio screenshot](./assets/tag_bubbles.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.
+
+</div>
+
+<figure markdown="span">
+  [:material-download: Download Latest Release](https://github.com/TagStudioDev/TagStudio/releases){ .md-button .md-button--primary }
+</figure>
+
+## :material-star: Core Features
+
+<div class="grid cards" markdown>
+
+-   :material-file-multiple:{ .lg .middle } **[All Files](entries.md) Welcome**
+
+    ***
+
+    TagStudio works with photos, videos, music, documents, and more! **All file types** are recognized by TagStudio, with most common ones having built-in preview support.
+
+    [:material-arrow-right: See Full Preview Support](preview-support.md)
+
+-   :material-tag-text:{ .lg .middle } **Create [Tags](tags.md) Your Way**
+
+    ***
+
+    -   :material-format-font: No character restrictions
+    -   :material-form-textbox: Add aliases/alternate names
+    -   :material-palette: Customize colors and styles
+    -   :material-tag-multiple: Tags can be tagged with other tags!
+    -   :material-star-four-points: And more!
+
+-   :material-magnify:{ .lg .middle } **Powerful [Search](search.md)**
+
+    ***
+
+    -   Full [Boolean operator](search.md) support
+    -   Filenames, paths, and extensions with [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax
+    -   General media types (e.g. "Photo", "Video", "Document")
+    -   Special searches (e.g. "Untagged")
+    -   "[Smartcase](search.md#case-sensitivity)" case sensitivity
+
+-   :material-text-box:{ .lg .middle } **Text and Date [Fields](fields.md)**
+
+    ***
+
+    Along with tags, add custom metadata fields such as text and dates to your files!
+
+    This is useful for adding notes and descriptions, titling files, and keeping track of extra dates and times.
+
+</div>
+
+## :material-toolbox: Built Different
+
+<div class="grid cards" markdown>
+
+-   :material-scale-balance:{ .lg .middle } **Open Source**
+
+    ***
+
+    TagStudio is licensed under the GPL-3.0 license with the source code and executable releases available on [GitHub](https://github.com/TagStudioDev/TagStudio).
+
+    [:material-arrow-right: View License](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE)
+
+    [:material-arrow-right: Roadmap to MIT Core Library License](roadmap.md#core-library-api)
+
+-   :material-database:{ .lg .middle } **Central Save File**
+
+    ***
+
+    Apposed to filling your drives with [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file), TagStudio uses a project-like [library](libraries.md) system that stores your tags and metadata inside a single save file per-library.
+
+    [:material-arrow-right: Learn About the Format](libraries.md)
+
+</div>
+
+---
+
+## :material-layers-triple: More Than an Application
+
+TagStudio aims to create an **open** and **robust** format for file tagging that isn't burdened by the limitations of traditional tagging and file metadata systems. **TagStudio** is the first proof-of-concept implementation of this system.
+
+<div class="grid cards" markdown>
+
+-   :material-map-check:{ .lg .middle } See the [**Roadmap**](roadmap.md) for future features and updates
+
+</div>

docs/install.md

@@ -0,0 +1,242 @@
+---
+icon: material/download
+---
+
+# :material-download: Installation
+
+TagStudio provides executable [releases](https://github.com/TagStudioDev/TagStudio/releases) as well as full access to its [source code](https://github.com/TagStudioDev/TagStudio) under the [GPLv3](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) license.
+
+## Executables
+
+To download executable builds of TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) page of the GitHub repository and download the latest release for your system under the "Assets" section at the bottom of the release.
+
+TagStudio has builds for :fontawesome-brands-windows: **Windows**, :fontawesome-brands-apple: **macOS** _(Apple Silicon & Intel)_, and :material-penguin: **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
+
+<!-- prettier-ignore -->
+!!! info "Third-Party Dependencies"
+    You may need to install [third-party dependencies](#third-party-dependencies) such as [FFmpeg](https://ffmpeg.org/download.html) to use the full feature set of TagStudio.
+
+<!-- prettier-ignore -->
+!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
+    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.
+
+---
+
+## Package Managers
+
+<!-- prettier-ignore -->
+!!! danger "Unofficial Releases"
+    **We do not currently publish TagStudio to _remote_ package repositories. Any TagStudio distributions outside of the [GitHub repository](https://github.com/TagStudioDev/TagStudio) 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!
+
+### :fontawesome-brands-python: Installing with PIP
+
+TagStudio is installable via [PIP](https://pip.pypa.io/). Note that since we don't currently distribute on PyPI, the repository needs to be cloned and installed locally. Make sure you have Python 3.12 and PIP installed if you choose to install using this method.
+
+The repository can be cloned/downloaded via `git` in your terminal, or by downloading the zip file from the "Code" button on the [repository page](https://github.com/TagStudioDev/TagStudio).
+
+```sh
+git clone https://github.com/TagStudioDev/TagStudio.git
+```
+
+Once cloned or downloaded, you can install TagStudio with the following PIP command:
+
+```sh
+pip install .
+```
+
+<!-- prettier-ignore -->
+!!! note "Developer Dependencies"
+    If you wish to create an editable install with the additional dependencies required for developing TagStudio, use this modified PIP command instead:
+    ```sh
+    pip install -e ".[dev]"
+    ```
+    _See more under "[Developing](developing.md)"_
+
+TagStudio can now be launched via the `tagstudio` command in your terminal.
+
+---
+
+### :material-penguin: Linux
+
+Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
+
+<!-- prettier-ignore -->
+| Package | Reason |
+|--------------- | --------------- |
+| [dbus](https://repology.org/project/dbus) | required for Qt; opening desktop applications |
+| [ffmpeg](https://repology.org/project/ffmpeg) | audio/video playback |
+| libstdc++ | required for Qt |
+| [libva](https://repology.org/project/libva) | hardware rendering with [VAAPI](https://www.freedesktop.org/wiki/Software/vaapi) |
+| [libvdpau](https://repology.org/project/libvdpau) | hardware rendering with [VDPAU](https://www.freedesktop.org/wiki/Software/VDPAU) |
+| [libx11](https://repology.org/project/libx11) | required for Qt |
+| libxcb-cursor OR [xcb-util-cursor](https://repology.org/project/xcb-util-cursor) | required for Qt |
+| [libxkbcommon](https://repology.org/project/libxkbcommon) | required for Qt |
+| [libxrandr](https://repology.org/project/libxrandr) | hardware rendering |
+| [pipewire](https://repology.org/project/pipewire) | PipeWire audio support |
+| [qt](https://repology.org/project/qt) | required |
+| [qt-multimedia](https://repology.org/project/qt) | required |
+| [qt-wayland](https://repology.org/project/qt) | Wayland support |
+
+### :material-nix: Nix(OS)
+
+For [Nix(OS)](https://nixos.org/), the TagStudio repository includes a [flake](https://wiki.nixos.org/wiki/Flakes) that provides some outputs such as a development shell and package.
+
+Two packages are provided: `tagstudio` and `tagstudio-jxl`. The distinction was made because `tagstudio-jxl` has an extra compilation step for [JPEG-XL](https://jpeg.org/jpegxl) image support. To give either of them a test run, you can execute `nix run github:TagStudioDev/TagStudio#tagstudio`. If you are in a cloned repository and wish to run a package with the context of the repository, you can simply use `nix run` with no arguments.
+
+`nix build` can be used in place of `nix run` if you only want to build. **The packages will only build if tests pass.**
+
+<!-- prettier-ignore -->
+!!! info "Nix Support"
+    Support for Nix is handled on a best-effort basis by one of our maintainers. Issues related to Nix may be slower to resolve, and could require further details.
+
+Want to add TagStudio into your configuration?
+
+This can be done by first adding the flake input into your `flake.nix`:
+
+```nix title="flake.nix"
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+
+    tagstudio = {
+      url = "github:TagStudioDev/TagStudio";
+      inputs.nixpkgs.follows = "nixpkgs"; # Use the same package set as your flake.
+    };
+  };
+}
+```
+
+Then, make sure you add the `inputs` context to your configuration:
+
+<!-- prettier-ignore-start -->
+=== "NixOS with Home Manager"
+    ```nix title="flake.nix"
+    {
+      outputs =
+        inputs@{ home-manager, nixpkgs, ... }:
+          {
+            nixosConfigurations.HOSTNAME = nixpkgs.lib.nixosSystem {
+              system = "x86_64-linux";
+
+              specialArgs = { inherit inputs; };
+              modules = [
+                ./configuration.nix
+
+                home-manager.nixosModules.home-manager
+                {
+                  home-manager = {
+                    useGlobalPkgs = true;
+                    useUserPackages = true;
+
+                    extraSpecialArgs = { inherit inputs; };
+                    users.USER.imports = [
+                      ./home.nix
+                    ];
+                  };
+                }
+              ];
+            };
+          };
+    }
+    ```
+=== "NixOS"
+    ```nix title="flake.nix"
+    {
+      outputs =
+        inputs@{ nixpkgs, ... }:
+          {
+            nixosConfigurations.HOSTNAME = nixpkgs.lib.nixosSystem {
+              system = "x86_64-linux";
+
+              specialArgs = { inherit inputs; };
+              modules = [
+                ./configuration.nix
+              ];
+            };
+          };
+    }
+    ```
+=== "Home Manager (standalone)"
+    ```nix title="flake.nix"
+    {
+      outputs =
+        inputs@{ home-manager, nixpkgs, ... }:
+        let
+          pkgs = import nixpkgs {
+            system = "x86_64-linux";
+          };
+        in
+        {
+          homeConfigurations.USER = home-manager.lib.homeManagerConfiguration {
+            inherit pkgs;
+
+            extraSpecialArgs = { inherit inputs; };
+            modules = [
+              ./home.nix
+            ];
+          };
+        };
+    }
+    ```
+<!-- prettier-ignore-end -->
+
+Finally, `inputs` can be used in a module to add the package to your packages list:
+
+<!-- prettier-ignore-start -->
+=== "Home Manager module"
+    ```nix title="home.nix"
+    { inputs, pkgs, ... }:
+
+    {
+      home.packages = [
+        inputs.tagstudio.packages.${pkgs.stdenv.hostPlatform.system}.tagstudio
+      ];
+    }
+    ```
+=== "NixOS module"
+    ```nix title="configuration.nix"
+    { inputs, pkgs, ... }:
+
+    {
+      environment.systemPackages = [
+        inputs.tagstudio.packages.${pkgs.stdenv.hostPlatform.system}.tagstudio
+      ];
+    }
+    ```
+<!-- prettier-ignore-end -->
+
+Don't forget to rebuild!
+
+## Third-Party Dependencies
+
+<!-- prettier-ignore -->
+!!! tip
+    You can check to see if these dependencies are correctly located by launching TagStudio and going to "About TagStudio" in the menu bar.
+
+### FFmpeg/FFprobe
+
+For audio/video thumbnails and playback you'll 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.
+
+### RAR Extractor
+
+To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extractor capable of handling them.
+
+-   :material-penguin: On Linux you'll need to install either `unrar` (likely in you distro's non-free repository) or `unrar-free` from your package manager.
+
+-   :fontawesome-brands-apple: On macOS `unrar` can be installed through Homebrew's [`rar`](https://formulae.brew.sh/cask/rar) formula.
+
+    <!-- prettier-ignore -->
+    !!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
+        On macOS, you may be met with a message similar to  "**"unrar" Not Opened. Apple could not verify "unrar" is free of malware that may harm your Mac or compromise your privacy**" 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 "**"unrar" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow unrar to be used.
+
+-   :fontawesome-brands-windows: On Windows you'll need to install either [`WinRAR`](https://www.rarlab.com/download.htm) or [`7-zip`](https://www.7-zip.org/) and add their folder to you `PATH`.
+
+    <!-- prettier-ignore -->
+    !!! tip "WinRAR License"
+        Both `unrar` and `WinRAR` require a license, but since the evaluation copy has no time limit you can simply dismiss the prompt.
+
+### ripgrep
+
+A recommended tool to improve the performance of directory scanning is [`ripgrep`](https://github.com/BurntSushi/ripgrep), a Rust-based directory walker that natively integrates with our [`.ts_ignore`](ignore.md) (`.gitignore`-style) pattern matching system for excluding files and directories. Ripgrep is already pre-installed on some Linux distributions and also available from several package managers.

docs/libraries.md

@@ -0,0 +1,13 @@
+---
+icon: material/database
+---
+
+# :material-database: Libraries
+
+<!-- prettier-ignore -->
+!!! info
+    This page is a work in progress and needs to be updated with additional information.
+
+The library is how TagStudio represents your chosen directory, with every file inside being represented by a [file entry](entries.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](tags.md) you create only exist _per-library_. Global tags along with other library structure updates are planned for future releases on the [roadmap](roadmap.md#library).

docs/library-changes.md

@@ -0,0 +1,125 @@
+---
+icon: material/database-edit
+---
+
+# :material-database-edit: Library Format
+
+This page outlines the various changes made to the TagStudio library save file format over time, sometimes referred to as the "database" or "database file".
+
+---
+
+## JSON
+
+Legacy (JSON) library save format versions were tied to the release version of the program itself. This number was stored in a `version` key inside the JSON file.
+
+### Versions 1.0.0 - 9.4.2
+
+| Used From | Format | Location                                      |
+| --------- | ------ | --------------------------------------------- |
+| v1.0.0    | 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).
+
+---
+
+## SQLite
+
+Starting with TagStudio [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1), the library save format has been moved to a [SQLite](https://sqlite.org) format. Legacy JSON libraries are migrated (with the user's consent) to the new format when opening in current versions of the program. The save format versioning is now separate from the program's versioning number.
+
+Versions **1-100** stored the database version in a table called `preferences` in a row with the `key` column of `"DB_VERSION"` inside the corresponding `value` column.
+
+Versions **>101** store the database version in a table called `versions` in a row with the `key` column of `'CURRENT'` inside the corresponding `value` column. The `versions` table also stores the initial database version in which the file was created with under the `'INITIAL'` key. Databases created before this key was introduced will always have `'INITIAL'` value of `100`.
+
+```mermaid
+erDiagram
+  versions {
+    TEXT key PK "Values: ['INITIAL', 'CURRENT']"
+    INTEGER value
+  }
+```
+
+### Versions 1 - 5
+
+These versions were used while developing the new SQLite file format, outside any official or recommended release. These versions **were never supported** in any official capacity and were actively warned against using for real libraries.
+
+---
+
+### Version 6
+
+| Used From                                                                       | Format | Location                                        |
+| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [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.
+
+---
+
+### Version 7
+
+| Used From                                                                       | Format | Location                                        |
+| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.0-pr2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   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.
+
+---
+
+### Version 8
+
+| Used From                                                                       | Format | Location                                        |
+| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.0-pr4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   Adds the `color_border` column to the `tag_colors` table. Used for instructing the [secondary color](colors.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 new `color_border` property.
+
+---
+
+### Version 9
+
+| Used From                                                               | Format | Location                                        |
+| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.2) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   Adds the `filename` column to the `entries` table. Used for sorting entries by filename in search results.
+
+---
+
+### Version 100
+
+| Used From                                                                                            | Format | Location                                        |
+| ---------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [74383e3](https://github.com/TagStudioDev/TagStudio/commit/74383e3c3c12f72be1481ab0b86c7360b95c2d85) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   Introduces built-in minor versioning
+    -   The version number divided by 100 (and floored) constitutes the **major** version. Major version indicate breaking changes that prevent libraries from being opened in TagStudio versions older than the ones they were created in.
+    -   Values more precise than this ("ones" through "tens" columns) constitute the **minor** version. These indicate minor changes that don't prevent a newer library from being opened in an older version of TagStudio, as long as the major version is not also increased.
+-   Swaps `parent_id` and `child_id` values in the `tag_parents` table
+
+#### Version 101
+
+| Used From                                                               | Format | Location                                        |
+| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   Deprecates the `preferences` table, set to be removed in a future TagStudio version.
+-   Introduces the `versions` table
+    -   Has a string `key` column and an int `value` column
+    -   The `key` column stores one of two values: `'INITIAL'` and `'CURRENT'`
+    -   `'INITIAL'` stores the database version number in which in was created
+        -   Pre-existing databases set this number to `100`
+    -   `'CURRENT'` stores the current database version number
+
+#### Version 102
+
+| Used From                                                               | Format | Location                                        |
+| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
+| [v9.5.4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
+
+-   Applies repairs to the `tag_parents` table created in [version 100](#version-100), removing rows that reference tags that have been deleted.

docs/macros.md

@@ -0,0 +1,50 @@
+---
+icon: material/script-text
+---
+
+# :material-script-text: Tools & Macros
+
+Tools and macros are features that serve to create a more fluid [library](libraries.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](entries.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](fields.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 a future update.
+
+### Sort fields
+
+Tool is in development. Will allow for user-defined sorting of [fields](fields.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](tags.md#parent-tags). Tags will initially be named after the folders, but can be fully edited and customized afterwards.

docs/preview-support.md

@@ -0,0 +1,148 @@
+---
+icon: material/image-check
+---
+
+# :material-image-check: Supported Previews
+
+TagStudio offers built-in preview and thumbnail support for a wide variety of file types. Files that don't have explicit support can still be added to your library like normal, they will just show a default icon for thumbnails and previews. TagStudio also references the file's [MIME](https://en.wikipedia.org/wiki/Media_type) type in an attempt to render previews for file types that haven't gained explicit support yet.
+
+### :material-image-outline: Images
+
+Images will generate thumbnails the first time they are viewed or since the last time they were modified. Thumbnails are used in the grid view, but not in the Preview Panel. Animated images will play in the Preview Panel.
+
+| Filetype             | Extensions                                         |              Animation              |
+| -------------------- | -------------------------------------------------- | :---------------------------------: |
+| Animated PNG         | `.apng`                                            | :material-check-circle:{.lg .green} |
+| Apple Icon Image     | `.icns`                                            | :material-minus-circle:{.lg .gray}  |
+| AVIF                 | `.avif`                                            | :material-minus-circle:{.lg .gray}  |
+| Bitmap               | `.bmp`                                             | :material-minus-circle:{.lg .gray}  |
+| GIF                  | `.gif`                                             | :material-check-circle:{.lg .green} |
+| HEIF                 | `.heif`, `.heic`                                   | :material-minus-circle:{.lg .gray}  |
+| JPEG                 | `.jpeg`, `.jpg`, `.jfif`, `.jif`, `.jpg_large`[^1] | :material-minus-circle:{.lg .gray}  |
+| JPEG-XL              | `.jxl`                                             |  :material-close-circle:{.lg .red}  |
+| OpenEXR              | `.exr`                                             | :material-minus-circle:{.lg .gray}  |
+| OpenRaster           | `.ora`                                             | :material-minus-circle:{.lg .gray}  |
+| PNG                  | `.png`                                             | :material-minus-circle:{.lg .gray}  |
+| SVG                  | `.svg`                                             |  :material-close-circle:{.lg .red}  |
+| TIFF                 | `.tiff`, `.tif`                                    | :material-minus-circle:{.lg .gray}  |
+| Valve Texture Format | `.vtf`                                             |  :material-close-circle:{.lg .red}  |
+| WebP                 | `.webp`                                            | :material-check-circle:{.lg .green} |
+| Windows Icon         | `.ico`                                             | :material-minus-circle:{.lg .gray}  |
+
+#### :material-image-outline: RAW Images
+
+| Filetype                         | Extensions             |
+| -------------------------------- | ---------------------- |
+| Camera Image File Format (Canon) | `.crw`, `.cr2`, `.cr3` |
+| Digital Negative                 | `.dng`                 |
+| Fuji RAW                         | `.raf`                 |
+| Nikon RAW                        | `.nef`, `.nrw`         |
+| Olympus RAW                      | `.orf`                 |
+| Panasonic RAW                    | `.raw`, `.rw2`         |
+| Sony RAW                         | `.arw`                 |
+
+### :material-movie-open: Videos
+
+Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](install.md#third-party-dependencies) installed on your system.
+
+| Filetype              | Extensions              | Dependencies |
+| --------------------- | ----------------------- | :----------: |
+| 3GP                   | `.3gp`                  |    FFmpeg    |
+| AVI                   | `.avi`                  |    FFmpeg    |
+| AVIF                  | `.avif`                 |    FFmpeg    |
+| FLV                   | `.flv`                  |    FFmpeg    |
+| HEVC                  | `.hevc`                 |    FFmpeg    |
+| Matroska              | `.mkv`                  |    FFmpeg    |
+| MP4                   | `.mp4` , `.m4p`         |    FFmpeg    |
+| MPEG Transport Stream | `.ts`                   |    FFmpeg    |
+| QuickTime             | `.mov`, `.movie`, `.qt` |    FFmpeg    |
+| WebM                  | `.webm`                 |    FFmpeg    |
+| WMV                   | `.wmv`                  |    FFmpeg    |
+
+### :material-sine-wave: Audio
+
+Audio thumbnails will default to embedded cover art (if any) and fallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](install.md#third-party-dependencies) installed on your system. Audio waveforms are currently not cached.
+
+| Filetype            | Extensions               | Dependencies |
+| ------------------- | ------------------------ | :----------: |
+| AAC                 | `.aac`, `.m4a`           |    FFmpeg    |
+| AIFF                | `.aiff`, `.aif`, `.aifc` |    FFmpeg    |
+| Apple Lossless[^2]  | `.alac`, `.aac`          |    FFmpeg    |
+| FLAC                | `.flac`                  |    FFmpeg    |
+| MP3                 | `.mp3`                   |    FFmpeg    |
+| Ogg                 | `.ogg`                   |    FFmpeg    |
+| WAVE                | `.wav`, `.wave`          |    FFmpeg    |
+| Windows Media Audio | `.wma`                   |    FFmpeg    |
+
+### :material-file-chart: Documents
+
+Preview support for office documents or well-known project file formats varies by the format and whether or not embedded thumbnails are available to be read from. OpenDocument-based files are typically supported.
+
+| Filetype                      | Extensions            | Preview Type                                                               |
+| ----------------------------- | --------------------- | -------------------------------------------------------------------------- |
+| Blender                       | `.blend`, `.blend<#>` | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
+| Keynote (Apple iWork)         | `.key`                | Embedded thumbnail                                                         |
+| Krita[^3]                     | `.kra`, `.krz`        | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
+| MuseScore                     | `.mscz`               | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
+| Numbers (Apple iWork)         | `.numbers`            | Embedded thumbnail                                                         |
+| OpenDocument Presentation     | `.odp`, `.fodp`       | Embedded thumbnail                                                         |
+| OpenDocument Spreadsheet      | `.ods`, `.fods`       | Embedded thumbnail                                                         |
+| OpenDocument Text             | `.odt`, `.fodt`       | Embedded thumbnail                                                         |
+| Pages (Apple iWork)           | `.pages`              | Embedded thumbnail                                                         |
+| PDF                           | `.pdf`                | First page render                                                          |
+| Photoshop                     | `.psd`                | Flattened image render                                                     |
+| PowerPoint (Microsoft Office) | `.pptx`, `.ppt`       | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
+
+### :material-book: eBooks
+
+| Filetype           | Extensions            | Preview Type                 |
+| ------------------ | --------------------- | ---------------------------- |
+| EPUB               | `.epub`               | Embedded cover               |
+| Comic Book Archive | `.cbr`, `.cbt` `.cbz` | Embedded cover or first page |
+
+### :material-cube-outline: 3D Models
+
+<!-- prettier-ignore -->
+!!! failure "3D Model Support"
+    TagStudio does not currently support previews for 3D model files *(outside of Blender project embedded thumbnails)*. This is on our [roadmap](roadmap.md#uiux) for a future release.
+
+### :material-format-font: Fonts
+
+Font thumbnails will use a "Aa" example preview of the font, with a full alphanumeric of the font available in the Preview Panel.
+
+| Filetype             | Extensions        |
+| -------------------- | ----------------- |
+| OpenType Font        | `.otf`, `.otc`    |
+| TrueType Font        | `.ttf`, `.ttc`    |
+| Web Open Font Format | `.woff`, `.woff2` |
+
+### :material-text-box: Text
+
+<!-- prettier-ignore -->
+!!! info "Plain Text Support"
+    TagStudio supports the *vast* majority of files considered to be "[plain text](https://en.wikipedia.org/wiki/Plain_text)". If an extension or format is not listed here, odds are it's still supported anyway.
+
+Text files render the first 256 bytes of text information to an image preview for thumbnails and the Preview Panel. Improved thumbnails, full scrollable text, and syntax highlighting are on our [roadmap](roadmap.md#uiux) for future features.
+
+| Filetype   | Extensions                                    |        Syntax Highlighting         |
+| ---------- | --------------------------------------------- | :--------------------------------: |
+| CSV        | `.csv`                                        | :material-close-circle:{.lg .red}  |
+| HTML       | `.html`, `.htm`, `.xhtml`, `.shtml`, `.dhtml` | :material-close-circle:{.lg .red}  |
+| JSON       | `.json`, `.jsonc`, `.json5`                   | :material-close-circle:{.lg .red}  |
+| Markdown   | `.md`, `.markdown`, `.mkd`, `.rmd`            | :material-close-circle:{.lg .red}  |
+| Plain Text | `.txt`, `.text`                               | :material-minus-circle:{.lg .gray} |
+| TOML       | `.toml`                                       | :material-close-circle:{.lg .red}  |
+| XML        | `.xml`, `.xul`                                | :material-close-circle:{.lg .red}  |
+| YAML       | `.yaml`, `.yml`                               | :material-close-circle:{.lg .red}  |
+
+<!-- prettier-ignore-start -->
+[^1]:
+    The `.jpg_large` extension is unofficial and instead the byproduct of how [Google Chrome used to download images from Twitter](https://fileinfo.com/extension/jpg_large). Since this mangled extension is still in circulation, TagStudio supports it.
+
+[^2]:
+    Apple Lossless traditionally uses `.m4a` and `.caf` containers, but may unofficially use the `.alac` extension. The `.m4a` container is also used for separate compressed audio codecs.
+
+[^3]:
+    Krita also supports saving projects as OpenRaster `.ora` files. Support for these is listed in the "[Images](#images)" section.
+
+<!-- prettier-ignore-end -->

docs/roadmap.md

@@ -0,0 +1,283 @@
+---
+icon: material/map-check
+---
+
+# :material-map-check: Roadmap
+
+This page outlines the current and planned features required for TagStudio to be considered "feature complete" (v10.0.0). Features and changes are broken up by group in order to better assess the overall state of those features. [Priority levels](#priority-levels) and [version estimates](#version-estimates) are provided in order to give a rough idea of what's planned and when it may release.
+
+This roadmap will update as new features are planned or completed. If there's a feature you'd like to see but is not listed on this page, please check the GitHub [Issues](https://github.com/TagStudioDev/TagStudio/issues) page and submit a feature request if one does not already exist!
+
+## Priority Levels
+
+Planned features and changes are assigned **priority levels** to signify how important they are to the feature-complete version of TagStudio and to serve as a general guide for what should be worked on first, along with [version estimates](#version-estimates). When features are completed, their priority level icons are removed.
+
+<!-- prettier-ignore -->
+!!! info "Priority Level Icons"
+    -   :material-chevron-triple-up:{ .priority-high title="High Priority" } **High Priority** - Core features
+    -   :material-chevron-double-up:{ .priority-med title="Medium Priority" } **Medium Priority** - Important, but not necessary
+    -   :material-chevron-up:{ .priority-low title="Low Priority" } **Low Priority** - Just nice to have
+
+## Version Estimates
+
+Features are given rough estimations for which version they will be completed in, and are listed next to their names (e.g. Feature **[v9.0.0]**). They are eventually replaced with links to the version changelog in which they were completed in, if applicable.
+
+<!-- prettier-ignore -->
+!!! tip
+    For a more definitive and up-to-date list of features planned for near-future updates, please reference the current GitHub [Milestones](https://github.com/TagStudioDev/TagStudio/milestones)!
+
+---
+
+## Core
+
+### :material-database: SQL Library Database
+
+An improved SQLite-based library save file format in which legacy JSON libraries are be migrated to.
+Must be finalized or deemed "feature complete" before other core features are developed or finalized.
+
+<!-- prettier-ignore -->
+!!! note
+    See the "[Library](#library)" section for features related to the library database rather than the underlying schema.
+
+-   [x] A SQLite-based library save file format **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+-   [ ] Cached File Properties Table :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [x] Date Entry Added to Library :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Date File Created :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Date File Modified :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Date Photo Taken :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Media Duration :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Media Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Word Count :material-chevron-up:{ .priority-low title="Low Priority" }
+
+### :material-database-cog: Core Library + API
+
+A separated, UI agnostic core library that would be used to interface with the TagStudio library format. Would host an API for communication from outside the program. This would be licensed under the more permissive [MIT](https://en.wikipedia.org/wiki/MIT_License) license to foster wider adoption compared to the TagStudio application source code.
+
+-   [ ] Core Library :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+-   [ ] Core Library API :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+-   [ ] MIT License :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+
+### :material-clipboard-text: Format Specification
+
+A detailed written specification for the TagStudio tag and/or library format. Intended for used by third-parties to build alternative cores or protocols that can remain interoperable.
+
+-   [ ] Format Specification Established :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+
+---
+
+## Application
+
+### :material-button-cursor: UI/UX
+
+-   [x] Library Grid View
+    -   [ ] Explore Filesystem in Grid View :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Infinite Scrolling (No Pagination) :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Library List View :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Explore Filesystem in List View :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Lightbox View :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   Similar to List View in concept, but displays one large preview that can cycle back/forth between entries.
+    -   [ ] Smaller thumbnails of immediate adjacent entries below :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [x] Library Statistics Screen **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+-   [x] Unified Library Health/Cleanup Screen **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+    -   [x] Fix Unlinked Entries
+    -   [x] Fix Duplicate Files
+    -   [x] ~~Fix Duplicate Entries~~
+    -   [x] Remove Ignored Entries **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+    -   [x] Delete Old Backups **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+    -   [x] Delete Legacy JSON File **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+-   [x] Translations
+-   [ ] Search Bar Rework :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]**
+    -   [ ] Improved Tag Autocomplete :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Tags appear as widgets in search bar :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [x] Unified Media Player
+    -   [x] Auto-Hiding Player Controls
+    -   [x] Play/Pause
+    -   [x] Loop
+    -   [x] Toggle Autoplay
+    -   [x] Volume Control
+    -   [x] Toggle Mute
+    -   [x] Timeline scrubber
+    -   [ ] Fullscreen :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Fine-Tuned UI/UX :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6]**
+-   [ ] 3D Model Thumbnails/Previews :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] STL File Support
+    -   [ ] OBJ File Support
+-   [ ] Plaintext Thumbnails/Previews :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [x] Basic Support
+    -   [ ] Full File Preview :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Syntax Highlighting :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Toggleable Persistent Tagging Panel :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Top Tags
+    -   [ ] Recent Tags
+    -   [ ] Tag Search
+    -   [ ] Pinned Tags
+-   [ ] New Tabbed Tag Building UI to Support New Tag Features :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Custom Thumbnail Overrides :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Media Duration Labels :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Word/Line Count Labels :material-chevron-up:{ .priority-low title="Low Priority" }
+-   [ ] Custom Tag Badges :material-chevron-up:{ .priority-low title="Low Priority" }
+    -   Would serve as an addition/alternative to the Favorite and Archived badges.
+
+### :material-cog: Settings
+
+-   [x] Application Settings
+    -   [x] Stored in System User Folder/Designated Folder
+    -   [x] Language
+    -   [x] Date and Time Format
+    -   [x] Theme
+    -   [x] Thumbnail Generation **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+-   [x] Configurable Page Size
+-   [ ] Library Settings :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Stored in `.TagStudio` folder :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Toggle File Extension Label :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Toggle Duration Label :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+
+### :material-puzzle: Plugin Support
+
+Some form of official plugin support for TagStudio, likely with its own API that may connect to or encapsulate part of the the [core library API](#core-library-api).
+
+-   [ ] Plugin Support :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+
+---
+
+## [Library](libraries.md)
+
+### :material-wrench: Library Mechanics
+
+-   [x] Per-Library Tags
+-   [ ] Global Tags :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Multiple Root Directories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Ability to store TagStudio library folder separate from library files :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Automatic Entry Relinking :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]**
+    -   [ ] Detect Renames :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Detect Moves :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Detect Deletions :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Performant :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Background File Scanning :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]**
+-   [x] Thumbnail Caching **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [ ] Audio Waveform Caching :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.x]**
+
+### :material-grid: [Entries](entries.md)
+
+Library representations of files or file-like objects.
+
+-   [x] File Entries **[v1.0.0]**
+-   [ ] Folder Entries :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] URL Entries / Bookmarks :material-chevron-up:{ .priority-low title="Low Priority" }
+-   [x] Fields
+    -   [x] Text Lines
+    -   [x] Text Boxes
+    -   [x] Datetimes **[[v9.5.4](changelog.md#954-september-1st-2025)]**
+    -   [ ] User-Titled Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+        -   [ ] Removal of Deprecated Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Entry Groups :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]**
+    -   [ ] Non-exclusive; Entries can be in multiple groups :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Ability to number entries within group :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Ability to set sorting method for group :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Ability to set custom thumbnail for group :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Group is treated as entry with tags and metadata :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Nested groups :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+
+### :material-tag-text: [Tags](tags.md)
+
+Discrete library objects representing [attributes](<https://en.wikipedia.org/wiki/Property_(philosophy)>). Can be applied to library [entries](entries.md), or applied to other tags to build traversable relationships.
+
+-   [x] Tag Name **[v8.0.0]**
+-   [x] Tag Shorthand Name **[v8.0.0]**
+-   [x] Tag Aliases List **[v8.0.0]**
+-   [x] Tag Color **[v8.0.0]**
+-   [ ] Tag Description :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.x]**
+-   [x] Tag Colors
+    -   [x] Built-in Color Palette **[v8.0.0]**
+    -   [x] User-Defined Colors **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [x] Primary and Secondary Colors **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+-   [ ] Tag Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Small Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Large Icons for Profiles :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.x]**
+    -   [ ] Built-in Icon Packs (i.e. Boxicons) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] User-Defined Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [x] [Category Property](tags.md#is-category) **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [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
+    -   [ ] Fine-tuned exclusion from categories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Hidden Property :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Built-in "Archived" tag has this property by default :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Checkbox near search bar to show hidden tags in search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Tag Relationships
+    -   [x] [Parent Tags](tags.md#parent-tags) ([Inheritance](<https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)>) Relationship) **[v9.0.0]**
+    -   [ ] [Component Tags](tags.md#component-tags) ([Composition](https://en.wikipedia.org/wiki/Object_composition) Relationship) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Multiple Language Support :material-chevron-up:{ .priority-low title="Low Priority" } **[v9.9.x]**
+-   [ ] Tag Overrides :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Tag Merging :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+
+### :material-magnify: [Search](search.md)
+
+-   [x] Tag Search **[v8.0.0]**
+-   [x] Filename Search **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [x] Glob Search **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+-   [x] Filetype Search **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [x] Search by Extension (e.g. ".jpg", ".png") **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+        -   [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [x] Search by media type (e.g. "image", "video", "document") **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+-   [ ] Field Content Search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [x] [Boolean Operators](search.md) **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+    -   [x] `AND` Operator
+    -   [x] `OR` Operator
+    -   [x] `NOT` Operator
+    -   [x] Parenthesis Grouping
+    -   [x] Character Escaping
+-   [ ] `HAS` Operator (for [Component Tags](tags.md#component-tags)) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+-   [ ] Conditional Search :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.x]**
+    -   [ ] Compare Dates :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Compare Durations :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Compare File Sizes :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+    -   [ ] Compare Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [x] Smartcase Search **[[v9.5.0](changelog.md#950-march-3rd-2025)]**
+-   [ ] Search Result Sorting
+    -   [x] Sort by Filename **[[v9.5.2](changelog.md#952-march-31st-2025)]**
+    -   [x] Sort by Date Entry Added to Library **[[v9.5.2](changelog.md#952-march-31st-2025)]**
+    -   [ ] Sort by File Creation Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Sort by Date Taken (Photos) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]**
+    -   [x] Random/Shuffle Sort
+-   [ ] OCR Search :material-chevron-up:{ .priority-low title="Low Priority" }
+-   [ ] Fuzzy Search :material-chevron-up:{ .priority-low title="Low Priority" }
+
+### :material-file-cog: [Macros](macros.md)
+
+-   [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.x]**
+-   [ ] Versioning System :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.x]**
+-   [ ] Triggers **[v9.5.x]**
+    -   [ ] On File Added :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] On Library Refresh :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] [...]
+-   [ ] Actions **[v9.5.x]**
+    -   [ ] Add Tag(s) :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Add Field(s) :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Set Field Content :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] [...]
+
+### :material-table-arrow-right: Sharable Data
+
+Sharable TagStudio library data in the form of data packs (tags, colors, etc.) or other formats.
+Packs are intended as an easy way to import and export specific data between libraries and users, while export-only formats are intended to be imported by other programs.
+
+-   [ ] Color Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.x]**
+    -   [ ] Importable
+    -   [ ] Exportable
+    -   [x] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [x] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Tag Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.9.x]**
+    -   [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" }
+-   [ ] Macro Sharing :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.x]**
+    -   [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" }
+    -   [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" }
+-   [ ] Sharable Entry Data :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.9.x]**
+    -   _Specifics of this are yet to be determined_
+-   [ ] Export Library to Human Readable Format :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
+    -   Intended to give users more flexible options with their data if they wish to migrate away from TagStudio

docs/search.md

@@ -0,0 +1,125 @@
+---
+icon: material/magnify
+---
+
+# :material-magnify: Searching
+
+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 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](tags.md#name), [shorthands](tags.md#shorthand), [aliases](tags.md#aliases), as well as allows for tags to [substitute](tags.md#intuition-via-substitution) in for any of their [parent tags](tags.md#parent-tags).
+
+You may also see the `tag_id:` prefix keyword show up when 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](fields.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/style.md

@@ -0,0 +1,96 @@
+---
+icon: material/sign-text
+---
+
+# :material-sign-text: Style Guide
+
+## Formatting
+
+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.
+    -   This should include making methods private by default (e.g. `__method()`)
+    -   Methods should only be protected (e.g. `_method()`) or public (e.g. `method()`) when needed and warranted
+-   Keep a maximum column width 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/src/tagstudio/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/)!
+
+## Qt
+
+As of writing this section, the QT part of the code base is quite unstructured and the View and Controller parts are completely intermixed[^1]. This makes maintenance, fixes and general understanding of the code base quite challenging, because the interesting parts you are looking for are entangled in a bunch of repetitive UI setup code. To address this we are aiming to more strictly separate the view and controller aspects of the QT frontend.
+
+The general structure of the QT code base should look like this:
+
+```
+qt
+├── controllers
+│   ├── widgets
+│   │   └── preview_panel_controller.py
+│   └── main_window_controller.py
+├── views
+│   ├── widgets
+│   │   └── preview_panel_view.py
+│   └── main_window_view.py
+├── ts_qt.py
+└── mixed.py
+```
+
+In this structure there are the `views` and `controllers` sub-directories. They have the exact same structure and for every `<component>_view.py` there is a `<component>_controller.py` at the same location in the other subdirectory and vice versa.
+
+Typically the classes should look like this:
+
+```py
+# my_cool_widget_view.py
+class MyCoolWidgetView(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.__button = QPushButton()
+        self.__color_dropdown = QComboBox()
+        # ...
+        self.__connect_callbacks()
+
+    def __connect_callbacks(self):
+        self.__button.clicked.connect(self._button_click_callback)
+        self.__color_dropdown.currentIndexChanged.connect(
+            lambda idx: self._color_dropdown_callback(self.__color_dropdown.itemData(idx))
+        )
+
+    def _button_click_callback(self):
+        raise NotImplementedError()
+```
+
+```py
+# my_cool_widget_controller.py
+class MyCoolWidget(MyCoolWidgetView):
+    def __init__(self):
+        super().__init__()
+
+    def _button_click_callback(self):
+        print("Button was clicked!")
+
+    def _color_dropdown_callback(self, color: Color):
+        print(f"The selected color is now: {color}")
+```
+
+Observe the following key aspects of this example:
+
+-   The Controller is just called `MyCoolWidget` instead of `MyCoolWidgetController` as it will be directly used by other code
+-   The UI elements are in private variables
+    -   This enforces that the controller shouldn't directly access UI elements
+    -   Instead the view should provide a protected API (e.g. `_get_color()`) for things like setting/getting the value of a dropdown, etc.
+    -   Instead of `_get_color()` there could also be a `_color` method marked with `@property`
+-   The callback methods are already defined as protected methods with NotImplementedErrors
+    -   Defines the interface the callbacks
+    -   Enforces that UI events be handled
+
+<!-- prettier-ignore -->
+!!! tip
+    A good (non-exhaustive) rule of thumb is: If it requires a non-UI import, then it doesn't belong in the `*_view.py` file.
+
+[^1]: For an explanation of the Model-View-Controller (MVC) Model, checkout this article: [MVC Framework Introduction](https://www.geeksforgeeks.org/mvc-framework-introduction/).

docs/stylesheets/extra.css

@@ -0,0 +1,194 @@
+/* Dark Theme */
+[data-md-color-scheme="slate"] {
+    --md-default-bg-color: #060617;
+    --md-default-fg-color: #eae1ff;
+    --md-default-fg-color--light: #b898ff;
+    --md-code-fg-color: #eae1ffcc;
+    --md-code-hl-string-color: rgb(92, 255, 228);
+    --md-code-hl-keyword-color: rgb(61, 155, 255);
+    --md-code-hl-constant-color: rgb(205, 78, 255);
+    --md-footer-bg-color--dark: #03030c;
+    --md-code-bg-color: #090a26;
+}
+
+/* Light Theme */
+[data-md-color-scheme="default"] {
+    --md-default-fg-color--light: #090a26;
+}
+
+.md-header {
+    background: linear-gradient(
+        60deg,
+        rgb(205, 78, 255) 10%,
+        rgb(116, 123, 255) 50%,
+        rgb(72, 145, 255) 75%,
+        rgb(98, 242, 255) 100%
+    );
+}
+
+.md-tabs {
+    background: none;
+    font-family: "Bai Jamjuree", Roboto, sans-serif;
+    font-weight: 500;
+    letter-spacing: -0.05rem !important;
+}
+.md-tabs__link {
+    opacity: 1;
+    color: var(--md-default-fg-color--light);
+    padding: 0.1rem;
+}
+.md-tabs__link:hover {
+    color: var(--md-accent-fg-color) !important;
+}
+.md-tabs__item--active {
+    color: var(--md-typeset-a-color) !important;
+
+    border-color: var(--md-typeset-a-color) !important;
+    border-width: 0 0 2px 0 !important;
+    border: solid;
+}
+.md-tabs__item {
+    height: 1.8rem;
+}
+.md-tabs__link {
+    font-size: 0.8rem;
+    margin-top: 0.2rem;
+    margin-bottom: 0.2rem;
+}
+
+/* Mobile Nav Header */
+.md-nav__source {
+    background: linear-gradient(
+        60deg,
+        rgb(205, 78, 255) 0%,
+        rgb(116, 123, 255) 100%
+    );
+    border-style: solid;
+    border-width: 0 0 2px 0;
+    border-color: #ffffff33;
+}
+
+th,
+td {
+    padding: 0.5em 1em 0.5em 1em !important;
+}
+
+.md-typeset ul li ul {
+    margin-top: 0;
+    margin-bottom: 0.1rem;
+}
+
+.md-typeset ul li {
+    margin-bottom: 0.1rem;
+}
+
+.md-header {
+    border-style: solid;
+    border-width: 0 0 2px 0;
+    border-color: #ffffff33;
+}
+
+.md-header__title {
+    font-family: "Bai Jamjuree", Roboto, sans-serif;
+    font-weight: 500 !important;
+    font-size: 1.1rem;
+    letter-spacing: -0.05rem !important;
+}
+
+.md-nav__title,
+h1,
+h2,
+.md-nav__item--section > .md-nav__link {
+    font-family: "Bai Jamjuree", Roboto, sans-serif;
+    font-weight: 500 !important;
+    font-size: 0.8rem;
+    letter-spacing: -0.05rem !important;
+}
+
+/* Add padding to stop text from cutting off early due to negative letter spacing */
+.md-nav__item--section > .md-nav__link > .md-ellipsis {
+    padding-right: 0.5rem;
+}
+.md-header__title .md-header__topic .md-ellipsis {
+    padding-right: 0.5rem;
+}
+
+.md-header__button.md-logo {
+    padding-right: 0;
+    padding-bottom: 0.3rem;
+    margin-right: -0.8rem;
+}
+
+figcaption {
+    margin-top: 0 !important;
+}
+
+.md-search__form {
+    height: 1.5rem;
+    background-color: #00004444;
+    border-radius: 0.3rem !important;
+    border-style: solid;
+    border-width: 2px 1px 0 1px;
+    border-color: #00004422;
+    padding-bottom: 2px;
+}
+.md-search__form > .md-icon {
+    margin-top: -0.2rem;
+}
+
+h1 > .twemoji {
+    margin-top: 0.14rem;
+}
+
+h2 > .twemoji {
+    margin-top: 0.08rem;
+}
+
+/* Matches the palette used by mkdocs-material */
+.priority-high {
+    color: #f1185a;
+}
+
+.priority-med {
+    color: #7c4eff;
+}
+
+.priority-low {
+    color: #28afff;
+}
+
+.red {
+    color: rgb(245, 0, 87);
+}
+
+.amber {
+    color: rgb(255, 145, 0);
+}
+
+.green {
+    color: rgb(0, 191, 165);
+}
+
+.gray {
+    color: rgb(158, 158, 158);
+}
+
+@media screen and (max-width: 76.234375em) {
+    /* Always show image logo on mobile */
+    .md-header__button.md-logo {
+        display: block;
+    }
+
+    label[for="__drawer"].md-header__button.md-icon {
+        order: -1;
+    }
+
+    .md-header {
+        background: linear-gradient(
+            60deg,
+            rgb(205, 78, 255) 10%,
+            rgb(116, 123, 255) 70%,
+            rgb(72, 179, 255) 100%
+        );
+    }
+}

docs/stylesheets/home.css

@@ -0,0 +1,27 @@
+h2 {
+    margin: 1rem 0 0 0 !important;
+}
+
+.md-content .md-typeset h1 {
+    /* display: none; */
+    font-size: 0;
+}
+
+.grid > p {
+    align-content: center;
+    font-size: 1rem !important;
+    line-height: 1.25rem;
+}
+
+.md-content {
+    margin-left: 5.5rem;
+    margin-right: 5.5rem;
+}
+
+/* Keeps four cards in a square on all screens */
+@media screen and (max-width: 64em) {
+    .md-content {
+        margin-left: 0;
+        margin-right: 0;
+    }
+}

docs/tags.md

@@ -0,0 +1,151 @@
+---
+icon: material/tag-text
+---
+
+# :material-tag-text: 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](entries.md) as well!
+
+### 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 Nights 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 Nights 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 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
+
+<!-- prettier-ignore -->
+!!! warning ""
+    **_Coming in version 9.6.x_**
+
+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 `Ogre`, 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" 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](colors.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
+
+<!-- prettier-ignore -->
+!!! warning ""
+    **_Coming in version 9.6.x_**
+
+## Tag Properties
+
+Properties are special attributes of tags that change their behavior in some way.
+
+#### Is Category
+
+The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized 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.
+
+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 of multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
+
+![Tag Category 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.
+
+#### Is Hidden
+
+<!-- prettier-ignore -->
+!!! warning ""
+    **_Coming in version 9.6.x_**
+
+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/usage.md

@@ -0,0 +1,79 @@
+---
+icon: material/mouse
+---
+
+# :material-mouse: Basic 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 the currently selected file entries. To quickly add the top result, press the <kbd>Enter</kbd>/<kbd>Return</kbd> key to add 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 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 by 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.
+
+## Launch Arguments
+
+There are a handful of launch arguments you can pass to TagStudio via the command line or a desktop shortcut.
+
+| Argument                 | Short | Description                                            |
+| ------------------------ | ----- | ------------------------------------------------------ |
+| `--cache-file <path>`    | `-c`  | Path to a TagStudio .ini or .plist cache file to use.  |
+| `--open <path>`          | `-o`  | Path to a TagStudio Library folder to open on start.   |
+| `--settings-file <path>` | `-s`  | Path to a TagStudio .toml global settings file to use. |
+| `--version`              | `-v`  | Displays TagStudio version information.                |

flake.lock

@@ -1,132 +1,5 @@
 {
   "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": [
@@ -134,11 +7,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1725024810,
-        "narHash": "sha256-ODYRm8zHfLTH3soTFWE452ydPYz2iTvr9T8ftDMUQ3E=",
+        "lastModified": 1756770412,
+        "narHash": "sha256-+uWLQZccFHwqpGqr2Yt5VsW/PbeJVTn9Dk6SHWhNRPw=",
         "owner": "hercules-ci",
         "repo": "flake-parts",
-        "rev": "af510d4a62d071ea13925ce41c95e3dec816c01d",
+        "rev": "4524271976b625a4a605beefd893f270620fd751",
         "type": "github"
       },
       "original": {
@@ -147,354 +20,27 @@
         "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=",
+        "lastModified": 1757487488,
+        "narHash": "sha256-zwE/e7CuPJUWKdvvTCB7iunV4E/+G0lKfv4kk/5Izdg=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "9201b5ff357e781bf014d0330d18555695df7ba8",
+        "rev": "ab0f3607a6c7486ea22229b92ed2d355f1482ee0",
         "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"
+        "nixpkgs": "nixpkgs",
+        "systems": "systems"
       }
     },
     "systems": {
@@ -511,51 +57,6 @@
         "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",

flake.nix

@@ -2,207 +2,72 @@
   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";
 
-    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";
+    systems.url = "github:nix-systems/default";
   };
 
   outputs =
-    {
+    inputs@{
       flake-parts,
       nixpkgs,
-      nixpkgs-qt6,
       self,
-      systems,
       ...
-    }@inputs:
+    }:
+    let
+      inherit (nixpkgs) lib;
+    in
     flake-parts.lib.mkFlake { inherit inputs; } {
-      imports = [ inputs.devenv.flakeModule ];
-
-      systems = import systems;
+      systems = import inputs.systems;
 
       perSystem =
-        {
-          config,
-          pkgs,
-          system,
-          ...
-        }:
+        { pkgs, ... }:
         let
-          inherit (nixpkgs) lib;
-
-          qt6Pkgs = import nixpkgs-qt6 { inherit system; };
+          python3 = pkgs.python312;
         in
         {
-          formatter = pkgs.nixfmt-rfc-style;
+          packages =
+            let
+              python3Packages = python3.pkgs;
 
-          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
-                    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.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; [ ];
-                };
+              pillow-jxl-plugin = python3Packages.callPackage ./nix/package/pillow-jxl-plugin.nix {
+                inherit (pkgs) cmake;
+                inherit pyexiv2;
               };
+              pyexiv2 = python3Packages.callPackage ./nix/package/pyexiv2.nix { inherit (pkgs) exiv2; };
+            in
+            rec {
+              default = tagstudio;
+              tagstudio = pkgs.callPackage ./nix/package {
+                inherit python3Packages;
+
+                inherit pillow-jxl-plugin;
+              };
+              tagstudio-jxl = tagstudio.override { withJXLSupport = true; };
+
+              inherit pillow-jxl-plugin pyexiv2;
+            };
+
+          devShells = rec {
+            default = tagstudio;
+            tagstudio = import ./nix/shell.nix {
+              inherit
+                inputs
+                lib
+                pkgs
+                self
+
+                python3
+                ;
+            };
           };
+
+          formatter = pkgs.nixfmt-rfc-style;
         };
     };
 }

mkdocs.yml

@@ -0,0 +1,171 @@
+# 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
+
+nav:
+  - Home:
+      - index.md
+  - Getting Started:
+      - install.md
+      - usage.md
+      - Developing:
+        - developing.md
+        - contributing.md
+        - style.md
+      - Help:
+          - help/ffmpeg.md
+  - Using Libraries:
+      - libraries.md
+      - entries.md
+      - preview-support.md
+      - search.md
+      - ignore.md
+      - macros.md
+      - Fields:
+        - fields.md
+      - Tags:
+          - tags.md
+          - colors.md
+  - Updates:
+      - changelog.md
+      - roadmap.md
+      - Schema History:
+        - library-changes.md
+
+theme:
+  name: material
+  custom_dir: overrides
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/lightbulb-auto-outline
+        name: Switch to Light Mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: purple
+      accent: purple
+      toggle:
+        icon: material/lightbulb
+        name: Switch to Dark Mode
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: purple
+      accent: purple
+      toggle:
+        icon: material/lightbulb-night-outline
+        name: Switch to System Preference
+  logo: assets/icon_mono.svg
+  favicon: assets/icon.ico
+  font:
+    code: Jetbrains Mono
+  language: en
+  features:
+    - content.action.edit
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - navigation.indexes
+    - navigation.instant
+    - navigation.sections
+    - navigation.tabs
+    # - navigation.tabs.sticky
+    - navigation.tracking
+    - search.suggest
+  icon:
+    repo: fontawesome/brands/github
+    tag:
+      upcoming: material/flask-outline
+
+markdown_extensions:
+
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - tables
+  - toc:
+      permalink: true
+      toc_depth: 3
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets
+  - 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)
+  - redirects:
+      redirect_maps:
+        "develop.md": "developing.md"
+        "library/entry.md": "entries.md"
+        "library/field.md": "fields.md"
+        "library/index.md": "libraries.md"
+        "library/library_search.md": "search.md"
+        "library/tag_categories.md": "tags.md"
+        "library/tag_color.md": "colors.md"
+        "library/tag.md": "tags.md"
+        "updates/changelog.md": "changelog.md"
+        "updates/roadmap.md": "roadmap.md"
+        "updates/schema_changes.md": "library-changes.md"
+        "utilities/ignore.md": "ignore.md"
+        "utilities/macro.md": "macros.md"
+
+extra_css:
+  - stylesheets/extra.css
+  - https://fonts.googleapis.com/css2?family=Bai+Jamjuree:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;1,200;1,300;1,400;1,500;1,600;1,700&display=swap

nix/package/default.nix

@@ -0,0 +1,147 @@
+{
+  ffmpeg-headless,
+  lib,
+  pipewire,
+  python3Packages,
+  qt6,
+  ripgrep,
+  stdenv,
+  wrapGAppsHook,
+
+  pillow-jxl-plugin,
+
+  withJXLSupport ? false,
+}:
+
+let
+  pyproject = (lib.importTOML ../../pyproject.toml).project;
+in
+python3Packages.buildPythonApplication {
+  pname = pyproject.name;
+  inherit (pyproject) version;
+  pyproject = true;
+
+  src = ../../.;
+
+  nativeBuildInputs = [
+    python3Packages.pythonRelaxDepsHook
+    qt6.wrapQtAppsHook
+
+    # Should be unnecessary once PR is pulled.
+    # PR: https://github.com/NixOS/nixpkgs/pull/271037
+    # Issue: https://github.com/NixOS/nixpkgs/issues/149812
+    wrapGAppsHook
+  ];
+  buildInputs = [
+    qt6.qtbase
+    qt6.qtmultimedia
+  ];
+
+  nativeCheckInputs = with python3Packages; [
+    pytest-qt
+    pytest-xdist
+    pytestCheckHook
+    syrupy
+  ];
+
+  # TODO: Install more icon resolutions when available.
+  preInstall = ''
+    mkdir -p $out/share/applications $out/share/icons/hicolor/512x512/apps
+
+    cp $src/src/tagstudio/resources/tagstudio.desktop $out/share/applications
+    cp $src/src/tagstudio/resources/icon.png $out/share/icons/hicolor/512x512/apps/tagstudio.png
+  '';
+
+  dontWrapGApps = true;
+  dontWrapQtApps = true;
+  makeWrapperArgs = [
+    "--suffix PATH : ${
+      lib.makeBinPath [
+        ffmpeg-headless
+        ripgrep
+      ]
+    }"
+  ]
+  ++ lib.optional stdenv.hostPlatform.isLinux "--suffix LD_LIBRARY_PATH : ${
+    lib.makeLibraryPath [ pipewire ]
+  }"
+  ++ [
+    "\${gappsWrapperArgs[@]}"
+    "\${qtWrapperArgs[@]}"
+  ];
+
+  pythonRemoveDeps = lib.optional (!withJXLSupport) [ "pillow_jxl" ];
+  pythonRelaxDeps = [
+    "numpy"
+    "pillow"
+    "pillow-avif-plugin"
+    "pillow-heif"
+    "pillow-jxl-plugin"
+    "py7zr"
+    "pyside6"
+    "rarfile"
+    "structlog"
+    "typing-extensions"
+  ];
+  pythonImportsCheck = [ "tagstudio" ];
+
+  build-system = with python3Packages; [ hatchling ];
+  dependencies =
+    with python3Packages;
+    [
+      chardet
+      ffmpeg-python
+      humanfriendly
+      mutagen
+      numpy
+      opencv-python
+      pillow
+      pillow-avif-plugin
+      pillow-heif
+      py7zr
+      pydantic
+      pydub
+      pyside6
+      rarfile
+      rawpy
+      send2trash
+      sqlalchemy
+      srctools
+      structlog
+      toml
+      ujson
+      wcmatch
+    ]
+    ++ lib.optional withJXLSupport pillow-jxl-plugin;
+
+  # These tests require modifications to a library, which does not work
+  # in a read-only environment.
+  disabledTests = [
+    "test_badge_visual_state"
+    "test_browsing_state_update"
+    "test_close_library" # TODO: Look into segfault.
+    "test_flow_layout_happy_path"
+    "test_get" # TODO: Look further into, might be possible to run.
+    "test_json_migration"
+    "test_library_migrations"
+    "test_update_tags"
+  ];
+  disabledTestPaths = [
+    "tests/qt/test_build_tag_panel.py"
+    "tests/qt/test_field_containers.py"
+    "tests/qt/test_file_path_options.py"
+    "tests/qt/test_preview_panel.py"
+    "tests/qt/test_tag_panel.py"
+    "tests/qt/test_tag_search_panel.py"
+    "tests/test_library.py"
+  ];
+
+  meta = {
+    inherit (pyproject) description;
+    homepage = "https://docs.tagstud.io/";
+    license = lib.licenses.gpl3Only;
+    maintainers = with lib.maintainers; [ xarvex ];
+    mainProgram = "tagstudio";
+    platforms = lib.platforms.unix;
+  };
+}

nix/package/pillow-jxl-plugin.nix

@@ -0,0 +1,68 @@
+{
+  buildPythonPackage,
+  cmake,
+  fetchPypi,
+  lib,
+  numpy,
+  packaging,
+  pillow,
+  pyexiv2,
+  pytestCheckHook,
+  rustPlatform,
+}:
+
+buildPythonPackage rec {
+  pname = "pillow-jxl-plugin";
+  version = "1.3.4";
+  pyproject = true;
+
+  src = fetchPypi {
+    pname = "pillow_jxl_plugin";
+    inherit version;
+    hash = "sha256-jqWJ/FWep8XfzLQq9NgUj121CPX01FGDKLq1ox/LJo4=";
+  };
+
+  cargoDeps = rustPlatform.fetchCargoVendor {
+    inherit src;
+    hash = "sha256-7j+sCn+P6q6tsm2MJ/cM7hF2KEjILJNA6SDb35tecPg=";
+  };
+
+  nativeBuildInputs = [
+    cmake
+    rustPlatform.cargoSetupHook
+    rustPlatform.maturinBuildHook
+  ];
+
+  nativeCheckInputs = [
+    numpy
+    pyexiv2
+    pytestCheckHook
+  ];
+
+  # Working directory takes precedence in the Python path. Remove
+  # `pillow_jxl` to prevent it from being loaded during pytest, rather than the
+  # built module, as it includes a `pillow_jxl.pillow_jxl.so` that is imported.
+  # See: https://github.com/NixOS/nixpkgs/issues/255262
+  # See: https://github.com/NixOS/nixpkgs/pull/255471
+  preCheck = ''
+    rm -r pillow_jxl
+  '';
+
+  dontUseCmakeConfigure = true;
+
+  pythonImportsCheck = [ "pillow_jxl" ];
+
+  dependencies = [
+    packaging
+    pillow
+  ];
+
+  meta = {
+    description = "Pillow plugin for JPEG-XL, using Rust for bindings";
+    homepage = "https://github.com/Isotr0py/pillow-jpegxl-plugin";
+    changelog = "https://github.com/Isotr0py/pillow-jpegxl-plugin/releases/tag/v${version}";
+    license = lib.licenses.gpl3;
+    maintainers = with lib.maintainers; [ xarvex ];
+    platforms = lib.platforms.unix;
+  };
+}

nix/package/pyexiv2.nix

@@ -0,0 +1,37 @@
+{
+  autoPatchelfHook,
+  buildPythonPackage,
+  exiv2,
+  fetchFromGitHub,
+  lib,
+  setuptools,
+}:
+
+buildPythonPackage rec {
+  pname = "pyexiv2";
+  version = "2.15.3";
+  pyproject = true;
+
+  src = fetchFromGitHub {
+    owner = "LeoHsiao1";
+    repo = "pyexiv2";
+    tag = "v${version}";
+    hash = "sha256-83bFMaoXncvhRJNcCgkkC7B29wR5pjuLO/EdkQdqxxo=";
+  };
+
+  nativeBuildInputs = [ autoPatchelfHook ];
+  buildInputs = [ exiv2.lib ];
+
+  pythonImportsCheck = [ "pyexiv2" ];
+
+  build-system = [ setuptools ];
+
+  meta = {
+    description = "Read and write image metadata, including EXIF, IPTC, XMP, ICC Profile";
+    homepage = "https://github.com/LeoHsiao1/pyexiv2";
+    changelog = "https://github.com/LeoHsiao1/pyexiv2/releases/tag/v${version}";
+    license = lib.licenses.gpl3;
+    maintainers = with lib.maintainers; [ xarvex ];
+    platforms = with lib.platforms; darwin ++ linux ++ windows;
+  };
+}

nix/shell.nix

@@ -0,0 +1,129 @@
+{
+  lib,
+  pkgs,
+
+  python3,
+  ...
+}:
+
+let
+  pythonLibraryPath =
+    with pkgs;
+    lib.makeLibraryPath (
+      [
+        fontconfig
+        freetype
+        glib
+        qt6.qtbase
+        stdenv.cc.cc
+        zstd
+      ]
+      ++ lib.optionals (!stdenv.isDarwin) [
+        dbus
+        libGL
+        libdrm
+        libpulseaudio
+        libva
+        libxkbcommon
+        pipewire
+        qt6.qtwayland
+        xorg.libX11
+        xorg.libXrandr
+      ]
+    );
+
+  libraryPath = "${lib.optionalString pkgs.stdenv.isDarwin "DY"}LD_LIBRARY_PATH";
+
+  python3Wrapped = pkgs.symlinkJoin {
+    inherit (python3)
+      name
+      pname
+      version
+      meta
+      ;
+
+    paths = [ python3 ];
+
+    nativeBuildInputs = with pkgs; [
+      makeWrapper
+      qt6.wrapQtAppsHook
+
+      # Should be unnecessary once PR is pulled.
+      # PR: https://github.com/NixOS/nixpkgs/pull/271037
+      # Issue: https://github.com/NixOS/nixpkgs/issues/149812
+      wrapGAppsHook
+    ];
+    buildInputs = with pkgs.qt6; [
+      qtbase
+      qtmultimedia
+    ];
+
+    postBuild = ''
+      wrapProgram $out/bin/${python3.meta.mainProgram} \
+        --suffix ${libraryPath} : ${pythonLibraryPath} \
+        "''${gappsWrapperArgs[@]}" \
+        "''${qtWrapperArgs[@]}"
+    '';
+
+    dontWrapGApps = true;
+    dontWrapQtApps = true;
+  };
+in
+pkgs.mkShellNoCC {
+  nativeBuildInputs = with pkgs; [
+    coreutils
+    uv
+
+    ruff
+  ];
+  buildInputs = [
+    python3Wrapped
+  ]
+  ++ (with pkgs; [
+    ffmpeg-headless
+    ripgrep
+  ]);
+
+  env = {
+    QT_QPA_PLATFORM = "wayland;xcb";
+
+    UV_NO_SYNC = "1";
+    UV_PYTHON_DOWNLOADS = "never";
+  };
+
+  shellHook =
+    let
+      python = lib.getExe python3Wrapped;
+
+      # PySide/Qt are very particular about matching versions. Override with nixpkgs package.
+      pythonPath = lib.makeSearchPathOutput "lib" python3.sitePackages (
+        with python3.pkgs; [ pyside6 ] ++ pyside6.propagatedBuildInputs or [ ]
+      );
+    in
+    # bash
+    ''
+      venv=''${UV_PROJECT_ENVIRONMENT:-.venv}
+
+      if [ ! -f "''${venv}"/bin/activate ] || [ "$(readlink -f "''${venv}"/bin/python)" != "$(readlink -f ${python})" ]; then
+          printf '%s\n' 'Regenerating virtual environment, Python interpreter changed...' >&2
+          rm -rf "''${venv}"
+          uv venv --python ${python} "''${venv}"
+      fi
+
+      source "''${venv}"/bin/activate
+      PYTHONPATH=${pythonPath}''${PYTHONPATH:+:}''${PYTHONPATH:-}
+
+      if [ ! -f "''${venv}"/pyproject.toml ] || ! diff --brief pyproject.toml "''${venv}"/pyproject.toml >/dev/null; then
+          printf '%s\n' 'Installing dependencies, pyproject.toml changed...' >&2
+          uv pip install --quiet --editable '.[mkdocs,mypy,pre-commit,pytest]'
+          cp pyproject.toml "''${venv}"/pyproject.toml
+      fi
+
+      pre-commit install
+    '';
+
+  meta = {
+    maintainers = with lib.maintainers; [ xarvex ];
+    platforms = lib.platforms.unix;
+  };
+}

overrides/partials/header.html

@@ -0,0 +1,122 @@
+<!--
+  Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!-- Determine classes -->
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+  {% set class = class ~ " md-header--shadow md-header--lifted" %}
+{% elif "navigation.tabs" not in features %}
+  {% set class = class ~ " md-header--shadow" %}
+{% endif %}
+
+<!-- Header -->
+<header class="{{ class }}" data-md-component="header">
+  <nav
+    class="md-header__inner md-grid"
+    aria-label="{{ lang.t('header') }}"
+  >
+
+    <!-- Link to home -->
+    <a
+      href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
+      title="{{ config.site_name | e }}"
+      class="md-header__button md-logo"
+      aria-label="{{ config.site_name }}"
+      data-md-component="logo"
+    >
+      {% include "partials/logo.html" %}
+    </a>
+
+    <!-- Button to open drawer -->
+    <label class="md-header__button md-icon" for="__drawer">
+      {% set icon = config.theme.icon.menu or "material/menu" %}
+      {% include ".icons/" ~ icon ~ ".svg" %}
+    </label>
+
+    <!-- Header title -->
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            <a style="font-weight: 900;">Tag</a><a style="font-weight: 500;"><i>Studio</i></a>
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            {% if page.meta and page.meta.title %}
+              {{ page.meta.title }}
+            {% else %}
+              {{ page.title }}
+            {% endif %}
+          </span>
+        </div>
+      </div>
+    </div>
+
+    <!-- Color palette toggle -->
+    {% if config.theme.palette %}
+      {% if not config.theme.palette is mapping %}
+        {% include "partials/palette.html" %}
+      {% endif %}
+    {% endif %}
+
+    <!-- User preference: color palette -->
+    {% if not config.theme.palette is mapping %}
+      {% include "partials/javascripts/palette.html" %}
+    {% endif %}
+
+    <!-- Site language selector -->
+    {% if config.extra.alternate %}
+      {% include "partials/alternate.html" %}
+    {% endif %}
+
+    <!-- Button to open search modal -->
+    {% if "material/search" in config.plugins %}
+      {% set search = config.plugins["material/search"] | attr("config") %}
+
+      <!-- Check if search is actually enabled - see https://t.ly/DT_0V -->
+      {% if search.enabled %}
+        <label class="md-header__button md-icon" for="__search">
+          {% set icon = config.theme.icon.search or "material/magnify" %}
+          {% include ".icons/" ~ icon ~ ".svg" %}
+        </label>
+
+        <!-- Search interface -->
+        {% include "partials/search.html" %}
+      {% endif %}
+    {% endif %}
+
+    <!-- Repository information -->
+    {% if config.repo_url %}
+      <div class="md-header__source">
+        {% include "partials/source.html" %}
+      </div>
+    {% endif %}
+  </nav>
+
+  <!-- Navigation tabs (sticky) -->
+  {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+      {% include "partials/tabs.html" %}
+    {% endif %}
+  {% endif %}
+</header>

overrides/partials/nav.html

@@ -0,0 +1,69 @@
+<!--
+  Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+{% import "partials/nav-item.html" as item with context %}
+
+<!-- Determine classes -->
+{% set class = "md-nav md-nav--primary" %}
+{% if "navigation.tabs" in features %}
+  {% set class = class ~ " md-nav--lifted" %}
+{% endif %}
+{% if "toc.integrate" in features %}
+  {% set class = class ~ " md-nav--integrated" %}
+{% endif %}
+
+<!-- Navigation -->
+<nav
+  class="{{ class }}"
+  aria-label="{{ lang.t('nav') }}"
+  data-md-level="0"
+>
+
+  <!-- Site title -->
+  <!-- <label class="md-nav__title" for="__drawer">
+    <a
+      href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
+      title="{{ config.site_name | e }}"
+      class="md-nav__button md-logo"
+      aria-label="{{ config.site_name }}"
+      data-md-component="logo"
+    >
+      {% include "partials/logo.html" %}
+    </a>
+    {{ config.site_name }}
+  </label> -->
+
+  <!-- Repository information -->
+  {% if config.repo_url %}
+    <div class="md-nav__source">
+      {% include "partials/source.html" %}
+    </div>
+  {% endif %}
+
+  <!-- Navigation list -->
+  <ul class="md-nav__list" data-md-scrollfix>
+    {% for nav_item in nav %}
+      {% set path = "__nav_" ~ loop.index %}
+      {{ item.render(nav_item, path, 1) }}
+    {% endfor %}
+  </ul>
+</nav>

overrides/partials/toc-item.html

@@ -0,0 +1,43 @@
+<!--
+  Copyright (c) 2016-2025 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!-- Table of contents item -->
+<li class="md-nav__item">
+    <a href="{{ toc_item.url }}" class="md-nav__link">
+      <span class="md-ellipsis">
+        {{ toc_item.title }}
+      </span>
+    </a>
+
+    <!-- Table of contents list -->
+    {% if toc_item.children %}
+      <nav class="md-nav" aria-label="{{ toc_item.title | striptags | e }}">
+        <ul class="md-nav__list">
+          {% for toc_item in toc_item.children %}
+          {% if not page.meta.toc_depth or toc_item.level <= page.meta.toc_depth %}
+            {% include "partials/toc-item.html" %}
+          {% endif %}
+          {% endfor %}
+        </ul>
+      </nav>
+    {% endif %}
+  </li>

pyproject.toml

@@ -1,9 +1,121 @@
-[tool.ruff]
-exclude = ["main_window.py", "home_ui.py", "resources.py", "resources_rc.py"]
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "TagStudio"
+description = "A User-Focused Photo & File Management System."
+version = "9.5.5"
+license = "GPL-3.0-only"
+readme = "README.md"
+requires-python = ">=3.12,<3.13"
+dependencies = [
+    "chardet~=5.2",
+    "ffmpeg-python~=0.2",
+    "humanfriendly==10.*",
+    "mutagen~=1.47",
+    "numpy~=2.2",
+    "opencv_python~=4.11",
+    "Pillow>=10.2,<=11",
+    "pillow-avif-plugin~=1.5",
+    "pillow-heif~=0.22",
+    "pillow-jxl-plugin~=1.3",
+    "py7zr==1.0.0",
+    "pydantic~=2.10",
+    "pydub~=0.25",
+    "PySide6==6.8.0.*",
+    "rarfile==4.2",
+    "rawpy~=0.24",
+    "Send2Trash~=1.8",
+    "SQLAlchemy~=2.0",
+    "srctools~=2.6",
+    "structlog~=25.3",
+    "toml~=0.10",
+    "typing_extensions~=4.13",
+    "ujson~=5.10",
+    "wcmatch==10.*",
+]
+
+[project.optional-dependencies]
+dev = ["tagstudio[mkdocs,mypy,pre-commit,pyinstaller,pytest,ruff]"]
+mkdocs = ["mkdocs-material[imaging]>=9.6.14", "mkdocs-redirects~=1.2"]
+mypy = ["mypy==1.15.0", "mypy-extensions==1.*", "types-ujson~=5.10"]
+pre-commit = ["pre-commit~=4.2"]
+pyinstaller = ["Pyinstaller~=6.13"]
+pytest = [
+    "pytest==8.3.5",
+    "pytest-cov==6.1.1",
+    "pytest-qt==4.4.0",
+    "syrupy==4.9.1",
+]
+ruff = ["ruff==0.11.8"]
+
+[project.gui-scripts]
+tagstudio = "tagstudio.main:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/tagstudio"]
 
 [tool.mypy]
-strict_optional = false
-disable_error_code = ["union-attr", "annotation-unchecked", "import-untyped"]
+mypy_path = ["src/tagstudio"]
+disable_error_code = [
+    "annotation-unchecked",
+    "func-returns-value",
+    "import-untyped",
+]
 explicit_package_bases = true
+ignore_missing_imports = true
+implicit_optional = true
+strict_optional = false
 warn_unused_ignores = true
-exclude = ['tests']
+exclude = ["build", "dist"]
+
+[[tool.mypy.overrides]]
+module = "tagstudio.qt.main_window"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "tagstudio.qt.ui.home_ui"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "tagstudio.core.ts_core"
+ignore_errors = true
+
+[tool.pytest.ini_options]
+#addopts = "-m 'not qt'"
+qt_api = "pyside6"
+
+[tool.pyright]
+ignore = [
+    ".venv/**",
+    "src/tagstudio/core/library/json/",
+    "src/tagstudio/qt/previews/vendored/pydub/",
+]
+include = ["src/tagstudio", "tests"]
+reportAny = false
+reportIgnoreCommentWithoutRule = false
+reportImplicitStringConcatenation = false
+reportMissingTypeArgument = false
+reportMissingTypeStubs = false
+# reportOptionalMemberAccess = false
+reportUnannotatedClassAttribute = false
+reportUnknownArgumentType = false
+reportUnknownLambdaType = false
+reportUnknownMemberType = false
+reportUnusedCallResult = false
+
+[tool.ruff]
+exclude = ["home_ui.py", "resources.py", "resources_rc.py"]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["B", "D", "E", "F", "FBT003", "I", "N", "SIM", "T20", "UP"]
+ignore = ["D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D", "E402"]
+"src/tagstudio/qt/previews/vendored/**" = ["B", "E", "N", "UP", "SIM115"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

requirements-dev.txt

@@ -1,6 +0,0 @@
-ruff==0.4.2
-pre-commit==3.7.0
-pytest==8.2.0
-Pyinstaller==6.6.0
-mypy==1.10.0
-syrupy==4.6.1

requirements.txt

@@ -1,12 +0,0 @@
-humanfriendly==10.0
-opencv_python>=4.8.0.74,<=4.9.0.80
-Pillow==10.3.0
-PySide6==6.7.1
-PySide6_Addons==6.7.1
-PySide6_Essentials==6.7.1
-typing_extensions>=3.10.0.0,<=4.11.0
-ujson>=5.8.0,<=5.9.0
-numpy==1.26.4
-rawpy==0.21.0
-pillow-heif==0.16.0
-chardet==5.2.0

src/tagstudio/core/constants.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2025
+# Licensed under the GPL-3.0 License.
+# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
+
+VERSION: str = "9.5.5"  # Major.Minor.Patch
+VERSION_BRANCH: str = ""  # Usually "" or "Pre-Release"
+
+# The folder & file names where TagStudio keeps its data relative to a library.
+TS_FOLDER_NAME: str = ".TagStudio"
+BACKUP_FOLDER_NAME: str = "backups"
+COLLAGE_FOLDER_NAME: str = "collages"
+IGNORE_NAME: str = ".ts_ignore"
+THUMB_CACHE_NAME: str = "thumbs"
+
+FONT_SAMPLE_TEXT: str = (
+    """ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!?@$%(){}[]"""
+)
+FONT_SAMPLE_SIZES: list[int] = [10, 15, 20]
+
+# NOTE: These were the field IDs used for the "Tags", "Content Tags", and "Meta Tags" fields inside
+# the legacy JSON database. These are used to help migrate libraries from JSON to SQLite.
+LEGACY_TAG_FIELD_IDS: set[int] = {6, 7, 8}
+
+TAG_ARCHIVED = 0
+TAG_FAVORITE = 1
+TAG_META = 2
+RESERVED_TAG_START = 0
+RESERVED_TAG_END = 999
+
+RESERVED_NAMESPACE_PREFIX = "tagstudio"

src/tagstudio/core/driver.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+import structlog
+from PySide6.QtCore import QSettings
+
+from tagstudio.core.constants import TS_FOLDER_NAME
+from tagstudio.core.enums import SettingItems
+from tagstudio.core.library.alchemy.library import LibraryStatus
+from tagstudio.qt.global_settings import GlobalSettings
+
+logger = structlog.get_logger(__name__)
+
+
+class DriverMixin:
+    cached_values: QSettings
+    # TODO: GlobalSettings has become closely tied to Qt.
+    # Should there be a base Settings class?
+    settings: GlobalSettings
+
+    def evaluate_path(self, open_path: str | None) -> LibraryStatus:
+        """Check if the path of library is valid."""
+        library_path: Path | None = None
+        if open_path:
+            library_path = Path(open_path).expanduser()
+            if not library_path.exists():
+                logger.error("Path does not exist.", open_path=open_path)
+                return LibraryStatus(success=False, message="Path does not exist.")
+        elif self.settings.open_last_loaded_on_startup and self.cached_values.value(
+            SettingItems.LAST_LIBRARY
+        ):
+            library_path = Path(str(self.cached_values.value(SettingItems.LAST_LIBRARY)))
+            if not (library_path / TS_FOLDER_NAME).exists():
+                logger.error(
+                    "TagStudio folder does not exist.",
+                    library_path=library_path,
+                    ts_folder=TS_FOLDER_NAME,
+                )
+                self.cached_values.setValue(SettingItems.LAST_LIBRARY, "")
+                # dont consider this a fatal error, just skip opening the library
+                library_path = None
+
+        return LibraryStatus(
+            success=True,
+            library_path=library_path,
+        )

src/tagstudio/core/enums.py

@@ -0,0 +1,86 @@
+# Copyright (C) 2025
+# Licensed under the GPL-3.0 License.
+# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
+
+import enum
+from typing import Any
+from uuid import uuid4
+
+
+class SettingItems(str, enum.Enum):
+    """List of setting item names."""
+
+    LAST_LIBRARY = "last_library"
+    LIBS_LIST = "libs_list"
+
+
+class ShowFilepathOption(int, enum.Enum):
+    """Values representing the options for the "show_filenames" setting."""
+
+    SHOW_FULL_PATHS = 0
+    SHOW_RELATIVE_PATHS = 1
+    SHOW_FILENAMES_ONLY = 2
+    DEFAULT = SHOW_RELATIVE_PATHS
+
+
+class TagClickActionOption(int, enum.Enum):
+    """Values representing the options for the "tag_click_action" setting."""
+
+    OPEN_EDIT = 0
+    SET_SEARCH = 1
+    ADD_TO_SEARCH = 2
+    DEFAULT = OPEN_EDIT
+
+
+class Theme(str, enum.Enum):
+    COLOR_BG_DARK = "#65000000"
+    COLOR_BG_LIGHT = "#22000000"
+    COLOR_DARK_LABEL = "#DD000000"
+    COLOR_BG = "#65000000"
+
+    COLOR_HOVER = "#65444444"
+    COLOR_PRESSED = "#65777777"
+    COLOR_DISABLED_BG = "#30000000"
+    COLOR_FORBIDDEN = "#65F39CAA"
+    COLOR_FORBIDDEN_BG = "#65440D12"
+
+
+class OpenStatus(enum.IntEnum):
+    NOT_FOUND = 0
+    SUCCESS = 1
+    CORRUPTED = 2
+
+
+class MacroID(enum.Enum):
+    AUTOFILL = "autofill"
+    SIDECAR = "sidecar"
+    BUILD_URL = "build_url"
+    MATCH = "match"
+    CLEAN_URL = "clean_url"
+
+
+class DefaultEnum(enum.Enum):
+    """Allow saving multiple identical values in property called .default."""
+
+    default: Any
+
+    def __new__(cls, value):
+        # Create the enum instance
+        obj = object.__new__(cls)
+        # make value random
+        obj._value_ = uuid4()
+        # assign the actual value into .default property
+        obj.default = value
+        return obj
+
+    @property
+    def value(self):
+        raise AttributeError("access the value via .default property instead")
+
+
+# TODO: Remove DefaultEnum and LibraryPrefs classes once remaining values are removed.
+class LibraryPrefs(DefaultEnum):
+    """Library preferences with default value accessible via .default property."""
+
+    IS_EXCLUDE_LIST = True
+    EXTENSION_LIST = [".json", ".xmp", ".aae"]

src/tagstudio/core/exceptions.py

@@ -0,0 +1,6 @@
+# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
+# Licensed under the GPL-3.0 License.
+# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
+
+
+class NoRendererError(Exception): ...