https://github.com/spikehd/deppo
Highly customizable desktop companion engine!
https://github.com/spikehd/deppo
companion desktop interactive pet
Last synced: 8 months ago
JSON representation
Highly customizable desktop companion engine!
- Host: GitHub
- URL: https://github.com/spikehd/deppo
- Owner: SpikeHD
- License: gpl-3.0
- Created: 2024-06-20T01:02:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-25T21:12:18.000Z (10 months ago)
- Last Synced: 2025-02-02T05:02:52.528Z (8 months ago)
- Topics: companion, desktop, interactive, pet
- Language: Rust
- Homepage:
- Size: 530 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Table of Contents
* [Table of Contents](#table-of-contents)
* [Download](#download)
* [What is Deppo?](#what-is-deppo)
* [Demonstration](#demonstration)
* [Video Demo](#video-demo)
* [Screenshots](#screenshots)
* [Quickstart](#quickstart)
* [Make your own!](#make-your-own)
* [Building](#building)
* [Requirements](#requirements)
* [Steps](#steps)
* [TODO](#todo)
* [Contributing](#contributing)
# Download
~~All downloads can be found on the [releases page](https://github.com/SpikeHD/Deppo/releases). If you're unsure, download the **Windows x86** version.~~
Deppo is still in development, but you can test it using the following links!
# What is Deppo?
Deppo is a highly customizable desktop companion engine! With Deppo, you can use, create, and share little friends that live on your computer screen, all while using minimal resources. Deppos can move around, be dragged, and even thrown around!
Deppos are not just critters of course. With Deppo, you can also display regular GIFs or images on your screen with very little effort. You can configure and disable movement behaviours, drag-ability, and everything else you may or may not want.
# Demonstration
## Video Demo
(Excuse the programmer art)
## Screenshots
Deppos hang out anywhere on your screen, and sit right on your taskbar, if you let them!
Deppos can also be static images!
(If somebody knows the artist, let me know and I'll credit them here)
# Quickstart
1. After downloading Deppo and opening it for the first time, you will be greeted with a menu.
2. Click "Open Deppos Folder" to open the folder where Deppos are stored. **This is where you put folders/zip files
containing each Deppo!**
3. When you add Deppos, restart the program and you should see them listed. **Click on one, then restart the program again!**
# Make Your Own!
You can find a comprehesive guide and reference for creating your own Deppo in the [CREATING.md](CREATING.md) file.
# Building
## Requirements
* [Rust and Cargo](https://www.rust-lang.org/tools/install)
## Steps
1. Clone the repository
2. Run `cargo build --release`
3. The built binary will be in `target/release`
# TODO
* [ ] Transition animations
* [x] Single-file loading (basically just renamed `.zip` files)
* [x] "Throwing" with mouse drag
* [x] UI for choosing Deppos
* [x] Configuration options
* [ ] Click behaviour
* [ ] ARM Linux support
* [ ] Example Deppos
* [x] Always-on-top
* [ ] Stop/minimize when fullscreen app is running
* [ ] More documentation
# Contributing
Issues, PRs, etc. are all welcome!