Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 贡献指南

[简体中文](./CONTRIBUTING.md) | [English](./CONTRIBUTING_EN.md)

非常感谢您对 BongoCat 的关注和贡献!在您提交贡献之前,请先花一些时间阅读以下指南,以确保您的贡献能够顺利进行。

## 透明的开发
Expand Down
65 changes: 65 additions & 0 deletions .github/CONTRIBUTING_EN.md
Original file line number Diff line number Diff line change
@@ -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!
2 changes: 2 additions & 0 deletions .github/DOWNLOAD_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 下载指南

[简体中文](./DOWNLOAD_GUIDE.md) | [English](./DOWNLOAD_GUIDE_EN.md)

## 系统要求

- macOS 12 或更高版本。
Expand Down
67 changes: 67 additions & 0 deletions .github/DOWNLOAD_GUIDE_EN.md
Original file line number Diff line number Diff line change
@@ -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`
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<div align="center">
<p>
<b>简体中文</b> | <a href="./README_EN.md">English</a>
</p>

<div>
<a href="https://github.com/ayangweb/BongoCat/releases"><img alt="Windows" src="https://img.shields.io/badge/-Windows-blue?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB0PSIxNzI2MzA1OTcxMDA2IiBjbGFzcz0iaWNvbiIgdmlld0JveD0iMCAwIDEwMjQgMTAyNCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHAtaWQ9IjE1NDgiIHdpZHRoPSIxMjgiIGhlaWdodD0iMTI4Ij48cGF0aCBkPSJNNTI3LjI3NTU1MTYxIDk2Ljk3MTAzMDEzdjM3My45OTIxMDY2N2g0OTQuNTEzNjE5NzVWMTUuMDI2NzU3NTN6TTUyNy4yNzU1NTE2MSA5MjguMzIzNTA4MTVsNDk0LjUxMzYxOTc1IDgwLjUyMDI4MDQ5di00NTUuNjc3NDcxNjFoLTQ5NC41MTM2MTk3NXpNNC42NzA0NTEzNiA0NzAuODMzNjgyOTdINDIyLjY3Njg1OTI1VjExMC41NjM2ODE5N2wtNDE4LjAwNjQwNzg5IDY5LjI1Nzc5NzUzek00LjY3MDQ1MTM2IDg0Ni43Njc1OTcwM0w0MjIuNjc2ODU5MjUgOTE0Ljg2MDMxMDEzVjU1My4xNjYzMTcwM0g0LjY3MDQ1MTM2eiIgcC1pZD0iMTU0OSIgZmlsbD0iI2ZmZmZmZiI+PC9wYXRoPjwvc3ZnPg==" /></a>
<a href="https://github.com/ayangweb/BongoCat/releases"><img alt="MacOS" src="https://img.shields.io/badge/-MacOS-black?style=flat-square&logo=apple&logoColor=white" /></a>
Expand Down
155 changes: 155 additions & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -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)

<div align="center">
<p>
<a href="./README.md">简体中文</a> | <b>English</b>
</p>

<div>
<a href="https://github.com/ayangweb/BongoCat/releases"><img alt="Windows" src="https://img.shields.io/badge/-Windows-blue?style=flat-square&logo=data:image/svg+xml;base64,PHN2ZyB0PSIxNzI2MzA1OTcxMDA2IiBjbGFzcz0iaWNvbiIgdmlld0JveD0iMCAwIDEwMjQgMTAyNCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHAtaWQ9IjE1NDgiIHdpZHRoPSIxMjgiIGhlaWdodD0iMTI4Ij48cGF0aCBkPSJNNTI3LjI3NTU1MTYxIDk2Ljk3MTAzMDEzdjM3My45OTIxMDY2N2g0OTQuNTEzNjE5NzVWMTUuMDI2NzU3NTN6TTUyNy4yNzU1NTE2MSA5MjguMzIzNTA4MTVsNDk0LjUxMzYxOTc1IDgwLjUzMjA4MDQ5di00NTUuNjc3NDcxNjFoLTQ5NC41MTM2MTk3NXpNNC42NzA0NTEzNiA0NzAuODMzNjgyOTdINDIyLjY3Njg1OTI1VjExMC41NjM2ODE5N2wtNDE4LjAwNjQwNzg5IDY5LjI1Nzc5NzUzek00LjY3MDQ1MTM2IDg0Ni43Njc1OTcwM0w0MjIuNjc2ODU5MjUgOTE0Ljg2MDMxMDEzVjU1My4xNjYzMTcwM0g0LjY3MDQ1MTM2eiIgcC1pZD0iMTU0OSIgZmlsbD0iI2ZmZmZmZiI+PC9wYXRoPjwvc3ZnPg==" /></a>
<a href="https://github.com/ayangweb/BongoCat/releases"><img alt="MacOS" src="https://img.shields.io/badge/-MacOS-black?style=flat-square&logo=apple&logoColor=white" /></a>
<a href="https://github.com/ayangweb/BongoCat/releases"><img alt="Linux" src="https://img.shields.io/badge/-Linux-yellow?style=flat-square&logo=linux&logoColor=white" /></a>
</div>

<p>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/ayangweb/BongoCat?style=flat-square" /></a>
<a href="https://github.com/ayangweb/BongoCat/releases/latest"><img src="https://img.shields.io/github/package-json/v/ayangweb/BongoCat?style=flat-square"/></a>
<a href="https://github.com/ayangweb/BongoCat/releases"><img src="https://img.shields.io/github/downloads/ayangweb/BongoCat/total?style=flat-square"/></a>
</p>

<p>
<a href="https://trendshift.io/developers/8507" target="_blank"><img src="https://trendshift.io/api/badge/developers/8507" alt="ayangweb | Trendshift" width="250" height="55" /></a>
<a href="https://trendshift.io/repositories/14605" target="_blank"><img src="https://trendshift.io/api/badge/repositories/14605" alt="ayangweb%2FBongoCat | Trendshift" width="250" height="55" /></a>
<a href="https://hellogithub.com/repository/7d23863fd4be47b39e816193ded385c9" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=7d23863fd4be47b39e816193ded385c9&claim_uid=5ihRVIuTYBmSGtQ&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=7d23863fd4be47b39e816193ded385c9&claim_uid=5ihRVIuTYBmSGtQ&theme=neutral" />
<img alt="Star History Chart" src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=7d23863fd4be47b39e816193ded385c9&claim_uid=5ihRVIuTYBmSGtQ&theme=neutral" width="250" height="55" />
</picture>
</a>
</p>
</div>

| 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

<a href="https://www.toolsetlink.com">
<img height="54" alt="UpgradeLink" src="https://github.com/user-attachments/assets/6b84fb0f-3f1d-44b5-9932-2298bc999d8d" />
</a>

## 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_EN.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

<table>
<thead>
<tr>
<th>QQ Group 1</th>
<th>QQ Group 2</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://qm.qq.com/q/AS3gNv2Vzy">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://i0.hdslb.com/bfs/openplatform/8ecdc4982ab01b59d7731fcca3ec26631a274560.png"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://i0.hdslb.com/bfs/openplatform/09f56580397063e1819c4c2ed63d07dee12720e1.png"
/>
<img
alt="QQ Group 1"
src="https://i0.hdslb.com/bfs/openplatform/09f56580397063e1819c4c2ed63d07dee12720e1.png"
height="250"
/>
</picture>
</a>
</td>
<td>
<a href="https://qm.qq.com/q/TmltLAod2O">
<picture>
<source
media="(prefers-color-scheme: dark)"
srcset="https://i0.hdslb.com/bfs/openplatform/473c522487ff33e0f32b15466aeb0734f17161c8.png"
/>
<source
media="(prefers-color-scheme: light)"
srcset="https://i0.hdslb.com/bfs/openplatform/d5ae8c5af6ae1d0a1f066705ee822d1287384cf6.png"
/>
<img
alt="QQ Group 2"
src="https://i0.hdslb.com/bfs/openplatform/d5ae8c5af6ae1d0a1f066705ee822d1287384cf6.png"
height="250"
/>
</picture>
</a>
</td>
</tr>
</tbody>
</table>

## Support Us

Every bit of appreciation is cherished! Sponsorship is optional, but support is priceless. Thank you for your support ❤️

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://i0.hdslb.com/bfs/openplatform/e7438bff14cdfb6bfd0feacbb482f99ea4093294.png" />
<source media="(prefers-color-scheme: light)" srcset="https://i0.hdslb.com/bfs/openplatform/da55cc3ec1556580c91e59f589792866c998c7c6.png" />
<img alt="WeChat Sponsor QR Code" src="https://i0.hdslb.com/bfs/openplatform/da55cc3ec1556580c91e59f589792866c998c7c6.png" height="250" />
</picture>

## 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_EN.md).

<a href="https://openomy.com/ayangweb/BongoCat" target="_blank" style="display: block; width: 100%;" align="center">
<img src="https://openomy.com/svg?repo=ayangweb/BongoCat&chart=bubble" alt="Contribution Leaderboard" style="display: block; width: 100%;" />
</a>

## Star History

<a href="https://www.star-history.com/#ayangweb/BongoCat&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=ayangweb/BongoCat&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=ayangweb/BongoCat&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=ayangweb/BongoCat&type=Date" />
</picture>
</a>