Jaysce · ruittenb · May 31, 2023 · Mar 16, 2024 · Mar 16, 2024 · Mar 16, 2024
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0 +1,30 @@
+1.6.6: Fix responsiveness of status bar icon
+1.6.5: Flash status bar icon when space has no shortcut key
+1.6.4: Flash status bar icon when space has no shortcut key
+1.6.3  : Merged 1.5.12 into 1.6.2
+1.6.2  : Merged 1.5.11 into 1.6.1-R
+1.6.1-R: Merged 1.5.10-R into 1.6.0-R
+1.6.0-R: Add support for clicking icon in status bar
+1.5.12 : Minor updates to preferences dialog (github repo url, modifier keys)
+1.5.11 : Updated disk image; corrected handling incompatible user defaults
+1.5.10-R: Fix: corrected space names in menu and in preferences drop-down
+1.5.9-R: Fix: fullscreen spaces have no shortcut keys; disable menu options that lack a shortcut key
+1.5.8-R: Correction to numbering fullscreen spaces
+1.5.7-R: New status bar icon style: names without numbers
+1.5.6-R: Add button for opening System Settings panel from dialog; Fix checking for updates
+1.5.5-R: Support for restarting numbering in menu and numbers-only rendering
+1.5.4-R: Minor refactoring
+1.5.3-R: Tweaked menu icon opacity
+1.5.2-R: Removed obsolete configuration option
+1.5.1-R: Display icons in menu
+1.5.0-R: Sort displays left/right (by Michael Lehenauer)
+1.4.0-R: Add Applescript refresh command (by Michael Lehenauer)
+1.3.1-R: Fix editing space names
+1.3.0-R: Remember Space Names
+1.2.5-R: Improved preferences layout; updated documentation
+1.2.4-R: Added Makefile for commandline-driven distribution
+1.2.3-R: Fix space number jump in properties dialog after refresh
+1.2.2-R: Fix saving of space name other than using "Update name" button
+1.2.1-R: Better support for space names consisting of four characters
+1.2.0-R: Show space numbers in menu
+1.1.1-R: Desktop switcher using menu options
diff --git a/Images/Accessibility-0.png b/Images/Accessibility-0.png
diff --git a/Images/Accessibility-1.png b/Images/Accessibility-1.png
diff --git a/Images/Accessibility-2.png b/Images/Accessibility-2.png
diff --git a/Images/Accessibility-2.xcf b/Images/Accessibility-2.xcf
diff --git a/Images/Menu.png b/Images/Menu.png
diff --git a/Images/Preferences-4.png b/Images/Preferences-4.png
diff --git a/Images/Preferences-4a.png b/Images/Preferences-4a.png
diff --git a/Images/Preferences-4b.png b/Images/Preferences-4b.png
diff --git a/Images/Preferences.png b/Images/Preferences.png
diff --git a/Images/Shortcuts.png b/Images/Shortcuts.png
diff --git a/Images/Spaceman_Example.png b/Images/Spaceman_Example.png
diff --git a/Images/Switching-Spaces.gif b/Images/Switching-Spaces.gif
diff --git a/Images/background.png b/Images/background.png
diff --git a/Makefile b/Makefile
@@ -0,0 +1,79 @@
+
+PROJECT  = Spaceman
+APPNAME  = $(PROJECT).app
+BUILDDIR = build
+ARCHIVE  = $(BUILDDIR)/$(PROJECT).xcarchive
+IMAGEDIR = $(BUILDDIR)/diskimage
+APPFILE  = $(IMAGEDIR)/$(APPNAME)
+PBXPROJ  = $(PROJECT).xcodeproj/project.pbxproj
+VERSION  = $(shell awk -F'["; ]*' '/MARKETING_VERSION/ { print $$3; exit }' $(PBXPROJ))
+IMAGE    = $(BUILDDIR)/$(PROJECT)-$(VERSION).dmg
+
+.DEFAULT_GOAL := help
+
+.PHONY: help # See https://tinyurl.com/makefile-autohelp
+help: ## Print help for each target
+	@awk -v tab=15 'BEGIN{FS="(:.*## |##@ |@## )";c="\033[36m";m="\033[0m";y="  ";a=2;h()}function t(s){gsub(/[ \t]+$$/,"",s);gsub(/^[ \t]+/,"",s);return s}function u(g,d){split(t(g),f," ");for(j in f)printf"%s%s%-"tab"s%s%s\n",y,c,t(f[j]),m,d}function h(){printf"\nUsage:\n%smake %s<target>%s\n\nRecognized targets:\n",y,c,m}/\\$$/{gsub(/\\$$/,"");b=b$$0;next}b{$$0=b$$0;b=""}/^[-a-zA-Z0-9*\/%_. ]+:.*## /{p=sprintf("\n%"(tab+a)"s"y,"");gsub(/\\n/,p);if($$1~/%/&&$$2~/^%:/){n=split($$2,q,/%:|:% */);for(i=2;i<n;i+=2){g=$$1;sub(/%/,q[i],g);u(g,q[i+1])}}else if($$1~/%/&&$$2~/%:[^%]+:[^%]+:%/){d=$$2;sub(/^.*%:/,"",d);sub(/:%.*/,"",d);n=split(d,q,/:/);for(i=1;i<=n;i++){g=$$1;d=$$2;sub(/%/,q[i],g);sub(/%:[^%]+:%/,q[i],d);u(g,d)}}else u($$1,$$2)}/^##@ /{gsub(/\\n/,"\n");if(NF==3)tab=$$2;printf"\n%s\n",$$NF}END{print""}' $(MAKEFILE_LIST) # v1.62
+
+.PHONY: build
+build: ## Make the archive file
+	make $(ARCHIVE)
+
+$(ARCHIVE): $(PBXPROJ)
+	xcodebuild -workspace $(PROJECT).xcodeproj/project.xcworkspace -scheme $(PROJECT) -configuration Release clean archive -archivePath $(ARCHIVE)
+
+.PHONY: export
+export: ## Make the app file
+	make $(APPFILE)
+
+$(APPFILE): $(ARCHIVE)
+	xcodebuild -exportArchive -archivePath $(ARCHIVE) -exportOptionsPlist $(PROJECT)/exportOptions.plist -exportPath $(IMAGEDIR)
+	touch $(APPFILE)
+
+.PHONY: image
+image: ## Make the dmg image file
+	make $(IMAGE)
+
+$(IMAGE): $(APPFILE)
+	create-dmg \
+		--volname "Spaceman Installer"                           \
+		--volicon $(IMAGEDIR)/.VolumeIcon.icns                   \
+		--background $(IMAGEDIR)/.background/dmg-background.tiff \
+		--window-pos 200 120                                     \
+		--window-size 640 440                                    \
+		--icon-size 128                                          \
+		--icon Spaceman.app 170 170                              \
+		--icon Applications 470 170                              \
+		--hide-extension Spaceman.app                            \
+		--app-drop-link 470 170                                  \
+		--no-internet-enable                                     \
+		$(IMAGE)                                                 \
+		$(IMAGEDIR) # source folder
+
+all: image ## Make all of the above
+
+##@ Publishing
+
+.PHONY: tag
+tag: ## Tag the current HEAD with the version from the XCode project
+	git tag v$(VERSION)
+	git push --tags
+
+.PHONY: appcast
+appcast: ## Prepare appcast for publishing
+	git checkout main
+	$(BUILDDIR)/make-appcast.sh > website/appcast.xml
+	git add website/appcast.xml
+	@printf "\nCreated appcast.xml, now please commit it\n"
+
+.PHONY: publish
+publish: ## Publish the main branch appcast on Github Pages
+	git subtree push --prefix website origin main:github-pages
+
+.PHONY: publish-force
+# git subtree split --prefix website -b github-pages # create a local github-pages branch containing the splitted output folder
+# git push -f origin github-pages:github-pages       # force push the github-pages branch to origin
+publish-force: ## Publish the main branch appcast on Github Pages (force push)
+	git checkout main
+	git push --force-with-lease origin `git subtree split --prefix website main`:github-pages
+
diff --git a/README-Yabai.md b/README-Yabai.md
@@ -0,0 +1,33 @@
+
+## Feature: Add Apple Script Refresh Command
+
+[mike-jl](https://github.com/mike-jl) [commented on May 30](https://github.com/Jaysce/Spaceman/pull/34):
+
+It is possible to refresh Spaceman using the following Apple Script command:
+
+```applescript
+tell application "Spaceman" to refresh
+```
+
+When using yabai, you can make sure that the icons stay up to date with the following code added to the end of yabairc:
+
+```sh
+signals=(
+   "space_changed"
+   "display_added"
+   "display_removed"
+   "display_moved"
+   "display_changed"
+   "mission_control_enter"
+   "mission_control_exit"
+   "space_created"
+   "space_destroyed"
+)
+for signal in "${signals[@]}"
+do
+   yabai --message signal \
+         --add \
+            event=$signal \
+            action="osascript -e 'tell application \"Spaceman\" to refresh'"
+done
+```
diff --git a/README.md b/README.md
@@ -1,26 +1,32 @@
+
 ![Spaceman Example](Images/Header.png)
+
 ## About
+
 Spaceman is an application for macOS that allows you to view your Spaces / Virtual Desktops in the menu bar. Spaceman allows you to see which space you are currently on (or spaces if you are using multiple displays) relative to the other spaces you have. Naming these spaces is also an option in order to organise separate spaces for your workflow.
 
+Also, the menu and statusbar icons enable switching between spaces.
+
 **Spaceman requires macOS 11 Big Sur or greater.**
 
 ## Install
-### Homebrew
-```
-brew install spaceman
-```
+
 ### GitHub
-Go to the releases tab and download **Spaceman.dmg** from the latest release.
+
+Go to the [releases](https://github.com/ruittenb/Spaceman/releases) tab and download **Spaceman.dmg** from the latest release.
+
 ## Usage
-<a href="url"><img src="Images/Spaceman_Example.png" height="auto" width="auto" style="border-radius:10px"></a>
+
+<img src="Images/Spaceman_Example.png" width="66%" height="auto">
 
 The above image shows the possible icons that you will see depending on the style you choose.
 
-There are 4 styles to choose from, from top to bottom:
+There are five styles to choose from, from top to bottom:
 - Rectangles
 - Numbers
 - Rectangles with Numbers
-- Named Spaces
+- Names
+- Names with Numbers
 
 The meaning of the icons from left to right are:
 
@@ -31,14 +37,76 @@ The meaning of the icons from left to right are:
 - Inactive Space
 - Active Fullscreen App
 
-<a href="url"><img src="Images/Preferences.png" height="auto" width="auto" style="border-radius:10px"></a>
+## Preferences
+
+<img src="Images/Preferences-4a.png" width="66%" height="auto">
+
+The style and the name of a space can be changed in preferences (shown above). A space is named by selecting the space from the dropdown, typing a name up to 4 characters and clicking the 'Update name' button.
+
+If the icon fails to update, you can choose to force a refresh of the icon using a custom keyboard shortcut or allow Spaceman to refresh them automatically every 5 seconds by enabling 'Refresh spaces in background'.
+
+### Switching Spaces
+
+Icons in the status bar can be clicked to switch spaces:
+
+<img src="Images/Switching-Spaces.gif" width="66%" height="auto">
+
+The menu shows a list of space names. Selecting one will cause Spaceman to switch to that space.
+
+<img src="Images/Menu.png" width="auto" height="auto">
 
-The style and the name of a space can be changed in preferences (shown above). A space is named by selecting the space from the dropdown, typing a name up to 3 characters and clicking the 'Update name' button or pressing enter.
+Spaceman switches spaces by sending a keyboard shortcut to Mission Control using `osascript`.
+Note that only the first ten spaces will have shortcut keys assigned.
+For extra spaces, switching will not be available; the status bar icon will flash if
+selected, and the menu option will be disabled.
 
-If the icon fails to update, you can choose to force a refresh of the icon using a custom keyboard shortcut or allow Spaceman to refresh them automatically every 5 seconds by enabling 'Refresh spaces in background'. See [#2](https://github.com/Jaysce/Spaceman/issues/2).
+**For switching to work successfully, the following things need to be configured:**
+
+- Spaceman needs authorization for Accessibility:
+
+<img src="Images/Accessibility-1.png" width="66%" height="auto">
+<img src="Images/Accessibility-2.png" width="66%" height="auto">
+
+- Shortcut keys need to have been defined for Mission Control:
+
+<img src="Images/Shortcuts.png" width="66%" height="auto">
+
+- Spaceman needs to know which shortcuts to send:
+
+<img src="Images/Preferences-4b.png" width="66%" height="auto">
+
+## Remote Refresh
+
+The list of spaces can also be refreshed using Applescript:
+
+```sh
+$ osascript -e 'tell application "Spaceman" to refresh'
+```
+
+For details on how to maximize usefulness of this, see [MikeJL's Comments](README-Yabai.md)
+
+## Troubleshooting
+
+If Spaceman does not start, or does not start correctly, after an upgrade: you may need to delete the application defaults:
+
+```sh
+$ defaults delete dev.ruittenb.Spaceman
+```
 
 ## Attributions
+
 - This project is based on [WhichSpace](https://github.com/gechr/WhichSpace)
 - This project uses [Sparkle](https://sparkle-project.org) for update delivery
 - This project makes use of [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin)
 - This project makes use of [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts)
+- Authors:
+  - [Sasindu Jayasinghe](https://github.com/Jaysce/Spaceman)
+  - [René Uittenbogaard](https://github.com/ruittenb/Spaceman)
+- Contributions by:
+  - [Dmitry Poznyak](https://github.com/triangular-sneaky/Spaceman)
+  - [Grzegorz Milka](https://github.com/gregorias)
+  - [Michael Lehenauer](https://github.com/mike-jl/Spaceman)
+  - [Logan Savage](https://github.com/lxsavage/Spaceman)
+  - [Yakir Lugasy](https://github.com/yakirlog/Spaceman)
+  - [aaplmath](https://github.com/aaplmath)
+