==============================================================
                   FANTYZO USER MANUAL
                     Version 1.8.1
     https://www.fantyzo.com  -  by Imagine Foundry
==============================================================

CONTENTS
  1. What is Fantyzo?
  2. Supported Linux systems
  3. Installation
  4. Configuration (hotkeys and autostart)
  5. Using Fantyzo
  6. Where your files are kept
  7. Updating and uninstalling
  8. Troubleshooting
  9. Privacy note
 10. License agreement

--------------------------------------------------------------
1. WHAT IS FANTYZO?
--------------------------------------------------------------
Fantyzo is a fast screenshot and screen recording tool, a free
alternative to Gyazo.

 * SCREENSHOT: drag a box around any part of your screen.
   Fantyzo uploads it to catbox.moe, copies the link to your
   clipboard, opens it in your browser, and adds it to your
   Fantyzo History. No copy is saved on your computer.

 * RECORDING: drag a box around any part of your screen and
   Fantyzo records it to an MP4 video file on your computer.

Fantyzo lives in your panel's system tray as a small
magnifying glass icon.

--------------------------------------------------------------
2. SUPPORTED LINUX SYSTEMS
--------------------------------------------------------------
This .deb package is for 64-bit PCs (amd64) running an X11
(Xorg) desktop session.

WORKS ON:
 * Linux Mint 22.x  (22, 22.1, 22.2 and later 22.x)
     Cinnamon, MATE and Xfce editions
 * Ubuntu 24.04 LTS - log in with "Ubuntu on Xorg"
     (see section 8, "Wayland session")
 * Xubuntu 24.04 and newer, Ubuntu MATE 24.04
     (X11 desktops)
 * Kubuntu 24.04 - choose "Plasma (X11)" at login

DOES NOT WORK ON:
 * Ubuntu 25.10 and 26.04 LTS with the standard GNOME desktop.
   These releases are Wayland-only and have no Xorg session.
   (Xubuntu 26.04 still works.)
 * Linux Mint 21.x and Ubuntu 22.04 or older (system
   libraries are too old for this package).
 * LMDE, Debian, Fedora and non-amd64 (ARM) computers.

Not sure which session you are in? Open a terminal and type:
    echo $XDG_SESSION_TYPE
It must print:  x11

--------------------------------------------------------------
3. INSTALLATION
--------------------------------------------------------------
You need the file:  fantyzo_1.8.1_amd64.deb
Download it from https://www.fantyzo.com

Option A - Terminal (all systems):
  1. Open a terminal in the folder holding the .deb file.
     Example, if it is in Downloads:
         cd ~/Downloads
  2. Install it (note the ./ in front of the file name):
         sudo apt install ./fantyzo_1.8.1_amd64.deb
  3. Enter your password. apt also installs FFmpeg and any
     other needed parts automatically.

Option B - Double-click (Linux Mint):
  1. Double-click fantyzo_1.8.1_amd64.deb in your file manager.
  2. Click Install and enter your password.

After installing:
  * Fantyzo appears in your menu under Graphics.
  * The command "fantyzo" is available in the terminal.

Start Fantyzo:
  Menu > Graphics > Fantyzo
A magnifying glass appears in the system tray.

UBUNTU (GNOME) NOTE: the tray icon appears at the top-right
of the screen. Ubuntu includes the AppIndicator support that
shows it. If the icon is missing, run:
    sudo apt install gnome-shell-extension-appindicator
then log out and back in.

--------------------------------------------------------------
4. CONFIGURATION
--------------------------------------------------------------
4a. HOTKEYS (recommended)

Fantyzo is fastest with keyboard shortcuts. Suggested keys:

   Action        Command                      Key
   ----------    -------------------------    ----------
   Screenshot    /usr/bin/fantyzo --shot       Ctrl+Alt+S
   Record        /usr/bin/fantyzo --record     Ctrl+Alt+R
   History       /usr/bin/fantyzo --history    Ctrl+Alt+H

