Skip to content

ayangweb/SuperIsland

 
 

Repository files navigation

SuperIsland

SuperIsland

Transform your Mac's notch into a live, interactive island.
Now Playing · Battery · Weather · Calendar · Notifications · Extensions

Website · Docs · Releases


Requirements

  • macOS 14 Sonoma or later
  • Xcode 15+
  • XcodeGenbrew install xcodegen
  • Node.js 18+ (only needed to work on extensions)

Setup

git clone https://github.com/shobhit99/superisland.git
cd superisland
xcodegen generate
open SuperIsland.xcodeproj

Select the SuperIsland scheme, choose your Mac as the destination, and hit Run.

On first launch the app will ask for Accessibility, Calendar, and Location permissions. These are required for the relevant modules to work.


Building a release DMG

Requires a Developer ID certificate and notarization credentials. Copy .env.example to .env and fill in:

APPLE_ID=you@example.com
APP_SPECIFIC_PASSWORD=xxxx-xxxx-xxxx-xxxx
TEAM_ID=XXXXXXXXXX
SIGNING_IDENTITY=Developer ID Application: Your Name (TEAMID)

Then run:

./scripts/build-and-release.sh

This archives, exports, notarizes, and produces a signed build/SuperIsland.dmg.

For a quick unsigned local build:

./scripts/build-dmg.sh

Project structure

SuperIsland/
  App/              AppDelegate, AppState
  Modules/          Built-in modules (Battery, NowPlaying, Weather, …)
  Settings/         Settings window views
  Utilities/        UpdateChecker, AutoUpdater, helpers
  Views/            CompactView, ExpandedView, IslandWindow
ExtensionHost/      JS runtime, extension manager, bridge
Extensions/         Bundled extensions (pomodoro, whatsapp-web, …)
scripts/            Build & release scripts

Extensions

Extensions are JavaScript packages that run inside a sandboxed JavaScriptCore context. Read the full guide at dynamicisland.app/docs or in EXTENSIONS.md.


Contributing

See CONTRIBUTING.md.


Updates

SuperIsland checks for updates automatically on launch. When a new version is available a dialog appears — click Update to download and install without reinstalling.

About

Dynamic Island for MacOS — with Extensions

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Swift 74.5%
  • JavaScript 16.2%
  • Python 7.4%
  • Shell 1.3%
  • Perl 0.6%