From 0fe1d225fca74ee3915a5e980ffef4f0adfe3f65 Mon Sep 17 00:00:00 2001 From: HARSHRAO729 Date: Fri, 14 Aug 2026 14:56:42 +0530 Subject: [PATCH 1/3] docs: add English translation for README and update language links --- README.md | 4 ++ README_EN.md | 155 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 159 insertions(+) create mode 100644 README_EN.md diff --git a/README.md b/README.md index 14bdd5466..9cf5132d5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ ![BongoCat](https://socialify.git.ci/ayangweb/BongoCat/image?custom_description=&description=1&font=Source+Code+Pro&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2Fayangweb%2FBongoCat%2Fblob%2Fmaster%2Fsrc-tauri%2Fassets%2Flogo-mac.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)
+

+ 简体中文 | English +

+
Windows MacOS diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 000000000..242246baf --- /dev/null +++ b/README_EN.md @@ -0,0 +1,155 @@ +![BongoCat](https://socialify.git.ci/ayangweb/BongoCat/image?custom_description=&description=1&font=Source+Code+Pro&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2Fayangweb%2FBongoCat%2Fblob%2Fmaster%2Fsrc-tauri%2Fassets%2Flogo-mac.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto) + +
+

+ 简体中文 | English +

+ +
+ Windows + MacOS + Linux +
+ +

+ + + +

+ +

+ ayangweb | Trendshift + ayangweb%2FBongoCat | Trendshift + + + + + Star History Chart + + +

+
+ +| macOS | Windows | Linux(x11) | +| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| ![macOS](https://i0.hdslb.com/bfs/openplatform/dff276b96d49c5d6c431b74b531aab72191b3d87.png) | ![Windows](https://i0.hdslb.com/bfs/openplatform/a4149b753856ee7f401989da902cf3b5ad35b39e.png) | ![Linux](https://i0.hdslb.com/bfs/openplatform/3b49f961819d3ff63b2b80251c1cc13c27e986b0.png) | + +## Sponsors + + + UpgradeLink + + +## Background + +This project was inspired by [Bongo-Cat-Mver](https://github.com/MMmmmoko/Bongo-Cat-Mver), created by [MMmmmoko](https://github.com/MMmmmoko). It is widely loved by users for its unique interactive cat features, but it only supports Windows. As an avid macOS user, I really wanted to use this cute cat on my own device, so I decided to build a version tailored for macOS. + +Furthermore, thanks to the powerful cross-platform capabilities of [Tauri](https://github.com/tauri-apps/tauri), this project supports not only macOS, but is also compatible with Windows and Linux (X11), allowing even more users to enjoy interacting with this adorable cat! + +## Download + +- [Quark Netdisk](https://pan.quark.cn/s/70f2f2663ce1) +- [GitHub Releases](https://github.com/ayangweb/BongoCat/releases) + +Not sure which one to download? Please refer to the [Download Guide](.github/DOWNLOAD_GUIDE.md). + +## Features + +- Compatible with macOS, Windows, and Linux (X11). +- Synchronizes corresponding cat movements based on keyboard, mouse, or gamepad operations. +- Supports importing custom models so you can build your own cat avatar. +- Fully open-source with transparent code—never collects any user data. +- Supports offline mode with no internet connection required, protecting user privacy. + +## Model Conversion + +If you want to convert models from Bongo-Cat-Mver into a format compatible with BongoCat, you can use the following tool: + +🔗 [Online Converter](https://bongocat.vteamer.cc) + +## More Models + +You can explore and download more cat models in this repository, or submit your own creations to share with everyone: + +📦 [Awesome-BongoCat](https://github.com/ayangweb/Awesome-BongoCat) + +## Community + + + + + + + + + + + + + + +
QQ Group 1QQ Group 2
+ + + + + QQ Group 1 + + + + + + + + QQ Group 2 + + +
+ +## Support Us + +Every bit of appreciation is cherished! Sponsorship is optional, but support is priceless. Thank you for your support ❤️ + + + + + WeChat Sponsor QR Code + + +## Contributing + +Thank you to everyone who has made valuable contributions to BongoCat! If you would like to contribute to BongoCat as well, please check out the [Contribution Guide](.github/CONTRIBUTING.md). + + + Contribution Leaderboard + + +## Star History + + + + + + Star History Chart + + From e5f62f77b77dd446966a19da304ee38ceb54c604 Mon Sep 17 00:00:00 2001 From: HARSHRAO729 Date: Fri, 14 Aug 2026 14:59:52 +0530 Subject: [PATCH 2/3] docs: add English contribution guide and update README link --- .github/CONTRIBUTING.md | 2 ++ .github/CONTRIBUTING_EN.md | 65 ++++++++++++++++++++++++++++++++++++++ README_EN.md | 2 +- 3 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 .github/CONTRIBUTING_EN.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9b62ff4b8..a4509ca52 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,7 @@ # 贡献指南 +[简体中文](./CONTRIBUTING.md) | [English](./CONTRIBUTING_EN.md) + 非常感谢您对 BongoCat 的关注和贡献！在您提交贡献之前，请先花一些时间阅读以下指南，以确保您的贡献能够顺利进行。 ## 透明的开发 diff --git a/.github/CONTRIBUTING_EN.md b/.github/CONTRIBUTING_EN.md new file mode 100644 index 000000000..8c0113fbd --- /dev/null +++ b/.github/CONTRIBUTING_EN.md @@ -0,0 +1,65 @@ +# Contribution Guide + +[简体中文](./CONTRIBUTING.md) | [English](./CONTRIBUTING_EN.md) + +Thank you very much for your interest and contributions to BongoCat! Before submitting a contribution, please take a moment to read the following guidelines to ensure a smooth contribution process. + +## Transparent Development + +All work is conducted publicly on GitHub. Pull Requests from both core team members and external contributors follow the exact same code review process. + +## Submitting Issues + +We use [GitHub Issues](https://github.com/ayangweb/BongoCat/issues) for bug reports and new feature suggestions. Before submitting an issue, please ensure you have searched for existing similar issues, as they may have already been answered or are currently being addressed. For bug reports, please include full steps to reproduce the issue. For feature requests, please specify the changes you would like to see and the expected behavior. + +## Submitting Pull Requests + +### Collaboration Workflow + +- **Claim an issue**: Create or claim an existing Issue on GitHub to let everyone know you are working on it, avoiding duplicated effort. +- **Development**: Complete your setup and work on bug fixes or feature development. +- **Submit PR**: Open a Pull Request for review. + +### Prerequisites + +- [Rust](https://v2.tauri.app/start/prerequisites/): Please follow the official guide to install the Rust environment. +- [Node.js](https://nodejs.org/en/): Required to run the project. +- [Pnpm](https://pnpm.io/): This project uses pnpm for package management. + +### Install Dependencies + +```shell +pnpm install +``` + +### Start Application + +```shell +pnpm tauri dev +``` + +### Build Application + +> If you need to debug after building, add `--debug` to the command below: + +```shell +pnpm tauri build +``` + +## Commit Guidelines + +Commit messages must follow the [conventional-changelog specification](https://www.conventionalcommits.org/en/v1.0.0/). + +### Commit Types + +Here is the list of supported commit types: + +- `feat`: A new feature +- `fix`: A bug fix +- `docs`: Documentation updates +- `style`: Code style updates +- `refactor`: Code refactoring without adding new features or fixing bugs +- `perf`: Performance improvements +- `chore`: Other maintenance tasks + +We look forward to your contributions—let's make BongoCat better together! diff --git a/README_EN.md b/README_EN.md index 242246baf..1d0ff6b97 100644 --- a/README_EN.md +++ b/README_EN.md @@ -138,7 +138,7 @@ Every bit of appreciation is cherished! Sponsorship is optional, but support is ## Contributing -Thank you to everyone who has made valuable contributions to BongoCat! If you would like to contribute to BongoCat as well, please check out the [Contribution Guide](.github/CONTRIBUTING.md). +Thank you to everyone who has made valuable contributions to BongoCat! If you would like to contribute to BongoCat as well, please check out the [Contribution Guide](.github/CONTRIBUTING_EN.md). Contribution Leaderboard From ca982956eab18a650b86a0c0d07b8710d57f307c Mon Sep 17 00:00:00 2001 From: HARSHRAO729 Date: Fri, 14 Aug 2026 15:02:26 +0530 Subject: [PATCH 3/3] docs: add English download guide and language switcher --- .github/DOWNLOAD_GUIDE.md | 2 ++ .github/DOWNLOAD_GUIDE_EN.md | 67 ++++++++++++++++++++++++++++++++++++ README_EN.md | 2 +- 3 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 .github/DOWNLOAD_GUIDE_EN.md diff --git a/.github/DOWNLOAD_GUIDE.md b/.github/DOWNLOAD_GUIDE.md index cf6af33bc..ddab0096c 100644 --- a/.github/DOWNLOAD_GUIDE.md +++ b/.github/DOWNLOAD_GUIDE.md @@ -1,5 +1,7 @@ # 下载指南 +[简体中文](./DOWNLOAD_GUIDE.md) | [English](./DOWNLOAD_GUIDE_EN.md) + ## 系统要求 - macOS 12 或更高版本。 diff --git a/.github/DOWNLOAD_GUIDE_EN.md b/.github/DOWNLOAD_GUIDE_EN.md new file mode 100644 index 000000000..c118db451 --- /dev/null +++ b/.github/DOWNLOAD_GUIDE_EN.md @@ -0,0 +1,67 @@ +# Download Guide + +[简体中文](./DOWNLOAD_GUIDE.md) | [English](./DOWNLOAD_GUIDE_EN.md) + +## System Requirements + +- macOS 12 or higher. +- Windows 10 or higher. +- Linux with X11 environment. + +## macOS + +### Manual Download + +- Apple Silicon: Download `BongoCat_aarch64.dmg` +- Intel Chip: Download `BongoCat_x64.dmg` + +### Homebrew Download + +1. Add BongoCat tap repository: + +```bash +brew tap ayangweb/BongoCat +``` + +2. Install: + +```bash +brew install --no-quarantine bongo-cat +``` + +3. Update: + +```bash +brew upgrade bongo-cat +``` + +4. Uninstall: + +```bash +brew uninstall --cask bongo-cat + +brew untap ayangweb/BongoCat +``` + +## Windows + +- 64-bit architecture: Download `BongoCat_x64.exe` +- 32-bit architecture: Download `BongoCat_x86.exe` +- ARM64 architecture: Download `BongoCat_arm64.exe` + +## Linux (X11) + +### Manual Download + +- 64-bit architecture: + - Debian / Ubuntu: Download `BongoCat_amd64.deb` + - Fedora / RHEL: Download `BongoCat_x86_64.rpm` + - Universal format: Download `BongoCat_amd64.AppImage` +- ARM64 architecture: + - Debian / Ubuntu: Download `BongoCat_arm64.deb` + - Fedora / RHEL: Download `BongoCat_aarch64.rpm` + - Universal format: Download `BongoCat_aarch64.AppImage` + +### AUR Download + +- Manjaro / Arch Linux: `yay -S bongo-cat` diff --git a/README_EN.md b/README_EN.md index 1d0ff6b97..eaee2833f 100644 --- a/README_EN.md +++ b/README_EN.md @@ -51,7 +51,7 @@ Furthermore, thanks to the powerful cross-platform capabilities of [Tauri](https - [Quark Netdisk](https://pan.quark.cn/s/70f2f2663ce1) - [GitHub Releases](https://github.com/ayangweb/BongoCat/releases) -Not sure which one to download? Please refer to the [Download Guide](.github/DOWNLOAD_GUIDE.md). +Not sure which one to download? Please refer to the [Download Guide](.github/DOWNLOAD_GUIDE_EN.md). ## Features