Merge branch 'dev' into pre-commit-ci-update-config

Author: Avasam

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
       - id: pretty-format-ini
         args: [--autofix]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.2 # Must match requirements-dev.txt
+    rev: v0.8.0 # Must match requirements-dev.txt
     hooks:
       - id: ruff
         args: [--fix]

README.md

@@ -11,7 +11,9 @@ Easy to use image comparison based auto splitter for speedrunning on console or
 
 This program can be used to automatically start, split, and reset your preferred speedrun timer by comparing images to a capture region. This allows you to focus more on your speedrun and less on managing your timer. It also improves the accuracy of your splits. It can be used in tandem with any speedrun timer that accepts hotkeys (LiveSplit, WSplit, etc.), and can be integrated with LiveSplit.
 
-![Example](/docs/2.0.0_gif.gif)
+<p align="center">
+  <img src="/docs/2.2.2.gif" alt="Example" />
+</p>
 
 ## Tutorial
 

docs/2.0.0_gif.gif

@@ -12,7 +12,7 @@ enableTypeIgnoreComments = false
 reportMissingTypeStubs = "warning"
 # Extra runtime safety
 reportUnnecessaryComparison = "warning"
-# Using Flake8/Ruff instead. Name is already grayed out and red squiggle looks like a mistyped import
+# Using Ruff instead. Name is already grayed out and red squiggle looks like a mistyped import
 reportUnusedImport = "none"
 
 ###

docs/2.2.2.gif

@@ -38,12 +38,10 @@ ignore = [
   "SIM105", # flake8-simplify: use-contextlib-suppress
   # Negative performance impact and more verbose https://github.com/astral-sh/ruff/issues/7871
   "UP038", # non-pep604-isinstance
-  # deprecated and is actually slower for cases relevant to unpacking: https://github.com/astral-sh/ruff/issues/12754
-  "UP027", # unpacked-list-comprehension
   # Checked by type-checker (pyright/mypy)
   "ANN", # flake-annotations
   "PGH003", # blanket-type-ignore
-  "TCH", # flake8-type-checking
+  "TC", # flake8-type-checking
   # Already shown by Pylance, checked by pyright, and can be caused by overloads.
   "ARG002", # Unused method argument
   # We want D213: multi-line-summary-second-line and D211: no-blank-line-before-class
@@ -60,7 +58,7 @@ ignore = [
   "TD003", # flake8-todos: missing-todo-link
 
   # False-positives
-  "TCH004", # https://github.com/astral-sh/ruff/issues/3821
+  "TC004", # https://github.com/astral-sh/ruff/issues/3821
 
   ###
   # Conflict with formatter (you can remove this section if you don't use Ruff as a formatter)
@@ -131,7 +129,6 @@ max-branches = 15
   "F811", # Re-exports false positives
   # The following can't be controlled for external libraries:
   "A", # Shadowing builtin names
-  "E741", # ambiguous variable name
   "F403", # `from . import *` used; unable to detect undefined names
   "FBT", # flake8-boolean-trap
   "ICN001", # unconventional-import-alias

pyproject.toml

@@ -12,7 +12,7 @@
 -r requirements.txt
 #
 # Linters & Formatters
-ruff>=0.6.9 # Pre-commit fix # Must match .pre-commit-config.yaml
+ruff>=0.8.0 # Pre-commit fix # Must match .pre-commit-config.yaml
 #
 # Types
 scipy-stubs>=1.14.1.1