Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thenolle/desktop-pet
A delightful desktop pet that sits on your screen, providing comfort and charm. The pet interacts with you through animations and brings a sense of companionship as you work on your computer.
https://github.com/thenolle/desktop-pet
animations companion cute desktop-pet electron foss open-source
Last synced: 24 days ago
JSON representation
A delightful desktop pet that sits on your screen, providing comfort and charm. The pet interacts with you through animations and brings a sense of companionship as you work on your computer.
- Host: GitHub
- URL: https://github.com/thenolle/desktop-pet
- Owner: TheNolle
- License: other
- Created: 2024-08-14T19:07:00.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-14T19:26:20.000Z (4 months ago)
- Last Synced: 2024-11-27T03:16:10.231Z (26 days ago)
- Topics: animations, companion, cute, desktop-pet, electron, foss, open-source
- Language: JavaScript
- Homepage: https://thenolle.com/
- Size: 156 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# Desktop Pet
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.
## Features
- **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.
## Installation
To install and run Desktop Pet, follow these steps:
1. **Clone the Repository**:
```bash
git clone https://github.com/thenolle/desktop-pet.git
cd desktop-pet
```
2. **Install Dependencies**:
- Recommended: `pnpm install`
- Alternatively: `npm install`
3. **Build the Project**:
- Recommended: `pnpm build`
- Alternatively: `npm run build`
4. **Run the Application**:
- Recommended: `pnpm start`
- Alternatively: `npm start`
## Usage
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.
## Credits
- **Nolly** - [Website](https://thenolle.com) | [GitHub](https://github.com/thenolle) | [Twitter](https://x.com/thenolle_) | [YouTube](https://youtube.com/@_nolly_)
- **Electron** - Framework for building the desktop application.
- **Electron Builder** - Tool for packaging the Electron app.
- **Electron Tray** - Manages the tray icon functionality.
## Contributing
Contributions are welcome! Please feel free to submit issues, fork the project, and create pull requests on [GitHub](https://github.com/thenolle/desktop-pet).
## Contact
For any inquiries or support, you can reach out via:
- **Discord**: Join the [Discord Server](https://discord.com/invite/Fp5vyeJCZF)
- **Email**: [[email protected]](mailto:[email protected]) (please note that responses might be slow)
- **GitHub Issues**: [Submit an Issue](https://github.com/thenolle/desktop-pet/issues)
## Support
If you find this project useful and would like to support its development, consider sponsoring via:
- Patreon: [Become a Patron](https://patreon.com/_nolly)
- Ko-Fi: [Buy me a Coffee](https://ko-fi.com/nolly__)