@quenty/settings-inputkeymap 1.0.1-canary.281.b720162.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.281.b720162.0 (2022-08-14)
+
+
+### Features
+
+* Add Settings-InputKeyMap package which saves keybinds for the user into the setting system. ([225254b](https://github.com/Quenty/NevermoreEngine/commit/225254bf28744c1bd476d9882c9edafa800a7998))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2022 Quenty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+## SettingsInputKeyMap
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Input key map setting saving for players
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/Signal">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/settings-inputkeymap --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "settings-inputkeymap",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@quenty/settings-inputkeymap",
+  "version": "1.0.1-canary.281.b720162.0",
+  "description": "Input key map setting saving for players",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Settings"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/settings-inputkeymap/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@quenty/baseobject": "5.1.0",
+    "@quenty/enumutils": "1.0.1-canary.281.b720162.0",
+    "@quenty/inputkeymaputils": "5.3.2-canary.281.b720162.0",
+    "@quenty/inputmode": "5.2.1-canary.281.b720162.0",
+    "@quenty/jsonutils": "5.1.0",
+    "@quenty/loader": "5.0.0",
+    "@quenty/maid": "2.4.0",
+    "@quenty/servicebag": "5.1.0",
+    "@quenty/settings": "2.3.2-canary.281.b720162.0",
+    "@quenty/string": "2.3.1-canary.281.b720162.0"
+  },
+  "gitHead": "b720162ac53aede1f77664ccea0982b86127d824"
+}

package/src/Client/InputKeyMapSettingClient.lua

