Skip to content

Quality-of-Life fix for multi-keymap #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Quality-of-Life fix for multi-keymap #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8f4e7
fix prev/next keymap keybind
TheMoonThatRises Jul 26, 2025
ea7b2f6
allow reorder keymaps
TheMoonThatRises Jul 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions PlayTools/Controls/MenuController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,10 @@ var keymapping = [
value: "Toggle Debug Overlay", comment: ""),
NSLocalizedString("menu.keymapping.hide.pointer", tableName: "Playtools",
value: "Hide Mouse Pointer", comment: ""),
NSLocalizedString("menu.keymapping.nextKeymap", tableName: "Playtools",
value: "Next Keymap", comment: ""),
NSLocalizedString("menu.keymapping.previousKeymap", tableName: "Playtools",
value: "Previous Keymap", comment: "")
value: "Previous Keymap", comment: ""),
NSLocalizedString("menu.keymapping.nextKeymap", tableName: "Playtools",
value: "Next Keymap", comment: "")
]
var keymappingSelectors = [#selector(UIApplication.switchEditorMode(_:)),
#selector(UIApplication.removeElement(_:)),
Expand All @@ -155,8 +155,8 @@ var keymappingSelectors = [#selector(UIApplication.switchEditorMode(_:)),
#selector(UIApplication.rotateView(_:)),
#selector(UIApplication.toggleDebugOverlay(_:)),
#selector(UIApplication.hideCursor(_:)),
#selector(UIApplication.nextKeymap(_:)),
#selector(UIApplication.previousKeymap(_:))
#selector(UIApplication.previousKeymap(_:)),
#selector(UIApplication.nextKeymap(_:))
]

class MenuController {
Expand Down Expand Up @@ -205,8 +205,8 @@ class MenuController {
"R", // Rotate display
"D", // Toggle debug overlay
".", // Hide cursor until move
"[", // Next keymap
"]" // Previous keymap
"[", // Previous keymap
"]" // Next keymap
]
let arrowKeyChildrenCommands = zip(keyCommands, keymapping).map { (command, btn) in
UIKeyCommand(title: btn,
Expand Down
122 changes: 46 additions & 76 deletions PlayTools/Keymap/Keymapping.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ class Keymapping {
private var keymapIdx: Int
public var currentKeymap: KeymappingData {
get {
getKeymap(name: currentKeymapName)
getKeymap(path: currentKeymapURL)
}
set {
setKeymap(name: currentKeymapName, map: newValue)
setKeymap(path: currentKeymapURL, map: newValue)
}
}

private let baseKeymapURL: URL
private let configURL: URL
private var keymapURLs: [String: URL]
private var keymapOrder: [URL: KeymappingData] = [:]

public var keymapConfig: KeymapConfig {
get {
Expand All @@ -51,8 +51,12 @@ class Keymapping {
}
}

public var currentKeymapURL: URL {
keymapConfig.keymapOrder[keymapIdx]
}

public var currentKeymapName: String {
Array(keymapURLs.keys)[keymapIdx]
currentKeymapURL.deletingPathExtension().lastPathComponent
}

init() {
Expand All @@ -61,22 +65,16 @@ class Keymapping {
.appendingPathComponent(bundleIdentifier)

configURL = baseKeymapURL.appendingPathComponent(".config").appendingPathExtension("plist")
keymapURLs = [:]

keymapIdx = 0

do {
let data = try Data(contentsOf: configURL)
keymapConfig = try PropertyListDecoder().decode(KeymapConfig.self, from: data)
} catch {
print("[PlayTools] Failed to decode config url.\n%@")
keymapConfig = KeymapConfig(defaultKm: "default")
resetConfig()
}

loadKeymapData()
}

private func constructKeymapPath(name: String) -> URL {
baseKeymapURL.appendingPathComponent(name).appendingPathExtension("plist")
}

private func loadKeymapData() {
if !FileManager.default.fileExists(atPath: baseKeymapURL.path) {
do {
Expand All @@ -89,97 +87,68 @@ class Keymapping {
}
}

reloadKeymapCache()
keymapOrder.removeAll()

if let defaultKmIdx = keymapURLs.keys.firstIndex(of: keymapConfig.defaultKm) {
keymapIdx = keymapURLs.distance(from: keymapURLs.startIndex, to: defaultKmIdx)
for keymap in keymapConfig.keymapOrder {
keymapOrder[keymap] = getKeymap(path: keymap)
}
}

public func reloadKeymapCache() {
keymapURLs = [:]

do {
let directoryContents = try FileManager.default
.contentsOfDirectory(at: baseKeymapURL, includingPropertiesForKeys: nil, options: [.skipsHiddenFiles])

if directoryContents.count > 0 {
for keymap in directoryContents where keymap.pathExtension.contains("plist") {
keymapURLs[keymap.deletingPathExtension().lastPathComponent] = keymap
}

return
}
} catch {
print("[PlayTools] Failed to get keymapping directory.\n%@")
if let defaultKmIdx = keymapOrder.keys.firstIndex(of: keymapConfig.defaultKm) {
keymapIdx = keymapOrder.distance(from: keymapOrder.startIndex, to: defaultKmIdx)
} else {
setKeymap(path: keymapConfig.defaultKm, map: KeymappingData(bundleIdentifier: bundleIdentifier))
loadKeymapData()
}

setKeymap(name: "default", map: KeymappingData(bundleIdentifier: bundleIdentifier))
reloadKeymapCache()
}

private func getKeymap(name: String) -> KeymappingData {
if let keymapURL = keymapURLs[name] {
do {
let data = try Data(contentsOf: keymapURL)
let map = try PropertyListDecoder().decode(KeymappingData.self, from: data)
return map
} catch {
print("[PlayTools] Keymapping decode failed.\n%@")
}
} else {
print("[PlayTools] Unable to find keymap with name \(name).\n%@")
private func getKeymap(path: URL) -> KeymappingData {
do {
let data = try Data(contentsOf: path)
let map = try PropertyListDecoder().decode(KeymappingData.self, from: data)
return map
} catch {
print("[PlayTools] Keymapping decode failed.\n%@")
}

return resetKeymap(name: name)
return resetKeymap(path: path)
}

private func setKeymap(name: String, map: KeymappingData) {
private func setKeymap(path: URL, map: KeymappingData) {
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml

if !keymapURLs.keys.contains(name) {
let mapURL = baseKeymapURL.appendingPathComponent(name).appendingPathExtension("plist")

keymapURLs[name] = mapURL
}
do {
let data = try encoder.encode(map)
try data.write(to: path)

if let keymapURL = keymapURLs[name] {
do {
let data = try encoder.encode(map)
try data.write(to: keymapURL)
} catch {
print("[PlayTools] Keymapping encode failed.\n%@")
if !keymapOrder.keys.contains(path) {
keymapConfig.keymapOrder.append(path)
keymapOrder[path] = getKeymap(path: path)
}
} else {
print("[PlayTools] Unable to find keymap with name \(name).\n%@")
} catch {
print("[PlayTools] Keymapping encode failed.\n%@")
}
}

public func nextKeymap() {
keymapIdx = (keymapIdx + 1) % keymapURLs.count
keymapIdx = (keymapIdx + 1) % keymapOrder.count
}

public func previousKeymap() {
keymapIdx = (keymapIdx - 1 + keymapURLs.count) % keymapURLs.count
keymapIdx = (keymapIdx - 1 + keymapOrder.count) % keymapOrder.count
}

@discardableResult
public func resetKeymap(name: String) -> KeymappingData {
setKeymap(name: name, map: KeymappingData(bundleIdentifier: bundleIdentifier))
return getKeymap(name: name)
public func resetKeymap(path: URL) -> KeymappingData {
setKeymap(path: path, map: KeymappingData(bundleIdentifier: bundleIdentifier))
return getKeymap(path: path)
}

@discardableResult
private func resetConfig() -> KeymapConfig {
let defaultKm = keymapURLs.keys.contains("default") ? "default" : keymapURLs.keys.first

guard let defaultKm = defaultKm else {
reloadKeymapCache()
return resetConfig()
}
let defaultURL = constructKeymapPath(name: "default")

keymapConfig = KeymapConfig(defaultKm: defaultKm)
keymapConfig = KeymapConfig(defaultKm: defaultURL, keymapOrder: [defaultURL])

return keymapConfig
}
Expand All @@ -196,5 +165,6 @@ struct KeymappingData: Codable {
}

struct KeymapConfig: Codable {
var defaultKm: String
var defaultKm: URL
var keymapOrder: [URL]
}