GoonCord/README.md

40 lines
2.2 KiB
Markdown
Raw Normal View History

2025-05-22 19:44:10 +03:00
# Kettu
2025-04-29 19:10:27 +01:00
A mod for Discord on Android
2023-02-01 18:40:11 +00:00
2025-07-28 21:29:02 +01:00
### [![Discord](https://img.shields.io/discord/1368145952266911755?logo=discord&logoColor=%23ffffffff&color=%231D88CF&link=https%3A%2F%2Fdiscord.gg%2F6cN7wKa8gp)](https://discord.gg/6cN7wKa8gp) [![Static Badge](https://img.shields.io/badge/kofi-cocobo1-%23FF6433?style=flat&logo=ko-fi&labelColor=%23ffffff)](https://www.ko-fi.com/cocobo1) ![GitHub last commit](https://img.shields.io/github/last-commit/c0c0b01/kettu?logo=github)
2025-07-12 16:23:44 +03:00
2023-02-01 18:40:11 +00:00
## Installing
2025-05-22 19:45:29 +03:00
- **Root** with Xposed - [KettuXposed](https://github.com/C0C0B01/KettuXposed/releases/latest)
- **Non-root** - [KettuManager](https://github.com/C0C0B01/KettuManager/releases/latest)
2024-03-01 14:25:43 +08:00
2025-05-24 20:48:54 +03:00
## Support Me
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cocobo1)
2025-05-24 20:49:10 +03:00
2025-05-24 20:48:54 +03:00
Please do not donate if you are not able to, if you are able to please don't donate much :)
2024-03-01 14:25:43 +08:00
## Building
2025-05-22 19:44:10 +03:00
1. Install a Kettu loader with loader config support (any mentioned in the [Installing](#installing) section).
2024-04-30 22:40:03 +08:00
1. Go to Settings > General and enable Developer Settings.
1. Clone the repo:
2024-03-01 14:25:43 +08:00
```
2025-05-22 19:44:10 +03:00
git clone https://github.com/C0C0B01/Kettu
2024-03-01 14:25:43 +08:00
```
2024-04-30 22:40:03 +08:00
1. Install dependencies:
2024-03-01 14:25:43 +08:00
```
pnpm i
```
2025-05-22 19:44:10 +03:00
1. Build Kettu's code:
2024-03-01 14:25:43 +08:00
```
pnpm build
```
2024-04-30 22:40:03 +08:00
1. In the newly created `dist` directory, run a HTTP server. I recommend [http-server](https://www.npmjs.com/package/http-server).
2025-05-27 21:12:30 +03:00
1. Go to Settings > Developer enabled earlier. Enable `Load from custom url` and input the IP address and port of the server (e.g. `http://192.168.1.236:4040/kettu.js`) in the new input box labelled `Kettu URL`.
1. Restart Discord. Upon reload, you should notice that your device will download Kettu's bundled code from your server, rather than GitHub.
2024-04-30 22:40:03 +08:00
1. Make your changes, rebuild, reload, go wild!
2024-03-01 14:25:43 +08:00
2025-05-22 19:44:10 +03:00
Alternatively, you can directly *serve* the bundled code by running `pnpm serve`. `kettu.js` will be served on your local address under the port 4040. You will then insert `http://<local ip address>:4040/kettu.js` as a custom url and reload. Whenever you restart your mobile client, the script will rebuild the bundle as your client fetches it.
2025-05-31 21:42:16 +01:00
## Stargazers
2025-07-08 21:14:22 +01:00
[![Star History Chart](https://api.star-history.com/svg?repos=C0C0B01/Kettu&type=Date)](https://star-history.com/#bytebase/star-history&Date)