Skip to content

Local webpage screen overlay for customizing your computing experience

License

Notifications You must be signed in to change notification settings

progrium/topframe

Repository files navigation

topframe

User programmable screen overlay using web technologies

Test workflow Go Report Card @progriumHQ on Twitter Project Forum Sponsor Project


  • Display information or place always-on-top widgets
  • Use HTML/JS/CSS to draw on your screen
  • Great for screencasting or streaming overlays
  • Edit source, hit save, screen will update
  • Less than 300 lines of Go code
  • Currently alpha, macOS only ...

Getting Started

  • download or run shell command
  • run with edit flag topframe --edit

Launching on Startup

Topframe works with launchd to run as an agent on startup. You can generate a plist file with topframe -agent, which you can write to a file and move into /Library/LaunchAgents:

$ topframe -agent > com.progrium.Topframe.plist
$ sudo mv com.progrium.Topframe.plist /Library/LaunchAgents

The generated plist will use the current binary location, so make sure it's in the right place before generating, or modify the plist file.

Documentation

  • wiki

Getting Help

  • forum

Contributing

  • maintainers wanted
  • small PRs welcome
  • big PRs discuss first

About

MIT Licensed