Metadata-Version: 2.4
Name: sctt
Version: 0.3.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.
License-File: LICENSE
Keywords: cli,scrambler,sctt,speed cube timer,terminal,tool,tui
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: keyboard>=0.13.5
Requires-Dist: rich>=13.9.4
Requires-Dist: textual-pyfiglet>=0.5.5
Requires-Dist: textual>=1.0.0
Requires-Dist: xdg-base-dirs>=6.0.2
Description-Content-Type: text/markdown

![Python version](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue.svg)
![PyPi version](https://img.shields.io/badge/pypi%20package-v0.3.0-green.svg)
![OS support](https://img.shields.io/badge/OS-Linux%20%7C%20Windows-red.svg)

# SpeedCubeTimer-TUI (sctt)

![sctt_screenshot](https://github.com/user-attachments/assets/c2d3a16d-215f-4bb3-af2f-b39d0edffb59)

It's a TUI speed cube timer app. It can generate scrambles, measure time, save solve data, statistics feature, 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.)

## Usage

### Linux

If you don't have uv installed, please install it.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

---

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

```bash
uv tool install sctt
```

```bash
sudo -E $(which sctt)
```

or

```bash
sudo -E $(which uvx) sctt
```

### Windows

If you don't have uv installed, please install it.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

---

```powershell
uv tool install sctt
```

```powershell
sctt
```

or

```powershell
uvx sctt
```

#### WSL2

sctt cannot be run because WSL2 cannot detect key release events.

Instead, run it via powershell as follows.

```bash
powershell.exe sctt
```

## Development

```bash
git clone https://github.com/sou-san/sctt
```

```bash
cd sctt
```

---

### Linux

```bash
sudo -E $(which uv) run textual run --dev src/sctt/__main__.py
```

### Windows

```powershell
uv run textual run --dev .\src\sctt\__main__.py
```

## Screenshots

![session manager](https://github.com/user-attachments/assets/bfcd5fe4-2f10-4aab-be52-4fc9dd02fc84)

![time](https://github.com/user-attachments/assets/df505f8a-3d72-4d9d-88a0-ed8058640fba)

![time +2 penalty](https://github.com/user-attachments/assets/88166632-ab7d-4a0f-8de5-3b142abe7356)

![time DNF penalty](https://github.com/user-attachments/assets/bd4832c8-7863-4637-a2b3-21b89df7d5f6)

![ao5](https://github.com/user-attachments/assets/593fbf5b-0464-4d29-9753-334b86d69371)

![ao12](https://github.com/user-attachments/assets/97977e9a-1efa-4ae3-aa7d-67c2ded612ed)

![scramble option](https://github.com/user-attachments/assets/c67fa026-375e-4d59-9bf0-a31e4294dc83)

![input scramble](https://github.com/user-attachments/assets/071bfecc-e699-4af3-93d5-5c74f9f0763f)

![scramble events](https://github.com/user-attachments/assets/8f9cbce2-0b86-4e77-ae83-c0e254d5c5fa)

![7x7x7 scramble](https://github.com/user-attachments/assets/b68c7169-4a00-484e-ad93-bced436d29fc)
