A delightful desktop companion that lives on your screen, helps you stay focused with Pomodoro, and even "eats" your unwanted files!
- Interactive Companions: Multiple pet instances can live on your screen simultaneously.
- Custom Pet Import: Easily import your own custom characters! Just provide a spritesheet and a simple JSON config to bring your own art to life.
- File Eating System: Drag and drop files or folders onto your pet to move them to the Trash/Recycle Bin.
- Pomodoro Timer: Stay productive with a built-in focus timer that communicates through your pet.
- Stay-on-Top: Your pets stay visible above other windows without interfering with your work.
- Smart Click-Through: Pets are normally click-through so you can interact with apps behind them, but they "wake up" when you hover over them.
- Node.js (v16 or higher)
- npm or yarn
-
Clone the repository:
git clone https://github.com/yourusername/minipet.git cd minipet-app -
Install dependencies:
npm install
-
Run in development mode:
npm start
To create a distributable installer for your OS:
npm run makeThe output will be in the out/make directory.
- Framework: Electron
- Bundler: Vite via Electron Forge
- Language: TypeScript
- Graphics: HTML5 Canvas & Vanilla CSS
If you distribute the .dmg file without an Apple Developer certificate, users will see a "Damaged" or "Unidentified Developer" warning.
To fix this, users should run the following command in Terminal:
sudo xattr -cr /Applications/MiniPet.appMiniPet supports custom animations!
- Create a folder in
src/assets/default-pets/. - Add a
spritesheet.pngand apet.jsondefining the animation frames. - Restart the app to see your new friend!
This application only provides tools; we do not own and are not responsible for content/images uploaded by users or linked from external sources.
This project is licensed under the MIT License - see the LICENSE file for details.
Created with ❤️ by QBao