Simple Shot

Professional screen capture with annotations and instant upload

Capture regions, annotate, add watermarks — save locally or upload to SFTP, FTP, or S3.
Runs in the system tray. Multi-monitor, 10 languages.

---

📑 Table of Contents

• Features
• Screenshots
• Requirements
• Quick Start
• Usage
• Configuration
• Internationalization
• Project Structure
• Building
• Windows Installer
• Contributing
• License

---

✨ Features

📸 Screen capture Multi-display — Overlay on each monitor; pick a screen and drag to select Aspect-ratio crop — 3:2, 2:3, 4:3, 3:4, 1:1, 16:9 or free Resize & move — Handles and drag to adjust the selection ✏️ Annotations Shapes — Rectangle, circle (outline/filled; right-click toggles) Text & numbers — With optional background Arrow — Click to release Brush — Freehand draw Blur — Hide sensitive areas (applied on export) Move — Drag any annotation; Undo last change Format — Text color, highlight, font size, stroke

☁️ Export & upload Save to file — PNG via save dialog; path to clipboard Upload — URL to clipboard SSH (SFTP) — Host, port, user, password or key, path FTP / FTPS — With optional TLS Amazon S3 — Bucket, region, optional custom endpoint 🏷️ Watermark Optional text on every export Position, font size, color, opacity 🔗 Other Link history — Recent uploads/saves; click to copy System tray — Left-click capture, right-click menu Settings — Stored in user data

---

📷 Screenshots

Capture overlay	Settings
Overlay on each display; drag to select, toolbar for crop and annotations.	Language, save method (SSH/FTP/S3), base URL, watermark.

After starting capture from the tray, overlay windows appear on each display. Drag to select a region; use the toolbar to crop, annotate, then save to file or upload to server.

---

📋 Requirements

Requirement	Version
Node.js	18+ (LTS recommended)
Package manager	npm or yarn
OS	Windows, macOS, or Linux (Electron-supported)

---

🚀 Quick Start

git clone https://github.com/prybytkow/simple-shot.git
cd simple-shot
npm install
npm run build
npm start

Or run in development mode (auto-rebuild on change):

npm run dev

---

📖 Usage

1. Start — Click the tray icon or choose Capture from the tray menu.
2. Select — Click and drag on the desired screen to define the region; resize with handles if needed.
3. Annotate (optional) — Use the toolbar: crop, shapes, text, arrows, brush, blur; set format.
4. Export — Save to file (PNG, path to clipboard) or Upload to server (URL to clipboard).
5. History — Tray → Link History to see recent uploads/saves and copy links.

Shortcut	Action
ESC	Cancel capture and hide overlay

---

⚙️ Configuration

All settings: Tray → Settings. Stored in user data (e.g. %APPDATA%\simple-shot on Windows).

Section	Description
Save method	SSH (SFTP), FTP, or Amazon S3 — host, credentials, paths
Base URL	Prefix for uploaded file links (e.g. https://vault.by)
Watermark	Enable, text, position, font size, color, opacity (0–1)
Language	Interface language or System default

---

🌍 Internationalization

Code	Language	Code	Language
en	English	it	Italiano
ru	Русский	es	Español
zh	中文	pt	Português
pl	Polski	fr	Français
uk	Українська	—	—
be	Беларуская	—	—

• Default: English. System default uses OS locale with fallback to English.
• Language is saved and applied to tray, settings, capture overlay, and history.

---

📁 Project Structure

Source and assets are in the repo; dist/ is generated by the build (gitignored).

simple-shot/
├── src/main/              # Main process (TypeScript)
│   ├── main.ts            # Entry, tray, windows, IPC
│   ├── screen-capture.ts  # Capture, watermark, save/upload
│   ├── i18n.ts            # Translations
│   ├── history.ts         # Upload/save history
│   ├── ssh-handler.ts     # SSH/SFTP
│   └── uploaders/         # SSH, FTP, S3 uploaders
├── renderer/              # HTML UIs → dist/renderer
│   ├── capture-window.html
│   ├── settings.html
│   └── history.html
├── assets/                # Icons → dist/main/assets
│   ├── icon.png
│   └── icon.ico
├── scripts/
│   └── copy-build-assets.js
├── package.json
├── tsconfig.json
└── LICENSE

---

🔨 Building

Command	Description
npm run build	Compile TypeScript, copy renderer + assets to dist/
npm start	Build (if needed) and run the app
npm run dev	Watch mode: rebuild and restart on change

Build output: dist/main/ (JS + assets), dist/renderer/ (HTML).

---

📦 Windows Installer

Build an installable Windows app (NSIS .exe and portable) with electron-builder. Run on Windows.

npm install
npm run dist

Output in release/:

Output	Description
Simple Shot Setup 1.0.0.exe	NSIS installer — choose directory, Start Menu, desktop shortcut
win-unpacked/	Portable — run Simple Shot.exe without installing

Icons: Put icon.png and icon.ico in assets/. They are copied to dist/main/assets/ on build. Use a multi-size .ico (16×16, 32×32, 48×48, 256×256) for best results.

Icon not updating? Clean build: delete release/ and dist/, then npm run dist. Clear Windows icon cache (%LocalAppData%\IconCache.db, restart Explorer) if needed.

---

🤝 Contributing

Contributions are welcome. For larger changes, open an issue first. Ensure the project builds and runs:

npm run build && npm start

---

📄 License

This project is licensed under the MIT License — see LICENSE for the full text.

Copyright © 2025 Aliaksei Prybytkou