Skip to content

yono-code/PetLimitBars

Repository files navigation

Pet Limit Bars

Language: English | 日本語 | 简体中文 | 繁體中文 | 한국어 | Español | Français | Deutsch | Português | Italiano | Русский

See CHANGELOG.md for release notes.

Pet Limit Bars is an unofficial Windows companion app that shows Codex pet usage limits as small bars above the pet.

This project is unofficial. It is not affiliated with, endorsed by, sponsored by, or approved by OpenAI.

Install For Most Users

Prerequisite:

Install:

  1. Download PetLimitBars-win-x64.zip from the latest GitHub Release.
  2. Right-click the zip and choose Extract All....
  3. Open the extracted folder.
  4. Right-click install-windows.ps1 and choose Run with PowerShell.
  5. If PowerShell asks for confirmation, approve the script.
  6. Pet Limit Bars starts and adds itself to your per-user startup entries.

Installed location:

%LOCALAPPDATA%\PetLimitBars\app

Uninstall from the extracted folder or installed app folder:

uninstall-windows.ps1
uninstall-windows.ps1 -RemoveSettings

The installer does not require administrator rights.

Using The App

Pet Limit Bars appears in the Windows notification area as Pet Limit Bars (Unofficial).

Common actions:

  • Open Controls: show/hide bars and toggle Live usage.
  • Enable Live Usage: opt in to fresher live usage values.
  • Refresh Now: refresh usage data.
  • Open Diagnostics: inspect current source, values, and local file availability.
  • Quit Pet Limit Bars: stop the app.

Cached And Live Modes

Pet Limit Bars has two usage-data modes:

Mode Default Network Token access Notes
Cached Yes None None Reads the newest local codex.rate_limits event from logs_2.sqlite / logs_1.sqlite. This is lower risk, but can lag behind the current live value until Codex writes a new event.
Live No Yes Reads the local Codex access token just in time Gives fresher numbers. The first time you enable it, the app shows a consent popup explaining the request and asking for permission. The token is not stored by this app.

Open the Windows notification area icon menu and choose Open Controls to switch modes. You can also toggle Enable Live Usage directly from the tray menu. If you cancel the first consent popup, Live mode remains off.

Live Mode Stability

Live mode depends on Codex/ChatGPT usage data that may change with official app or service updates. If that happens, Live mode may stop working until this project is updated.

For that reason, Live mode is off by default, requires first-use consent, and can be turned off at any time. Cached mode does not use Live usage requests.

Developer Setup

You need the .NET SDK only if you want to build from source.

Prerequisites:

  • .NET 10 SDK
  • Git
  • GitHub CLI, if publishing releases

Commands:

tools\build-windows.ps1
tools\test-windows.ps1
tools\run-windows.ps1

The scripts first try dotnet from PATH, then fall back to C:\Program Files\dotnet\dotnet.exe.

Build A Release Package

From a cloned checkout:

tools\package-windows.ps1

The package is written to:

artifacts\PetLimitBars-win-x64.zip

The zip package includes:

  • PetLimitBars.exe and supporting runtime files.
  • install-windows.ps1.
  • uninstall-windows.ps1.
  • README.md.
  • localized README files under docs/readme/.
  • LICENSE.
  • SECURITY.md.
  • THIRD_PARTY_NOTICES.md.
  • LEGAL_RISK_NOTES.md.

Project Notes

  • Reads Codex pet bounds from .codex-global-state.json.
  • Uses cached local rate-limit events by default.
  • Live usage is opt-in and uses the local Codex access token only while refreshing.
  • Draws transparent click-through WPF usage bars above the pet.
  • Stores app-owned settings under %APPDATA%\PetLimitBars\settings.json.
  • Does not patch or redistribute Codex app files.

Audited upstream:

Disclaimer

Pet Limit Bars is provided as-is under the MIT License, without warranty. Usage values are best-effort estimates based on local Codex data or opt-in Live usage, and may be delayed, inaccurate, or unavailable. Live mode may stop working if Codex or ChatGPT changes. Use the app at your own discretion and review the source before enabling Live mode.

License And Attribution

Pet Limit Bars is released under the MIT License. See LICENSE.

This project is inspired by and ports the companion-app behavior of petergpt/codex-pet-limit-rings, which is also MIT-licensed. See THIRD_PARTY_NOTICES.md for upstream attribution and dependency notices.

OpenAI, ChatGPT, and Codex are trademarks or product names of OpenAI. They are used here only to identify compatibility with the user's locally installed Codex app. This project does not use OpenAI logos, does not imply endorsement, and should not be represented as an official OpenAI product.

MIT compliance notes:

  • Keep LICENSE with source distributions.
  • Keep THIRD_PARTY_NOTICES.md with binary/release distributions.
  • Do not remove the upstream MIT notice for petergpt/codex-pet-limit-rings.

Spec Kit

About

Unofficial Windows companion app that shows Codex pet usage limits as local overlay bars.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors