Files
SpoTUI-Fork/README.md
T

90 lines
1.8 KiB
Markdown

![SpoTUI animation](banner-gif.gif)
# SpoTUI
SpoTUI is a terminal-style Spotify skin built for Spicetify.
It combines:
- a custom UI overlay in `theme.js`
- theme styling in `user.css`
- Spotify color values in `color.ini`
## Screenshot
![SpoTUI preview](preview.png)
## Features
- Terminal-inspired interface
- Built-in playback controls
- Playlist browsing and management
- Spotify-native fallback mode
- Copy-log and hide/show controls
## Installation
<details>
<summary>Linux</summary>
1. Open a terminal.
2. Run the installer:
```bash
curl -fsSL -o install.sh https://raw.githubusercontent.com/SkenSMasteR/SpoTUI/f4787d9cab3bec4d2ed5dd1daf403ce08f8fb43f/scripts/install/linux/install.sh && chmod +x install.sh && ./install.sh
```
3. Select install
</details>
<details>
<summary>Windows</summary>
1. Open PowerShell.
2. Run the installer:
```powershell
iwr -useb https://raw.githubusercontent.com/SkenSMasteR/SpoTUI/f4787d9cab3bec4d2ed5dd1daf403ce08f8fb43f/scripts/install/windows/install.ps1 | iex
```
3. Select install
</details>
<details>
<summary>Marketplace</summary>
1. Open Spotify.
2. Go to the Spicetify Marketplace.
3. Select themes and search `SpoTUI`.
4. The only result will be the SpoTUI theme.
</details>
## Usage
After applying the theme, open Spotify and use the SpoTUI interface directly from the client.
The built-in command list includes:
- `tui -m [command|cli]`
- `playlist`
- `list`
- `queue`
- `play`
- `pause`
- `p`
- `skip`
- `back`
- `v <percent>`
- `volume <percent>`
- `shuffle`
- `loop [on|off]`
- `superloop [on|off]`
- `search`
- `clear`
## Theme Files
- `theme.js` - JavaScript UI logic
- `user.css` - Spotify UI styling overrides
- `color.ini` - theme colors
- `preview.png` - Marketplace preview image
## Author
SkenS - https://github.com/SkenSMasteR