coco
127 lines
4.8 KiB
Markdown
127 lines
4.8 KiB
Markdown
<div align="center">
|
|
<img src="metadata/banner.jpg">
|
|
</div>
|
|
<br>
|
|
|
|
<div align="center">
|
|
<img src="https://img.shields.io/badge/Minimum%20SDK-27-%23?&style=flat-square&color=5b5ef7">
|
|
|
|
<img src="https://img.shields.io/github/downloads/dead8309/Kizzy/total?&style=flat-square&color=5b5ef7">
|
|
|
|
<a href="https://github.com/dead8309/Kizzy/releases/latest">
|
|
<img alt="Release" src="https://img.shields.io/github/v/release/dead8309/Kizzy?&style=flat-square&color=5b5ef7&display_name=release">
|
|
</a>
|
|
|
|
<img src="https://img.shields.io/github/workflow/status/dead8309/Kizzy/Release%20Apk?&style=flat-square&color=5b5ef7">
|
|
|
|
<img src="https://img.shields.io/badge/kotlin-5b5ef7.svg?logo=kotlin&logoColor=white&style=flat-square">
|
|
|
|
<img src="https://img.shields.io/badge/Android_Studio-5b5ef7?logo=android-studio&logoColor=white&style=flat-square">
|
|
|
|
<img src="https://dcbadge.vercel.app/api/shield/888890990956511263?style=flat-square&compact=true">
|
|
|
|
<a href="https://discord.gg/vUPc7zzpV5">
|
|
<img src="https://dcbadge.vercel.app/api/server/vUPc7zzpV5">
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<h1>Kizzy</h1>
|
|
<h4>A Discord Rich Presence manager for Android fully written in Kotlin.
|
|
</h4>
|
|
<p>
|
|
<img src="metadata/rpc.png" width=60%/>
|
|
</p>
|
|
</div>
|
|
|
|
> **Warning**
|
|
> I do not take any responsibility for a user's account if they downloaded a clone/app claiming to be *Kizzy* from any third party services(except the download links mentioned in repository).
|
|
|
|
## Download
|
|
<a href="https://github.com/dead8309/Kizzy/releases/latest">
|
|
<img src="https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white"
|
|
alt="Download from GitHub"
|
|
height="60">
|
|
</a>
|
|
<a href="https://apt.izzysoft.de/fdroid/index/apk/com.my.kizzy">
|
|
<img src="https://codeberg.org/IzzyOnDroid/repo/raw/commit/6b8ffbd7746747238cb48f6076764eaf4e390316/assets/IzzyOnDroid.png">
|
|
</a>
|
|
|
|
## Screenshots
|
|
<div>
|
|
<img src="metadata/0.jpg" width="30%" />
|
|
<img src="metadata/1.jpg" width="30%" />
|
|
<img src="metadata/2.jpg" width="30%" />
|
|
<img src="metadata/3.jpg" width="30%" />
|
|
<img src="metadata/4.jpg" width="30%" />
|
|
<img src="metadata/5.jpg" width="30%" />
|
|
</div>
|
|
|
|
## Features
|
|
|
|
- [x] Clickable buttons
|
|
- [x] Clean UI
|
|
- [x] Detects current Running app
|
|
- [x] Detects Current Playing media
|
|
- [x] Optional timestamps
|
|
- [x] Custom Status
|
|
- [x] Save/Load presence configs
|
|
- [x] Material You theme
|
|
- [x] Translations
|
|
- [x] Easy [Setup](https://kizzy.gitbook.io/kizzy-docs/setup/setting-up-the-app)
|
|
- [x] Predefined presets(Nintendo,Wii Rpc have 200+ options)
|
|
- [x] Create custom configs with your own images and links
|
|
- [x] Preview Rpc in the app itself
|
|
- [x] Runs in background even when screen is off
|
|
- [x] Gif support
|
|
- [x] External Url support (meaning you can give a url which points to an image on the web and discord will show it!) [How it works ?](https://github.com/dead8309/Kizzy/blob/bd070025f2194ab888f908f7796c6c924555e786/app/src/main/java/com/my/kizzy/rpc/ImageResolver.kt)
|
|
|
|
## Getting Started
|
|
Read the Setup Guide [at Gitbook](https://kizzy.gitbook.io/kizzy-docs/setup/setting-up-the-app)
|
|
or watch the tutorial video
|
|
[](https://www.youtube.com/embed/kjPDMHgsOcU)
|
|
|
|
|
|
## Documentation
|
|
Check out our [Docs](https://kizzy.gitbook.io/kizzy-docs/) at Gitbook
|
|
|
|
|
|
## Build
|
|
For building the app locally
|
|
> Prerequisites:
|
|
- Android Studio
|
|
- Familiar with Gradle, Kotlin, Jetpack Compose
|
|
|
|
> Clone the project
|
|
```console
|
|
git clone https://github.com/dead8309/Kizzy.git
|
|
```
|
|
> Building
|
|
- Open Android Studio
|
|
- Import the project
|
|
- Click on Build and Run
|
|
|
|
> **Warning**
|
|
> This app uses the Discord Gateway connection so this might not be safe. Use this at your own risk.
|
|
However people have been using custom rich presence for past 4-5 years and there's is still no case of account getting terminated.
|
|
|
|
## Translate
|
|
See [Contribute for Translation](https://github.com/dead8309/Kizzy/issues/2#issue-1370365856)
|
|
|
|
|
|
## Credits
|
|
✨ [Read You](https://github.com/Ashinch/ReadYou) and [Seal](https://github.com/JunkFood02/Seal) for Ui Components
|
|
|
|
✨ [md3compat](https://github.com/re-ovo/md3compat) for Material You library
|
|
|
|
✨ [Rich-Presence-U](https://github.com/ninstar/Rich-Presence-U) for Nintendo and Wii U games data
|
|
|
|
✨ [Vlog](https://github.com/girish3/Vlog) for logging library
|
|
|
|
✨ [Xbox-Rich-Presence-Discord](https://github.com/MrCoolAndroid/Xbox-Rich-Presence-Discord) for Xbox games data
|
|
|
|
## Licence
|
|
**Kizzy** is an open source project under the GNU GPL 3.0 Open Source License ①, which allows you to use, reference, and modify the source code of **Kizzy** for free, but does not allow the modified and derived code to be distributed and sold as closed-source commercial software. For details, please see the full GNU GPL 3.0 Open Source License ②.
|
|
|
|
See [Terms Of Service](https://github.com/dead8309/Kizzy/blob/2bd547217688d91e5ee12a294faed477e9d4fa08/TERMS_OF_SERVICE.md) for more info
|