Metadata-Version: 2.3
Name: sctt
Version: 0.2.0
Summary: SpeedCubeTimer-TUI (sctt)
Project-URL: Homepage, https://github.com/sou-san/sctt
Project-URL: Repository, https://github.com/sou-san/sctt
Project-URL: Issues, https://github.com/sou-san/sctt/issues
Project-URL: Documentation, https://github.com/sou-san/sctt/blob/main/README.md
Author-email: sou-san <sou887867@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Yusei Soma
        
        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.
Keywords: cli,scrambler,sctt,speed cube timer,terminal,tool,tui
Requires-Python: >=3.12
Requires-Dist: keyboard>=0.13.5
Requires-Dist: rich>=13.9.4
Requires-Dist: textual-pyfiglet==0.5.0
Requires-Dist: textual>=0.86.3
Description-Content-Type: text/markdown

# SpeedCubeTimer-TUI (sctt)

![sctt_screenshot](https://github.com/user-attachments/assets/d5e05bc7-801d-42ba-a8ee-752c30ad5313)

It's a TUI speed cube timer app. It can generate scrambles, measure time and display the cube's state as a cube net. It can also be used on the Linux console. (A color that cannot be displayed may change to a different color that can be displayed.)

**It must be run as root to detect keyboard events.**

## Usage
### Using uv
If you don't have uv installed, please install it.
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
---
```bash
uv tool install sctt
```
```bash
sudo -E $(which sctt)
```
or
```bash
sudo -E $(which uvx) sctt
```

### Using pipx
If you don't have pipx installed, please install it.
```bash
sudo apt update && sudo apt install pipx
```
---
```bash
pipx install sctt
```
```bash
sudo -E $(which sctt)
```
or
```bash
sudo -E $(which pipx) run sctt
```

## Screenshots
![sctt_screenshot_7x7x7](https://github.com/user-attachments/assets/4670e5ad-1732-4822-aa96-29d033697825)
![sctt_screenshot_4x4x4_user_input](https://github.com/user-attachments/assets/f53dd3d8-c732-45dd-835b-2f045c3bb6a4)
