xpet-fork/README.md
2025-11-04 14:59:39 -05:00

55 lines
670 B
Markdown

![](xpet_logo_10x.png)
#### xpet is a small desktop pet for x11 written in c
---
## build
dependencies:
* Xlib
* Xext
* Xpm
build with:
```
make
```
you can edit `config.h` before building to change behavior or key bindings.
Run with:
```
./xpet
```
---
## image structure
Animation frames are stored as XPM files under `PET_ASSET_DIR`, grouped by state name.
example:
```
neko/
idle/
0.xpm
...
5.xpm
sleeping/
0.xpm
...
5.xpm
walk_north/
0.xpm
1.xpm
...
```
each directory name matches an animation state defined in `xpet.h`.
frames are loaded in numeric order (`0.xpm`, `1.xpm`, ...) until no more are found