Metadata-Version: 2.1
Name: i3-screen-util
Version: 0.2.1
Summary: A screen management tool for your lovely i3wm config.
Author-email: Can Vardar <ismailcanvardar@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Can Vardar
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/icanvardar/i3-screen-util
Project-URL: Issues, https://github.com/icanvardar/i3-screen-util/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

## i3-screen-util

I originally started building a custom i3 screen management configuration for personal use, but as it grew, I decided to turn it into a project for others to use.

Just for you! <3

### Installation

You can install `i3-screen-util` with pip:

```bash
pip install i3-screen-util
```

### Features

- **Organize Workspaces**: Backup and load i3wm workspaces based on their current layout and position.
- **Prevent Lockscreen**: Automatically disable the lock screen while watching videos, regardless of fullscreen status.
- **Toggle Monitor**: Quickly enable/disable monitors by specifying their monitor number and location.

### Dependencies

Before using `i3-screen-util`, ensure the following tools and packages are installed on your system:

- **playerctl**
- **xautolock**
- **i3-save-tree**
- **i3-msg**
- **xrandr**
- **screenkey**

### API Reference

#### Organize Workspaces

Back up or restore i3wm workspaces.

```bash
i3-screen-util organize --action [load|save] --workspaces <path_to_file>
```

- **--action**: `load` or `save`. Determines whether to restore or backup workspaces.
- **--workspaces**: Path to the file where workspaces will be saved or from where they will be loaded.

#### Prevent Lockscreen

Temporarily disable the lock screen to prevent interruptions while watching videos.

```bash
i3-screen-util lockscreen
```

#### Toggle Monitor

Enable or disable a monitor by specifying its number and optional location positioning.

```bash
i3-screen-util toggle --monitor-number <num> [--locate-to <left|right>] [--locate-of <monitor_number>]
```

- **--monitor-number**: The monitor number to toggle (starting from 1).
- **--locate-to**: Optional. Position the monitor to the left or right of another monitor.
- **--locate-of**: Optional. The monitor number to position relative to.

#### Toggle Screenkey

Enable or disable `screenkey` window.
```bash
i3-screen-util screenkey
```

### License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/icanvardar/i3-screen-util/blob/main/LICENSE) file for details.
