AvinashReddy3108 / spicetify-tui

A @spicetify theme that aims to mimic the looks of spotify-tui, based from @darkthemer's work.
MIT License
1 stars 0 forks source link

Logo

spicetify-tui
Explore the screenshots »

Report a Bug · Request a Feature . Ask a Question

[![Project license](https://img.shields.io/github/license/AvinashReddy3108/spicetify-tui.svg?style=flat-square)](LICENSE) [![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/AvinashReddy3108/spicetify-tui/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [![code with love by AvinashReddy3108](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-AvinashReddy3108-ff1414.svg?style=flat-square)](https://github.com/AvinashReddy3108)
Table of Contents - [About](#about) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Customization](#customization) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors & contributors](#authors--contributors) - [Security](#security) - [License](#license) - [Acknowledgements](#acknowledgements)

About

A @spicetify theme that aims to mimic the look of spotify-tui.

Screenshots

| | | | |:---------------------------------------------------------------------:|:---------------------------------------------------------------------:|:---------------------------------------------------------------------:| | Spotify | Spicetify | Dracula | | | | | | Catppuccin Mocha | Catppuccin Macchiato | Catppuccin Latte | | | | | | Gruvbox | Kanagawa | Nord | | | | | | Rigel | Rose Pine | Rose Pine Moon | | | | | | Solarized | Tokyo Night | Tokyo Night Storm |

Getting Started

Prerequisites

Installation

Automated installation
For Windows (Powershell): ```ps1 iwr -useb 'https://raw.githubusercontent.com/AvinashReddy3108/spicetify-tui/master/install.ps1' | iex ``` For Linux/macOS (Bash): ```sh curl -fsSL 'https://raw.githubusercontent.com/AvinashReddy3108/spicetify-tui/master/install.sh' | sh ```

Add the following to your config-xpui.ini file. Details as to why are explained here.

[Patch]
xpui.js_find_8008 = ,(\w+=)56,
xpui.js_repl_8008 = ,${1}32,

Customization

Display Images
Open `user.css` with a code editor like Notepad++/VSCode, and under the `:root`: ```css --display-card-image: block; --display-coverart-image: block; --display-header-image: block; --display-library-image: block; --display-tracklist-image: block; ``` ![Result (with images)](docs/images/screenshots/withimg.png)
Remove Images (for the realistic TUI look)
Open `user.css` with a code editor like Notepad++/VSCode, and under the `:root`: ```css --display-card-image: none; --display-coverart-image: none; --display-header-image: none; --display-library-image: none; --display-tracklist-image: none; ``` ![Result (without images)](docs/images/screenshots/withoutimg.png)
[Windows] Make the window controls' background match with the topbar background
Open `user.css` with a code editor like Notepad++/VSCode, and append this snippet: ```css /* transparent window controls background */ body::after { content: ""; position: absolute; right: 0; z-index: 999; backdrop-filter: brightness(2.12); /* page zoom [ctrl][+] or [ctrl][-] edit width and height accordingly 69% = 194px 45px 76% = 177px 40.5px 83% = 162px 37.5px 91% = 148px 34px 100% = 135px 31px (default) 110% = 123px 28.5px */ width: 135px; height: 31px; } ``` ![Result](docs/images/screenshots/winctrl.png)

Roadmap

See the open issues for a list of proposed features (and known issues).

Support

Reach out to the maintainer at one of the following places:

Project assistance

If you want to say thank you or/and support active development of spicetify-tui:

Together, we can make spicetify-tui better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Avinash Reddy.

For a full list of all authors and contributors, see the contributors page.

Security

spicetify-tui follows good practices of security (where applicable), but 100% security cannot be assured. spicetify-tui is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements