Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kittenzexe/kiku
An API to get your Spotify status through discord
https://github.com/kittenzexe/kiku
api discord discord-api spotify spotify-api status
Last synced: about 1 month ago
JSON representation
An API to get your Spotify status through discord
- Host: GitHub
- URL: https://github.com/kittenzexe/kiku
- Owner: KittenzExe
- License: gpl-3.0
- Created: 2024-04-20T18:37:33.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-19T13:01:16.000Z (7 months ago)
- Last Synced: 2024-05-19T14:23:27.803Z (7 months ago)
- Topics: api, discord, discord-api, spotify, spotify-api, status
- Language: TypeScript
- Homepage: https://kiku.kittenzexe.com
- Size: 151 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Kiku - https://kiku.kittenzexe.com
An API to get your Spotify status through discord
> [!NOTE]
> Discord bot is not open source right now, expect it to be added later.
## Links
- default api - https://kiku.kittenzexe.com/v1/your_user_id
- websocket - wss://kiku.kittenzexe.com/v1/your_user_id
- user page - https://kiku.kittenzexe.com/v1/user/your_user_id
## Setup
- Join my [discord](https://discord.gg/Sq6GSbZjHj) (Where I have the bot hosted)
- Go to [#commands](https://discord.com/channels/971691815617036348/1185841646215102464) and use `/register`
- Head over to [https://kiku.kittenzexe.com/v1/](https://kiku.kittenzexe.com/v1/)your-user-ID (See below how to get your user ID if you don't know how to)
- Thats it! If you are currently listening to something on Spotify, it should appear!
## How to get you user ID
### Using the Kiku Bot
- Use `/userid` to get your user ID.
### Discord developer mode
- If you havent enabled developer mode before, follow these steps
- Go to your settings
- Scroll down to `advanced`
- Enable `Developer Mode`
- Then right click your profile and down the bottom you should see `Copy User ID`
## Examples
### On a website
(using websocket connection on my personal website!)
### Example for livestream overlay
- [Kiku-Livestrean](https://github.com/KittenzExe/Kiku-livestream) (This is what I use for my streams)
## Running
### For local dev
- npm install
- npx ts-node src/app.ts
- [localhost:1545](http://localhost:1545/)
### For Docker
- docker-compose up -d
- [localhost:1545](http://localhost:1545/)
## Contributing
Any contribution is welcome. This has been an off and on project for the past few weeks so my horrible code might need some fixes. I plan to implement some more features in the future though so be prepared.
## License
Under the [GNU Affero General Public License v3.0](https://github.com/KittenzExe/kiku?tab=AGPL-3.0-1-ov-file)
## Star History