The Record key starts a recording; press it again to stop.
If a key is already in use, choose another combination.

LINUX MINT (Cinnamon):
  1. Menu > System Settings > Keyboard > Shortcuts tab.
  2. Click "Custom Shortcuts", then "Add custom shortcut".
  3. Enter a Name (e.g. Fantyzo screenshot) and the Command
     from the table above. Click Add.
  4. Select the new shortcut. Under "Keyboard bindings",
     click "unassigned" and press the key combination.
  5. Repeat for Record and History.

LINUX MINT (MATE) / UBUNTU MATE:
  Menu > Control Center > Keyboard Shortcuts > Add.
  Enter Name and Command, click Apply, then click the
  shortcut's "Disabled" field and press the keys.

LINUX MINT (Xfce) / XUBUNTU:
  Settings > Keyboard > Application Shortcuts tab > Add.
  Enter the Command, click OK, then press the keys.

UBUNTU (GNOME on Xorg):
  Settings > Keyboard > View and Customize Shortcuts >
  Custom Shortcuts > Add Shortcut (+). Enter Name and
  Command, click "Set Shortcut", press the keys, click Add.

4b. START FANTYZO AUTOMATICALLY AT LOGIN (optional)

Works on every desktop. In a terminal run:
    mkdir -p ~/.config/autostart
    cp /usr/share/applications/fantyzo.desktop ~/.config/autostart/

To stop autostarting:
    rm ~/.config/autostart/fantyzo.desktop

--------------------------------------------------------------
5. USING FANTYZO
--------------------------------------------------------------
5a. TAKE A SCREENSHOT
  1. Press Ctrl+Alt+S, OR left-click the magnifying glass,
     OR right-click it and choose "Screenshot region".
  2. The screen freezes and darkens. Drag a box around the
     area you want. The size in pixels is shown as you drag.
  3. Let go of the mouse button. Fantyzo uploads the image.
  4. When done:
       - the link is copied to your clipboard (Ctrl+V to paste)
       - the image opens in a new browser tab
       - a "Link copied" notification appears
       - the link is added to Fantyzo History
  To cancel: press Esc or right-click.

  UBUNTU (GNOME) NOTE: clicking the tray icon opens its menu;
  choose "Screenshot region" there, or use the hotkey.

5b. RECORD A VIDEO
  1. Press Ctrl+Alt+R, OR right-click the magnifying glass
     and choose "Record region".
  2. Drag a box around the area to record.
  3. Recording starts at once. A red frame surrounds the
     area (the frame is NOT in the video) and the glass of
     the tray icon turns red.
  4. To stop: press Ctrl+Alt+R again, OR left-click the tray
     icon, OR right-click it and choose "Stop recording".
  5. A "Recording saved" notification shows the file path.
  Videos are 30 frames per second MP4 (H.264) and include
  the mouse pointer. No sound is recorded.

5c. HISTORY
  Right-click the magnifying glass and choose "History...",
  or press Ctrl+Alt+H. The window lists every uploaded
  screenshot link, newest first.
    Open   - opens the selected link(s) in your browser.
             Ctrl-click or Shift-click to select several.
             Double-clicking a row also opens it.
    Clear  - empties the History list (asks first). The
             images stay online at catbox.moe.
    Save   - saves the list to a .txt or .csv file.

5d. TRAY MENU (right-click the magnifying glass)
    Screenshot region
    Record region / Stop recording
    Copy last link          - copies the newest link again
    History...
    Open recordings folder
    User Manual             - opens this manual
    License Agreement       - opens the Fantyzo EULA
    Quit

5e. MENU LAUNCHER
  Menu > Graphics > Fantyzo starts Fantyzo. Right-click the
  menu entry for quick Screenshot, Record and History
  actions.

5f. TERMINAL COMMANDS
    fantyzo               start Fantyzo
    fantyzo --shot        take a screenshot
    fantyzo --record      start or stop a recording
    fantyzo --history     open History
    fantyzo --quit        quit Fantyzo
    fantyzo --version     show the version
  If Fantyzo is not running, --shot, --record and --history
  start it first.

