Welcome to Desktop Pet, a charming and delightful companion that sits on your desktop, providing comfort and joy as you work. This little pet doesn't just decorate your screen; it becomes a small but meaningful presence, bringing warmth to your daily tasks.
- Adorable Pet Animations: Watch as your desktop pet performs various animations, making it feel alive.
- Tray Icon Interactions: Manage your pet's actions through a tray icon. Start, stop, and interact with your pet effortlessly.
- Customizable: Modify the pet's behaviors and add new animations as you see fit.
To install and run Desktop Pet, follow these steps:
- Clone the Repository:
git clone https://github.com/thenolle/desktop-pet.git
cd desktop-pet- Install Dependencies:
- Recommended:
pnpm install - Alternatively:
npm install
- Build the Project:
- Recommended:
pnpm build - Alternatively:
npm run build
- Run the Application:
- Recommended:
pnpm start - Alternatively:
npm start
Once started, the Desktop Pet will appear on your screen. The pet is currently decorative and interacts with you through its animations. Use the tray icon (accessible through left or right-click) to control and interact with the pet.
- Nolly - Website | GitHub | Twitter | YouTube
- Electron - Framework for building the desktop application.
- Electron Builder - Tool for packaging the Electron app.
- Electron Tray - Manages the tray icon functionality.
Contributions are welcome! Please feel free to submit issues, fork the project, and create pull requests on GitHub.
For any inquiries or support, you can reach out via:
- Discord: Join the Discord Server
- Email: nolly.berrebi@gmail.com (please note that responses might be slow)
- GitHub Issues: Submit an Issue
If you find this project useful and would like to support its development, consider sponsoring via:
- Patreon: Become a Patron
- Ko-Fi: Buy me a Coffee