abs3nt/gospt
1
2
Fork 0
Code Issues 2 Pull Requests 10 Packages Projects Releases 20 Wiki Activity

rm

Browse Source
This commit is contained in:
abs3nt 2024-08-27 22:37:59 -07:00
parent 40d0d2c919
commit 2d5567621f
Signed by: abs3nt
GPG Key ID: A7BD96A8BAB04C09
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,33 +1,34 @@
IF YOU ARE ON GITHUB.COM GO HERE INSTEAD: https://git.asdf.cafe/abs3nt/gspot :) IF YOU ARE ON GITHUB.COM GO HERE INSTEAD: https://git.asdf.cafe/abs3nt/gspot
If you open an issue or PR on github I won't see it please use git.asdf.cafe. Register on asdf and open your PRs there If you open an issue or PR on github I won't see it please use git.asdf.cafe. Register on asdf and open your PRs there
This project is still under heavy development and some things might not work or not work as intended. Don't hesitate to open an issue to let me know. This project is still under heavy development and some things might not work or not work as intended. Don't hesitate to open an issue to let me know.
--- ---
[![status-badge](https://ci.asdf.cafe/api/badges/abs3nt/gspot/status.svg)](https://ci.asdf.cafe/abs3nt/gspot) [![status-badge](https://ci.asdf.cafe/api/badges/abs3nt/gspot/status.svg)](https://ci.asdf.cafe/abs3nt/gspot)
# To install (with a package manager): # To install (with a package manager):
## Archlinux ([AUR]) ## Archlinux ([AUR])
```yay -S gspot-git```
`yay -S gspot-git`
# To build from source by pulling and building the binary # To build from source by pulling and building the binary
`git clone https://git.asdf.cafe/abs3nt/gspot`
```git clone https://git.asdf.cafe/abs3nt/gspot``` `cd gspot`
```cd gspot``` `make build && sudo make install`
```make build && sudo make install```
[AUR]: https://aur.archlinux.org/packages/gspot-git [AUR]: https://aur.archlinux.org/packages/gspot-git
# Configuration # Configuration
go here https://developer.spotify.com/dashboard/applications to make a spotify application. you will need a client ID and a client secret. Set your redirect uri like this: go here https://developer.spotify.com/dashboard/applications to make a spotify application. you will need a client ID and a client secret. Set your redirect uri like this:
```http://localhost:8888/callback``` `http://localhost:8888/callback`
add your information to ~/.config/gspot/gspot.yml like this add your information to ~/.config/gspot/gspot.yml like this
@ -36,6 +37,7 @@ client_id: "idgoeshere"
client_secret: "secretgoeshere" client_secret: "secretgoeshere"
port: "8888" port: "8888"
``` ```
if you dont want to store your secret in the file in plaintext you can use a command to retreive it: if you dont want to store your secret in the file in plaintext you can use a command to retreive it:
``` ```
@ -53,10 +55,9 @@ log_output: "file"
it will log to ~/.config/gspot/gspot.log it will log to ~/.config/gspot/gspot.log
## RUNNING ## RUNNING
```gspot``` `gspot`
you will be asked to login, you will only have to do this the first time. After login you will be asked to select your default device. you will be asked to login, you will only have to do this the first time. After login you will be asked to select your default device.
@ -64,20 +65,18 @@ helpful keybinds are shown in the bottom of the screen, hit ? to see all of them
To use the custom radio feature: To use the custom radio feature:
```gspot radio``` `gspot radio`
or hit ctrl+r on any track in the TUI. This will start an extended radio. To replenish the current radio run `gspot refillradio` and all the songs already listened will be removed and that number of new recomendations will be added.
or hit ctrl+r on any track in the TUI. This will start an extended radio. To replenish the current radio run ```gspot refillradio``` and all the songs already listened will be removed and that number of new recomendations will be added.
This radio uses slightly different logic than the standard spotify radio to give a longer playlist and more recomendation. With a cronjob you can schedule refill to run to have an infinite and morphing radio station. This radio uses slightly different logic than the standard spotify radio to give a longer playlist and more recomendation. With a cronjob you can schedule refill to run to have an infinite and morphing radio station.
To view help: To view help:
```gspot --help``` `gspot --help`
Very open to contributations feel free to open a PR Very open to contributations feel free to open a PR
[tmux plugin](https://git.asdf.cafe/abs3nt/tmux-gspot) [tmux plugin](https://git.asdf.cafe/abs3nt/tmux-gspot)
[wiki](https://git.asdf.cafe/abs3nt/gspot/wiki) [wiki](https://git.asdf.cafe/abs3nt/gspot/wiki)