GH-forks/hyprfreeze
1
0
Fork 1
mirror of https://github.com/Zerodya/hyprfreeze.git synced 2024-09-19 23:43:18 +02:00
Code Activity

Update README.md

Browse source
This commit is contained in:
Nicola 2024-02-10 22:48:08 +01:00 committed by GitHub
parent f378338ae0
commit 770582b946
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -2,18 +2,24 @@
Hyprfreeze is a utility to suspend a game process (and other programs) in Hyprland. Hyprfreeze is a utility to suspend a game process (and other programs) in Hyprland.
Useful to: Useful to:
- Pause single-player games that can't be paused (like Dark Souls) - Pause single-player games that can't normally be paused (Elden Ring, Baldur's Gate 3, ...)
- Pause during cutscenes to read the subtitles or when something urgent comes up - Pause cutscenes to read the subtitles or if you suddenly need to leave your desk
- Save system resources (excluding RAM) if you need them for another computer task, or if the game's pause menu uses too many - Save system resources (excluding RAM) if you need them for another computer task, or if the game's pause menu uses too many
Note: Running games in [gamescope](https://github.com/ValveSoftware/gamescope) is highly recommended. (See [#1](https://github.com/Zerodya/hyprfreeze/issues/1))
## Installation ## Installation
### Arch Linux ### Arch Linux
Hyprfreeze is available in [AUR](https://aur.archlinux.org/packages/hyprfreeze-git). Hyprfreeze is available in [AUR](https://aur.archlinux.org/packages/hyprfreeze-git).
### Dependencies ### Dependencies
- hyprland (to get the pid of the active window with hyprctl) - `hyprland` to get the pid of the active window with hyprctl
- jq (to parse json) - `jq` to parse json
- hyprprop (to get the pid of a window by selecting it with your mouse) - `psmisc` contains 'pstree' which is required to list child processes
### Optional
- [`hyprprop`](https://github.com/vilari-mickopf/hyprprop) to get the pid of a window by selecting it with your mouse
### Highly Recommended
- [`gamescope`](https://github.com/ValveSoftware/gamescope) fixes mouse input not working in other XWayland windows after pausing a Wine game. It's also the superior way to game in Wayland anyway.
### Manual ### Manual
Clone this repo and symlink the `hyprfreeze` script to a directory in your `PATH`: Clone this repo and symlink the `hyprfreeze` script to a directory in your `PATH`:
@ -36,14 +42,17 @@ bind = , PAUSE, exec, hyprfreeze -a
### Available flags ### Available flags
``` ```
-h, --help show help message -h, --help show help message
-a, --active suspend/resume active window
-p, --pid suspend/resume by process id -a, --active toggle suspend by active window
-n, --name suspend/resume by process name/command -p, --pid toggle suspend by process id
-r, --prop suspend/resume by clicking on window -n, --name toggle suspend by process name/command
-r, --prop toggle suspend by clicking on window
-s, --silent don't send notification -s, --silent don't send notification
-t, --notif-timeout notification timeout in milliseconds (default 5000) -t, --notif-timeout notification timeout in milliseconds (default 5000)
--info show information about the process --info show information about the process
--dry-run doesn't actually suspend/resume a process, useful with --info --dry-run doesn't actually suspend/resume a process, useful with --info
--debug enable debug mode
``` ```
### Examples: ### Examples:
``` ```
@ -60,9 +69,3 @@ There is always the risk, although slim, that an application may crash.
This is intrinsically related to modifying running processes and is not something that Hyprfreeze can prevent. This is intrinsically related to modifying running processes and is not something that Hyprfreeze can prevent.
Please make sure to **save your data** before using hyprfreeze. Please make sure to **save your data** before using hyprfreeze.
## Known issues
- Pausing Wine/Proton games will cause mouse input to not work inside XWayland windows [#1](https://github.com/Zerodya/hyprfreeze/issues/2)
- Workaround 1: Run the game in `gamescope`
- Workaround 2: Pause the game from a terminal `hyprfreeze -n eldenring.exe`
- Pausing Linux native games (e.g. Minecraft) may cause sound to stop in other apps [#2](https://github.com/Zerodya/hyprfreeze/issues/2)