--------------------------------------------------------------
6. WHERE YOUR FILES ARE KEPT
--------------------------------------------------------------
  Recordings:  ~/Videos/Fantyzo/
               named fantyzo_YYYY-MM-DD_HH-MM-SS.mp4
  History:     ~/.local/share/Fantyzo/history.json
  Screenshots: not saved on your computer; they are online
               at the catbox.moe links in your History.
  Program:     /opt/fantyzo/  (command: /usr/bin/fantyzo)
  Manual:      /usr/share/doc/fantyzo/Fantyzo-User-Manual.txt
  License:     /usr/share/doc/fantyzo/EULA.txt

  (~ means your home folder, for example /home/yourname)

--------------------------------------------------------------
7. UPDATING AND UNINSTALLING
--------------------------------------------------------------
UPDATE to a newer version:
  1. Quit Fantyzo:  fantyzo --quit
  2. Install the new .deb the same way as in section 3.
  Your History, recordings and hotkeys are kept.

UNINSTALL:
    fantyzo --quit
    sudo apt remove fantyzo
  Your recordings and History are NOT deleted. To delete
  the History as well:
    rm -r ~/.local/share/Fantyzo

--------------------------------------------------------------
8. TROUBLESHOOTING
--------------------------------------------------------------
TIP: run Fantyzo from a terminal to see error messages:
    fantyzo --quit
    fantyzo

"X11 session required" / screen is black / nothing happens
  You are in a Wayland session (see section 2). Check:
      echo $XDG_SESSION_TYPE
  If it prints "wayland":
    Ubuntu 24.04: log out, click your name on the
    login screen, click the gear icon at the bottom-right,
    choose "Ubuntu on Xorg", then log in.
    Ubuntu 25.10 / 26.04 GNOME: no Xorg session exists.
    Use Xubuntu or Linux Mint instead.

No magnifying glass in the tray
  * Make sure Fantyzo is running:  fantyzo
  * Linux Mint: right-click the panel > Applets and check
    that "System Tray" (Xapp Status Applet) is enabled.
  * Ubuntu GNOME: see the note at the end of section 3.

Hotkey does nothing
  * Check the command is exactly /usr/bin/fantyzo --shot
  * Choose a key that no other program uses.

"Upload failed"
  * Check your internet connection.
  * catbox.moe may be busy or down; try again later.

Recording shows brief flashes of the desktop wallpaper
  This happens with NVIDIA graphics when recording 3D
  programs such as the Second Life viewer. Fantyzo fixes it
  automatically during recordings (it switches off NVIDIA
  "page flipping", then switches it back on). This needs the
  nvidia-settings tool, installed with the NVIDIA driver.

"Recording failed"
  * Check FFmpeg is installed:  ffmpeg -version
  * Very small areas cannot be recorded; drag a larger box.

Install error mentioning libc6
  Your system is too old for this package (see section 2).

--------------------------------------------------------------
9. PRIVACY NOTE
--------------------------------------------------------------
Screenshots are uploaded ANONYMOUSLY to catbox.moe, a free
public file host. Anyone who has a link can view that image,
and anonymous uploads CANNOT be deleted afterwards. Do not
capture passwords, personal details or anything private.

Recordings never leave your computer.

--------------------------------------------------------------
10. LICENSE AGREEMENT
--------------------------------------------------------------
Fantyzo is free. Its use is governed by the Fantyzo End User
License and Usage Agreement (EULA). By downloading, installing
or using Fantyzo you agree to it. Read it any time:
  * right-click the magnifying glass > License Agreement, or
  * open /usr/share/doc/fantyzo/EULA.txt
Third-party software used by Fantyzo is listed in
/usr/share/doc/fantyzo/THIRD-PARTY-NOTICES.txt.

==============================================================
    Fantyzo 1.8.1  -  Imagine Foundry  -  www.fantyzo.com
==============================================================
