mirror of https://github.com/SnapXL/SnapX.git synced 2026-04-25 13:05:58 +03:00

No description

Find a file

github-actions[bot] 00b622a481 build(flathub): update nuget vendor sources [skip ci]		2026-04-11 21:17:06 +00:00
.github	chore: fix the bug report issue form (#476 )	2026-04-11 17:15:09 -04:00
.idea/.idea.SnapX/.idea	chore: include ide config	2026-01-22 11:21:47 -05:00
.vscode	chore: include ide config	2026-01-22 11:21:47 -05:00
build	build(deps): update dotnet monorepo (#458 )	2026-03-17 08:49:36 +00:00
packaging	build(flathub): update nuget vendor sources [skip ci]	2026-04-08 17:18:48 +00:00
SnapX.Avalonia	build(deps): update avalonia monorepo to 11.3.13 (#470 )	2026-03-30 04:39:43 +00:00
SnapX.CLI	feat(Core): migrate configuration from JSON to YAML	2026-02-15 16:22:00 -05:00
SnapX.CommonUI	feat(Core): migrate configuration from JSON to YAML	2026-02-15 16:22:00 -05:00
SnapX.Core	build(deps): update dependency tmds.dbus.protocol to 0.92.0 (#475 )	2026-04-08 13:16:02 -04:00
SnapX.NativeMessagingHost	style: run dotnet format	2025-09-11 22:40:18 -04:00
SnapX.Secrets	build(Secrets): fix building on Windows	2026-02-21 11:39:13 -05:00
.editorconfig	chore: include ide config	2026-01-22 11:21:47 -05:00
.gitattributes	fix(Core): enable reflection until migration is complete	2024-12-27 16:33:31 -07:00
.gitignore	packaging: update Linux packaging to use new logo	2026-02-20 21:52:08 -05:00
build.ps1	build: auto install .NET 10	2025-12-12 09:59:04 -05:00
build.sh	build: make build dir source of version truth	2026-02-08 14:20:59 -05:00
Directory.Build.props	build(deps): update dependency gitversion.msbuild to 6.7.0 (#467 )	2026-03-23 17:41:47 -04:00
GitVersion.yml	build(GitVersion): mark develop as a source for master	2026-02-04 11:25:25 -05:00
global.json	build: require & use .NET 10	2025-12-31 16:22:10 -05:00
LICENSE.md	docs: make a line in LICENSE a newline (#306 )	2025-08-22 08:19:19 -04:00
README.md	docs: update tagline to be more descriptive and direct	2026-03-15 23:31:54 -04:00
SnapX.slnx	build(Secrets): fix building on Windows	2026-02-21 11:39:13 -05:00

README.md

SnapX

Capture, share, and automate your screenshots.

Built on the foundations of ShareX, made cross-platform.

Everything you love, engineered for speed. User-centric. Native. Powerful.

Caution

SnapX is in Early Access. The core capture and upload engine is stable and ready for daily use. However, the Image Editor is still in the works.

Feature-wise

Supporting high DPI screens
Screenshots on an HDR monitor aren't blown out^[1]
Cross-platform OCR powered by PaddleOCR for industry-leading precision. Experience accuracy that outperforms PowerToys OCR, ShareX, Tesseract, and Windows' built in OCR.

[1] When tested on KDE Plasma Wayland 6.2.90 with HDR, the resulting screenshots' colors were not blown out. Your mileage may vary.

Supported Desktop Environments

This application relies on XDG portals to handle screenshots in a secure and desktop-agnostic way. It is actively tested on:

KDE Plasma
GNOME

We also use direct X11 screenshot capture on X based environments.

Tip

Other desktop environments or Wayland compositors, like Budgie, Cinnamon, MATE, Hyprland, and any others that have the right screenshot portal, should work, but they haven't been officially tested.

Packaging

See our quick start testing guide here to learn how to test SnapX.

SnapX is packaged on:

AUR: snapx-ui
Snapcraft: ui-snapx
Homebrew: BrycensRanch/homebrew-repo
DEB/RPM Repo: Setup Instructions

Flatpak (Flathub pending)

x86_64: Download
aarch64: Download

Additionally, you can download nightly builds from here.

Technical Details

Uses .NET 10 and ImageSharp (cross-platform image library).
Uses SQLite for image metadata like image hashes & history.
Uses YAML for a cleaner configuration supporting comments with auto migration from JSON.
UI is GPU-accelerated, leading to a more responsive UI & yet less CPU usage while navigating the UI. (Fixes low performance on 4K screens with a weak CPU)
Respects XDG directory specification, Symlinks ~/Documents/SnapX to respective config/data directory on Linux/macOS.
Uses Direct3D11 & WinRT to capture on Windows, XCap on macOS, and XDG Portals on Linux.
Supports PNG (including animated variant), WEBP (including animated variant), AVIF, JPEG, GIFs (should be smaller than your typical ShareX GIF), TIFF, and BMP image formats.
Supports 95% of ShareX uploaders (we're a fork!).
Allows you to fully configure SnapX via the Command Line via command flags & environment variables. Additionally, you can configure SnapX using the Windows Registry.
Keeps compatibility with the custom uploader configuration format (.sxcu).
As a user, you do NOT need to have .NET installed. Whether you're on Linux, Windows, macOS, or FreeBSD.

What does this all mean? It means you'll be able to have a more performant, reliable, and stylish application.

You will not receive any support from the ShareX project for this software.
If you have any issues with this project or would like us to add any new feature, please open an issue in this repository or use the #development channel in our Discord.

Building & Contributing

Contributions are welcome. See BUILDING.md for build instructions.

The documentation for contributing can be found at CONTRIBUTING.md.

🤝 Real People. Real Code. Soul. 💖

Free-range, organic, non-GMO, and locally sourced developers. This code was created without causing any damage to any GPUs.

👨‍💻 Espresso Consortium

Turning caffeine into code, and bugs into features.

The architects, packagers, documentation writers, debuggers, and morning birds currently building SnapX.

BrycensRanch (Lead)

ok-coder1 (Team)

Rune580

norz3n

💸 The Caffeine & Infrastructure Cartel

These charitable people support our early morning server maintenance and coding sessions. Their donations literally keeps the lights on and the compilers warm.

Rsslone (Tommy)