11# floatpane
22
33<p align =" center " >
4- <img src =" assets/icon.svg " alt =" floatpane Logo " width =" 128 " >
4+ <img src =" https://raw.githubusercontent.com/floatpane/floatpane/master/ assets/icon.svg" alt =" floatpane Logo " width =" 128 " >
55</p >
66
77<h3 align =" center " >A lightweight, floating wallpaper selector for macOS.</h3 >
1717
1818## 🎬 Demo
1919
20- ![ floatpane Demo] ( assets/floatpane-preview.gif )
20+ ![ floatpane Demo] ( https://raw.githubusercontent.com/floatpane/floatpane/master/ assets/floatpane-preview.gif)
2121
2222## ✨ Features
2323
24- - ** Summon** Summon the wallpaper grid from anywhere with ` Cmd+Shift+P ` .
25- - ** Floating Window:** Designed to float on top of all other applications, ensuring it's always accessible.
26- - ** Tiling WM Friendly:** Works seamlessly with ** Aerospace** , ** yabai** , and ** Amethyst** .
27- - ** ⌨️ Keyboard Navigation:** Use arrow keys to navigate, ` Enter ` to select, and ` Esc ` to close.
28- - ** ️ Lazy Loading:** Thumbnails are loaded efficiently as you scroll for a fast, responsive experience.
29- - ** 🎨 Themes:** Customize the look and feel of floatpane with a variety of built-in themes.
24+ - ** ⚡ Summon:** Bring up the wallpaper grid from anywhere with ` Cmd+Shift+P ` .
25+ - ** 🖼️ Floating Window:** Floats on top of all other applications for easy access.
26+ - ** 🧩 Tiling WM Friendly:** Integrates smoothly with Aerospace, yabai, and Amethyst.
27+ - ** ⌨️ Keyboard Navigation:** Use arrow keys to browse, ` Enter ` to apply, and ` Esc ` to dismiss.
28+ - ** 🚀 Lazy Loading:** Thumbnails load as you scroll for a fast, responsive experience.
29+ - ** ✅ Current Wallpaper Indicator:** Your active wallpaper is always highlighted.
30+ - ** 🎨 Themes:** Customize the look and feel with multiple built-in themes.
3031
3132## 📋 Requirements
3233
@@ -45,3 +46,54 @@ brew install floatpane
4546# Fix for macOS Gatekeeper
4647xattr -cr /Applications/floatpane.app
4748```
49+
50+ ### For Developers
51+
52+ 1 . ** Clone the repository:**
53+
54+ ``` sh
55+ git clone https://github.com/floatpane/floatpane.git
56+ cd floatpane
57+ ```
58+
59+ 2. ** Install dependencies:**
60+
61+ ` ` ` sh
62+ npm install
63+ ` ` `
64+
65+ 3. ** Run in development mode:**
66+
67+ You' ll need two terminal windows for this.
68+
69+ - In **Terminal 1**, start the webpack watcher:
70+ ```sh
71+ npm run watch
72+ ```
73+ - In **Terminal 2**, start the Electron app:
74+ ```sh
75+ npm start
76+ ```
77+
78+ ## 🎨 Available Themes
79+
80+ Floatpane includes a variety of themes to match your style. You can change the theme in the settings (`Cmd+,`).
81+
82+ - Aura
83+ - Ayu Dark
84+ - Cobalt2
85+ - Dracula
86+ - Gruvbox Dark
87+ - Material Theme
88+ - Monokai
89+ - Night Owl
90+ - Nord
91+ - One Dark Pro
92+ - Panda Syntax
93+ - Solarized Dark
94+ - Synthwave ' 84
95+ - Tokyo Night Blue
96+
97+ # # 📜 License
98+
99+ This project is licensed under the ** MIT License** - see the [LICENSE](LICENSE) file for details.
0 commit comments