FrontEngine
About
FrontEngine is a lightweight and flexible framework designed to simplify automation and visualization tasks.
It provides an intuitive interface and supports multiple media formats for interactive demonstrations.
Features
-
GIFs & Animations
(GIFs may take time to load)
-
Video
-
Website
-
YouTube Showcase
Watch on YouTube
Desktop pet
Spawn an animated sprite that lives on your desktop, from the Pet tab.
- Sprites — pick a single GIF/WebP/PNG, or a pet pack folder whose file
names map to states:
walk,idle,sleep,climb,fall,drag(missing states fall back towalk). - Behaviour — walk on the floor with gravity (throw it and it bounces), wander freely, or chase the cursor. Floor pets can climb screen edges and stand on the top edge of other windows.
- Life — mood, fullness and an affection level that persist between runs; the pet grows as it levels up, chats in speech bubbles, naps while you are away, and warns you about a low battery.
- Interaction — drag it around, right-click to clone/feed/set a reminder, and drop a file onto it: an image or pet pack becomes its new look, anything else is eaten. What it eats matters — an archive is a feast, music cheers it up more than it fills, a document is a modest meal, and a binary is too hard to chew.
- Tag — with two or more pets on screen, tick Play tag with each other and one becomes "it": it walks toward its nearest neighbour while the others run the other way, and catching someone passes the tag on.
- React to audio — the pet pulses to your speakers' output level. It reads
only the Windows output meter (WASAPI
IAudioMeterInformation); no audio is captured or recorded. Peaks are smoothed with an RMS window and a fast-attack/slow-decay envelope so the pulse breathes instead of flickering. On multi-monitor setups each pet follows the audio endpoint that matches its own screen, falling back to the default output device.
Audio features are Windows-only and degrade to "no pulse" elsewhere.
Focus
Two overlays for when the screen is competing with your work, both on the Focus tab:
- Dim background windows — everything except the window you are working in is shaded, at an adjustable strength. Off Windows, where the active window cannot be identified without a native binding, it shades the whole screen.
- Cover a distraction — mask a strip of the screen: the taskbar, a notification corner, an edge, or all of it.
Both pass clicks through, so what they cover still works — it just stops pulling your eye.
Wallpaper
Play a folder of images and animations beneath every window, from the Wallpaper tab:
- A playlist per monitor — each screen points at its own folder, changes on its own timer, and can be shuffled or read recursively.
- React to audio — the wallpaper can pulse with your speakers' output level, using the same meter-only reading as the pet (no audio is captured).
Community content
-
Steam Workshop — subscribed items are picked up from Steam's own
steamapps/workshop/contentfolder: presets are imported and pet packs are listed with their paths, from Presets → Import Workshop content. Publishing to the Workshop needs the Steamworks SDK and is not built in. -
Plugins — a
plugins/folder can add its own tabs, either through aFRONTENGINE_TABSmapping or aregister(registry)hook.A plugin is Python and runs with the same privileges as FrontEngine — it cannot be sandboxed. Loading is off by default (Settings → Load plugins), every load is logged, and one broken plugin is skipped rather than stopping the app. Only install plugins you trust.
Install
-
System Requirements
- Python 3.10+
- Windows 10/11 is the primary target; macOS and Linux are supported but may need extra OS dependencies.
-
From PyPI
pip install frontengine
-
Pre-built binaries
Development
- Requires Python 3.10+.
- Install the dev toolchain:
pip install -r dev_requirements.txt pip install -e .
- Run the unit smoke tests:
python ./tests/unit_test/start/start_front_engine.py python ./tests/unit_test/start/extend_front_engine.py
- Contributions and pull requests are welcome!
Continuous Integration & Release
This repository ships two GitHub Actions workflows:
| Workflow | Trigger | Purpose |
|---|---|---|
CI (.github/workflows/ci.yml) |
Push / PR to main or dev, daily cron |
Matrix smoke test across Python 3.10 / 3.11 / 3.12 on Windows |
Release (.github/workflows/release.yml) |
A pull request is merged into main (or manual dispatch) |
Auto-bumps the version in stable.toml/pyproject.toml, commits the bump back to main, swaps stable.toml → pyproject.toml, builds sdist + wheel, uploads to PyPI as frontengine via twine, creates a GitHub release tagged v<version> |
Publishing only happens on merge to main — pushing to dev runs CI but
never publishes. On merge, the workflow automatically bumps the patch
segment of the version (configurable via manual dispatch: patch / minor
/ major), commits the bump back to main with [skip ci], then builds,
uploads, and releases under the new version. Both the PyPI upload and the
GitHub release see the bumped version, not the previous one.
Cutting a new release
- Merge a pull request into
main— the patch version bumps automatically. - That's it. PyPI publish and GitHub release happen in one workflow run.
For a minor or major bump, trigger the workflow manually via Actions →
Release → Run workflow and pick the bump segment. That path also works
when you need to re-run a failed publish without a new merge.
Required repository secrets
| Secret | Used by | Contents |
|---|---|---|
PYPI_API_TOKEN |
release.yml |
A PyPI API token scoped to the frontengine project |
The workflow uses __token__ as the twine username, so only the token itself
needs to be stored.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file frontengine-1.0.34.tar.gz.
File metadata
- Download URL: frontengine-1.0.34.tar.gz
- Upload date:
- Size: 192.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4100cc28c9c0722d5777456e9de11d1a06406680469d14bc4df9786d6ea63ebb
|
|
| MD5 |
465cf7ed0f851c4dd3c2aae55b2bcf69
|
|
| BLAKE2b-256 |
d7f931e010a921bb76c790c4b14c9b2c1265ba9a90a64fc05968d63e8042c6d3
|
File details
Details for the file frontengine-1.0.34-py3-none-any.whl.
File metadata
- Download URL: frontengine-1.0.34-py3-none-any.whl
- Upload date:
- Size: 256.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0df2989a911d5856cb25154092cccbe1ac5cff5dc52880a13e8f1b73710b3664
|
|
| MD5 |
23b5cb0e5455ebb1f916a69f8e2a771c
|
|
| BLAKE2b-256 |
9591bf8f7437da0a9fe51041076062d8c9bb8b3ec0688d76f134b2cb20131e19
|