@@ -0,0 +1,74 @@
+--[=[
+	@class InputKeyMapSettingClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local InputKeyMapSettingUtils = require("InputKeyMapSettingUtils")
+local SettingsServiceClient = require("SettingsServiceClient")
+local InputKeyMapSettingConstants = require("InputKeyMapSettingConstants")
+
+local InputKeyMapSettingClient = setmetatable({}, BaseObject)
+InputKeyMapSettingClient.ClassName = "InputKeyMapSettingClient"
+InputKeyMapSettingClient.__index = InputKeyMapSettingClient
+
+function InputKeyMapSettingClient.new(serviceBag, inputKeyMapList)
+	local self = setmetatable(BaseObject.new(), InputKeyMapSettingClient)
+
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._settingService = self._serviceBag:GetService(SettingsServiceClient)
+
+	self._inputKeyMapList = assert(inputKeyMapList, "No inputKeyMapList")
+
+	self._maid:GiveTask(self._settingService:ObserveLocalPlayerSettingsBrio():Subscribe(function(settingsBrio)
+		if settingsBrio:IsDead() then
+			return
+		end
+
+		local settingMaid = settingsBrio:ToMaid()
+		local settings = settingsBrio:GetValue()
+
+		settingMaid:GiveTask(self._inputKeyMapList:ObservePairsBrio():Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
+
+			local maid = brio:ToMaid()
+			local inputModeType, inputKeyMap = brio:GetValue()
+
+			local settingName = InputKeyMapSettingUtils.getSettingName(inputKeyMapList, inputModeType)
+			local settingProperty = settings:GetSettingProperty(settingName, InputKeyMapSettingConstants.DEFAULT_VALUE)
+
+			-- Try to retrieve
+			maid:GiveTask(settingProperty:Observe():Subscribe(function(currentValue)
+				if currentValue == InputKeyMapSettingConstants.DEFAULT_VALUE or currentValue == nil then
+					inputKeyMap:RestoreDefault()
+				elseif type(currentValue) == "string" and currentValue ~= InputKeyMapSettingConstants.DEFAULT_VALUE then
+					local decoded = InputKeyMapSettingUtils.decodeInputTypeList(currentValue)
+					if decoded then
+						inputKeyMap:SetInputTypesList(decoded)
+					else
+						warn(("[InputKeyMapSettingClient] - Failed to decode setting value from %q"):format(tostring(currentValue)))
+					end
+				else
+					warn(("[InputKeyMapSettingClient] - Failed to decode setting value from %q"):format(tostring(currentValue)))
+				end
+			end))
+
+			maid:GiveTask(inputKeyMap:ObserveInputTypesList():Subscribe(function(inputTypeList)
+				-- Store
+				local encoded = InputKeyMapSettingUtils.encodeInputTypeList(inputTypeList)
+				if encoded ~= InputKeyMapSettingUtils.encodeInputTypeList(inputKeyMap:GetDefaultInputTypesList()) then
+					settings:SetValue(settingName, encoded)
+				else
+					settings:SetValue(settingName, InputKeyMapSettingConstants.DEFAULT_VALUE)
+				end
+			end))
+		end))
+	end))
+
+	return self
+end
+
+return InputKeyMapSettingClient

package/src/Client/SettingsInputKeyMapServiceClient.lua

@@ -0,0 +1,42 @@
+--[=[
+	@class SettingsInputKeyMapServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Maid = require("Maid")
+local InputKeyMapSettingClient = require("InputKeyMapSettingClient")
+
+local SettingsInputKeyMapServiceClient = {}
+SettingsInputKeyMapServiceClient.ServiceName = "SettingsInputKeyMapServiceClient"
+
+function SettingsInputKeyMapServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	-- External
+	self._serviceBag:GetService(require("SettingsServiceClient"))
+	self._serviceBag:GetService(require("InputModeServiceClient"))
+	self._serviceBag:GetService(require("InputKeyMapServiceClient"))
+	self._inputKeyMapRegistry = self._serviceBag:GetService(require("InputKeyMapRegistryServiceShared"))
+end
+
+function SettingsInputKeyMapServiceClient:Start()
+	self._maid:GiveTask(self._inputKeyMapRegistry:ObserveInputKeyMapListsBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid = brio:ToMaid()
+		local inputKeyMapList = brio:GetValue()
+
+		maid:GiveTask(InputKeyMapSettingClient.new(self._serviceBag, inputKeyMapList))
+	end))
+end
+
+function SettingsInputKeyMapServiceClient:Destroy()
+	self._maid:DoCleaning()
+end
+
+return SettingsInputKeyMapServiceClient

package/src/Server/InputKeyMapSetting.lua

@@ -0,0 +1,46 @@
+--[=[
+	Registers the settings automatically so we can validate on the server.
+	@class InputKeyMapSetting
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local InputKeyMapSettingUtils = require("InputKeyMapSettingUtils")
+local SettingsService = require("SettingsService")
+local InputKeyMapSettingConstants = require("InputKeyMapSettingConstants")
+local SettingDefinition = require("SettingDefinition")
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
+
+local InputKeyMapSetting = setmetatable({}, BaseObject)
+InputKeyMapSetting.ClassName = "InputKeyMapSetting"
+InputKeyMapSetting.__index = InputKeyMapSetting
+
+function InputKeyMapSetting.new(serviceBag, inputKeyMapList)
+	local self = setmetatable(BaseObject.new(), InputKeyMapSetting)
+
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._settingService = self._serviceBag:GetService(SettingsService)
+	self._settingRegistryServiceShared = self._serviceBag:GetService(SettingRegistryServiceShared)
+
+	self._inputKeyMapList = assert(inputKeyMapList, "No inputKeyMapList")
+
+	self._maid:GiveTask(self._inputKeyMapList:ObservePairsBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		-- Register settings
+		local maid = brio:ToMaid()
+		local inputModeType, _ = brio:GetValue()
+
+		local settingName = InputKeyMapSettingUtils.getSettingName(inputKeyMapList, inputModeType)
+		local definition = SettingDefinition.new(settingName, InputKeyMapSettingConstants.DEFAULT_VALUE)
+
+		maid:GiveTask(self._settingRegistryServiceShared:RegisterSettingDefinition(definition))
+	end))
+
+	return self
+end
+
+return InputKeyMapSetting

package/src/Server/SettingsInputKeyMapService.lua

@@ -0,0 +1,41 @@
+--[=[
+	@class SettingsInputKeyMapService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Maid = require("Maid")
+local InputKeyMapSetting = require("InputKeyMapSetting")
+
+local SettingsInputKeyMapService = {}
+SettingsInputKeyMapService.ServiceName = "SettingsInputKeyMapService"
+
+function SettingsInputKeyMapService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	-- External
+	self._serviceBag:GetService(require("SettingsService"))
+	self._inputKeyMapRegistry = self._serviceBag:GetService(require("InputKeyMapRegistryServiceShared"))
+
+end
+
+function SettingsInputKeyMapService:Start()
+	self._maid:GiveTask(self._inputKeyMapRegistry:ObserveInputKeyMapListsBrio():Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid = brio:ToMaid()
+		local inputKeyMapList = brio:GetValue()
+
+		maid:GiveTask(InputKeyMapSetting.new(self._serviceBag, inputKeyMapList))
+	end))
+end
+
+function SettingsInputKeyMapService:Destroy()
+	self._maid:DoCleaning()
+end
+
+return SettingsInputKeyMapService

package/src/Shared/InputKeyMapSettingConstants.lua

@@ -0,0 +1,11 @@
+--[=[
+	@class InputKeyMapSettingConstants
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Table = require("Table")
+
+return Table.readonly({
+	DEFAULT_VALUE = "default";
+})

package/src/Shared/InputKeyMapSettingUtils.lua

@@ -0,0 +1,88 @@
+--[=[
+	Helper methods for encoding and decoding input lists into network storage
+	@class InputKeyMapSettingUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local HttpService = game:GetService("HttpService")
+
+local EnumUtils = require("EnumUtils")
+local JSONUtils = require("JSONUtils")
+local InputTypeUtils = require("InputTypeUtils")
+local String = require("String")
+
+local InputKeyMapSettingUtils = {}
+
+--[=[
+	Returns the canonical setting name for this input key map list.
+
+	@param inputKeyMapList InputKeyMapList
+	@param inputModeType InputModeType
+	@return string
+]=]
+function InputKeyMapSettingUtils.getSettingName(inputKeyMapList, inputModeType)
+	return ("Keybind_%s_%s"):format(String.toCamelCase(inputKeyMapList:GetListName()), inputModeType.Name)
+end
+
+--[=[
+	Encodes the list into a string which can be decoded later.
+
+	@param list { InputType }
+	@return string
+]=]
+function InputKeyMapSettingUtils.encodeInputTypeList(list)
+	local newList = {}
+
+	for _, inputType in pairs(list) do
+		if typeof(inputType) == "EnumItem" then
+			table.insert(newList, EnumUtils.encodeAsString(inputType))
+		elseif InputTypeUtils.isKnownInputType(inputType) then
+			table.insert(newList, inputType)
+		else
+			warn(("[InputKeyMapSettingUtils] - Unknown inputType %q"):format(tostring(inputType)))
+			table.insert(newList, inputType) -- Encode anyway
+		end
+	end
+
+	return HttpService:JSONEncode(newList)
+end
+
+--[=[
+	Decodes the list from a string into a safe value.
+
+	@param encoded string?
+	@return string
+]=]
+function InputKeyMapSettingUtils.decodeInputTypeList(encoded)
+	if type(encoded) ~= "string" then
+		return nil
+	end
+
+	local ok, result = JSONUtils.jsonDecode(encoded)
+	if not ok then
+		return nil
+	end
+
+	if type(result) ~= "table" then
+		warn("[InputKeyMapSettingUtils] - Failed to decode table")
+		return nil
+	end
+
+	local decodedList = {}
+
+	for _, inputType in pairs(result) do
+		if EnumUtils.isEncodedEnum(inputType) then
+			table.insert(decodedList, EnumUtils.decodeFromString(inputType))
+		elseif InputTypeUtils.isKnownInputType(inputType) then
+			table.insert(decodedList, inputType)
+		else
+			warn(("[InputKeyMapSettingUtils] - Unknown inputType %q"):format(tostring(inputType)))
+			table.insert(decodedList, inputType) -- Decode anyway
+		end
+	end
+
+	return decodedList
+end
+
+return InputKeyMapSettingUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,21 @@
+{
+  "name": "SettingsInputKeyMapTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "settings-inputkeymap": {
+        "$path": ".."
+      },
+      "Script": {
+        "$path": "scripts/Server"
+      }
+    },
+    "StarterPlayer": {
+      "StarterPlayerScripts": {
+        "Main": {
+          "$path": "scripts/Client"
+        }
+      }
+    }
+  }
+}

package/test/scripts/Client/ClientMain.client.lua

@@ -0,0 +1,27 @@
+--[[
+	@class ClientMain
+]]
+local packages = game:GetService("ReplicatedStorage"):WaitForChild("Packages")
+
+local serviceBag = require(packages.ServiceBag).new()
+serviceBag:GetService(packages.SettingsInputKeyMapServiceClient)
+
+-- Start game
+serviceBag:Init()
+serviceBag:Start()
+
+local InputKeyMapList = require(packages.InputKeyMapList)
+local InputModeTypes = require(packages.InputModeTypes)
+local InputKeyMap = require(packages.InputKeyMap)
+local SlottedTouchButtonUtils = require(packages.SlottedTouchButtonUtils)
+
+local inputKeyMapList = InputKeyMapList.new("JUMP", {
+	InputKeyMap.new(InputModeTypes.KeyboardAndMouse, { Enum.KeyCode.Q });
+	InputKeyMap.new(InputModeTypes.Gamepads, { Enum.KeyCode.ButtonY });
+	InputKeyMap.new(InputModeTypes.Touch, { SlottedTouchButtonUtils.createSlottedTouchButton("primary3") });
+}, {
+	bindingName = "Jump";
+	rebindable = true;
+})
+
+serviceBag:GetService(packages.SettingsInputKeyMapServiceClient):AddInputKeyMapList(inputKeyMapList)

package/test/scripts/Server/ServerMain.server.lua

@@ -0,0 +1,14 @@
+--[[
+	@class ServerMain
+]]
+local ServerScriptService = game:GetService("ServerScriptService")
+
+local loader = ServerScriptService:FindFirstChild("LoaderUtils", true).Parent
+local packages = require(loader).bootstrapGame(ServerScriptService["settings-inputkeymap"])
+
+local serviceBag = require(packages.ServiceBag).new()
+serviceBag:GetService(packages.SettingsInputKeyMapService)
+
+-- Start game
+serviceBag:Init()
+serviceBag:Start()