WindowPet

Pet overlay app built with tauri and react that lets you have adorable companion such as pets, anime characters on your screen. Available on Windows, Macos, and Linux.

✨ Features

Add pets (45+ pets and characters available to choose from)
Add your own custom pet
Remove pets
Pixel perfect drag pets on your screen
Click through pets
Auto start up
Auto update
Allow as many pet/character as you want on your screen without any performance issue
Pet above taskbar
Settings window
- Language support: English and Khmer
- Dark mode and light mode (settings window)
- Allow user to select state to see pet animation

✨ Demo

WindowPet.demo.mp4

✨ Download

Download the latest version here
- Windows: .exe, .msi
- MacOS: .dmg
- Linux: .AppImage, .deb

✨ Development

Clone the repo
Install rust and tauri refer to this link
Install dependencies

npm install

✨ Run & Build

Run the project

 npm run tauri dev

Build the project

 npm run tauri build --release

Notice:
- for build release we use github actions to build the project and upload the build to github release. You can check the build workflow here
- for local build you have to generate your own signing key and replace the signing key in tauri.conf.json refer to tauri doc

✨ Contribute

Feel free to open an issue or pull request if you have any idea or found any bug
If you want to support me, you can buy me a coffee

✨ Inspiration

My friend Blizzard4E for suggesting me this project idea
vscode-pets
Shimeji-ee Desktop Pet
DPET : Desktop Pet Engine

✨ License

Doesn't work correctly on linux

It works fine on windows(baremetal/vm), however I cannot run on linux.
Env: NixOS(Gnome X11/Wayland AppImage-version baremetal)
, PopOS(Cosmic/Gnome Wayland AppImage-version vm)
, Debian(KDE Wayland deb-version vm)

NixOS derivation

{ lib, fetchurl, appimageTools }:

let
  pname = "window-pet";
  version = "0.0.7";
  name = "${pname}-${version}";

  src = fetchurl {
    url = "https://github.com/SeakMengs/WindowPet/releases/download/v${version}/window-pet_${version}_amd64.AppImage";
    hash = "sha256-Sdyb4+3nPmWu8/6Mb9ZP8N6OclVBIdHcTgqlNOl9sww=";
  };
  appimageContents = appimageTools.extract { inherit name src; };
in appimageTools.wrapType2 rec {
  inherit name src;

  extraInstallCommands = ''
    mv $out/bin/{${name},${pname}}

    install -m 444 \
        -D ${appimageContents}/${pname}.desktop \
        -t $out/share/applications
    substituteInPlace \
        $out/share/applications/${pname}.desktop \
        --replace 'Exec=AppRun' 'Exec=${pname}'
    cp -r ${appimageContents}/usr/share/icons $out/share
  '';

  meta = with lib; {
    description = "Pet overlay app built with tauri and react that lets you have adorable companion such as pets, anime characters on your screen.";
    homepage = "https://github.com/SeakMengs/WindowPet";
    license = licenses.mit;
    platforms = [ "x86_64-linux" ];
    maintainers = [ maintainers.ravenz46 ];
    mainProgram = "window-pet";
  };
}

Error on X11

EGLDisplay Initialization failed: EGL_NOT_INITIALIZED
Cannot create EGL context: invalid display (last error: EGL_SUCCESS)

Error on NixOS wayland

libEGL warning: egl: failed to create dri2 screen
[2024-02-03][06:20:10][INFO][window_pet] app started
libEGL warning: egl: failed to create dri2 screen

(WebKitWebProcess:13037): GStreamer-WARNING **: 15:20:12.036: External plugin loader failed. This most likely means that the plugin loader helper binary was not found or could not be run. You might need to set the GST_PLUGIN_SCANNER environment variable if your setup is unusual. This should normally not be required though.
[2024-02-03][06:20:12][INFO][ih@tauri://localhost/assets/index-uWxEQdZc.js:87:50814] Pets scene loaded
[2024-02-03][06:20:12][INFO][ih@tauri://localhost/assets/index-uWxEQdZc.js:87:50814] Pets scene loaded

Error on PopOS and Debian wayland

libEGL warning: egl: failed to create dri2 screen
libEGL warning: egl: failed to create dri2 screen
[2024-02-03][08:38:23][INFO][window_pet] app started
libEGL warning: egl: failed to create dri2 screen
[2024-02-03][08:38:25][INFO][ih@tauri://localhost/assets/index-uWxEQdZc.js:87:50814] Pets scene loaded
[2024-02-03][08:38:25][INFO][ih@tauri://localhost/assets/index-uWxEQdZc.js:87:50814] Pets scene loaded

seakmengs / windowpet Goto Github PK

windowpet's Introduction

WindowPet

✨ Features

✨ Demo

✨ Download

✨ Development

✨ Run & Build

✨ Contribute

✨ Inspiration

✨ License

windowpet's People

Contributors

Stargazers

Watchers

Forkers

windowpet's Issues

Recommend Projects

Recommend Topics

Recommend Org