@quenty/cmdrservice 3.3.1 → 3.5.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.4.0...@quenty/cmdrservice@3.5.0) (2021-12-09)
+
+
+### Features
+
+* CmdrService allows access to cmdr via /cmdr for mobile access ([ee9e233](https://github.com/Quenty/NevermoreEngine/commit/ee9e233862805bcbfc8c3c0a2698f405ba8c65cc))
+
+
+
+
+
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.3.1...@quenty/cmdrservice@3.4.0) (2021-12-05)
+
+
+### Features
+
+* Make CmdrService allow dynamically binding commands ([d4a0de8](https://github.com/Quenty/NevermoreEngine/commit/d4a0de8ccb4b791185ab0020bb7efe23d71501de))
+
+
+
+
+
 ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.3.0...@quenty/cmdrservice@3.3.1) (2021-12-04)
 
 **Note:** Version bump only for package @quenty/cmdrservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/cmdrservice",
-  "version": "3.3.1",
+  "version": "3.5.0",
   "description": "Bridge between cmdr and Nevermore services using servicebag",
   "keywords": [
     "Roblox",
@@ -29,7 +29,8 @@
     "@quenty/permissionprovider": "^4.3.1",
     "@quenty/promise": "^3.2.0",
     "@quenty/remoting": "^3.2.0",
-    "@quenty/servicebag": "^3.2.1"
+    "@quenty/servicebag": "^3.2.1",
+    "@quenty/templateprovider": "^3.4.0"
   },
   "peerDependencies": {
     "@quentystudios/cmdr": "^1.8.4-quenty.1"
@@ -37,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a0583027b100d718bce1603ec6c525ad99adeeac"
+  "gitHead": "adc1a4962fffcccc7f55411ebed6c9306d86dac6"
 }

package/src/Client/CmdrServiceClient.lua

@@ -1,24 +1,31 @@
----
+--- Loads cmdr on the client
 -- @module CmdrServiceClient
 -- @author Quenty
 
 local require = require(script.Parent.loader).load(script)
 
 local ReplicatedStorage = game:GetService("ReplicatedStorage")
+local Players = game:GetService("Players")
 
 local promiseChild = require("promiseChild")
 local PromiseUtils = require("PromiseUtils")
 local PermissionServiceClient = require("PermissionServiceClient")
+local Maid = require("Maid")
+local String = require("String")
 
 local CmdrServiceClient = {}
 
 function CmdrServiceClient:Init(serviceBag)
-	assert(serviceBag, "No serviceBag")
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
 
+	self._maid = Maid.new()
 	self._permissionService = serviceBag:GetService(PermissionServiceClient)
 end
 
 function CmdrServiceClient:Start()
+	assert(self._serviceBag, "Not initialized")
+
 	PromiseUtils.all({
 		self:PromiseCmdr(),
 		self._permissionService:PromisePermissionProvider()
@@ -28,14 +35,31 @@ function CmdrServiceClient:Start()
 	})
 	:Then(function(cmdr, isAdmin)
 		if isAdmin then
-			cmdr:SetActivationKeys({ Enum.KeyCode.F2 })
+			self:_setBindings(cmdr)
 		else
 			cmdr:SetActivationKeys({})
 		end
 	end)
 end
 
+function CmdrServiceClient:_setBindings(cmdr)
+	cmdr:SetActivationUnlocksMouse(true)
+	cmdr:SetActivationKeys({ Enum.KeyCode.F2 })
+
+	-- enable activation on mobile
+	self._maid:GiveTask(Players.LocalPlayer.Chatted:Connect(function(chat)
+		if String.startsWith(chat, "/cmdr") then
+			cmdr:Show()
+		end
+	end))
+
+	-- Default blink for debugging purposes
+	cmdr.Dispatcher:Run("bind", Enum.KeyCode.G.Name, "blink")
+end
+
 function CmdrServiceClient:PromiseCmdr()
+	assert(self._serviceBag, "Not initialized")
+
 	if self._cmdrPromise then
 		return self._cmdrPromise
 	end

package/src/Server/CmdrService.lua

@@ -4,19 +4,30 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local HttpService = game:GetService("HttpService")
+
 local PermissionService = require("PermissionService")
+local CmdrTemplateProviderServer = require("CmdrTemplateProviderServer")
 local Promise = require("Promise")
 
 local CmdrService = {}
 
+local GLOBAL_REGISTRY = setmetatable({}, {__mode = "kv"})
+
 function CmdrService:Init(serviceBag)
 	assert(not self._cmdr, "Already initialized")
 
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._cmdrTemplateProviderServer = self._serviceBag:GetService(CmdrTemplateProviderServer)
+
+	self._serviceId = HttpService:GenerateGUID(false)
 	self._cmdr = require("Cmdr")
-	self._cmdr:RegisterDefaultCommands()
 
 	self._permissionService = serviceBag:GetService(PermissionService)
 
+	self._definitionData = {}
+	self._executeData = {}
+
 	self._cmdr.Registry:RegisterHook("BeforeRun", function(context)
 		local providerPromise = self._permissionService:PromisePermissionProvider()
 		if providerPromise:IsPending() then
@@ -32,6 +43,12 @@ function CmdrService:Init(serviceBag)
 			return "You don't have permission to run this command"
 		end
 	end)
+
+	GLOBAL_REGISTRY[self._serviceId] = self
+end
+
+function CmdrService:Start()
+	self._cmdr:RegisterDefaultCommands()
 end
 
 function CmdrService:PromiseCmdr()
@@ -40,4 +57,63 @@ function CmdrService:PromiseCmdr()
 	return Promise.resolved(self._cmdr)
 end
 
+function CmdrService:RegisterCommand(commandData, execute)
+	assert(self._cmdr, "Not initialized")
+	assert(commandData, "No commandData")
+	assert(commandData.Name, "No commandData.Name")
+	assert(execute, "No execute")
+
+	local commandId = ("%s_%s"):format(commandData.Name, HttpService:GenerateGUID(false))
+
+	self._definitionData[commandId] = commandData
+	self._executeData[commandId] = execute
+
+	local commandServerScript = self._cmdrTemplateProviderServer:Clone("CmdrExecutionTemplate")
+	commandServerScript.Name = ("%sServer"):format(commandId)
+
+	local cmdrServiceTarget = Instance.new("ObjectValue")
+	cmdrServiceTarget.Name = "CmdrServiceTarget"
+	cmdrServiceTarget.Value = script
+	cmdrServiceTarget.Parent = commandServerScript
+
+	local cmdrServiceId = Instance.new("StringValue")
+	cmdrServiceId.Name = "CmdrServiceId"
+	cmdrServiceId.Value = self._serviceId
+	cmdrServiceId.Parent = commandServerScript
+
+	local cmdrCommandId = Instance.new("StringValue")
+	cmdrCommandId.Name = "CmdrCommandId"
+	cmdrCommandId.Value = commandId
+	cmdrCommandId.Parent = commandServerScript
+
+	local commandScript = self._cmdrTemplateProviderServer:Clone("CmdrCommandDefinitionTemplate")
+	commandScript.Name = commandId
+
+	local cmdrJsonCommandData = Instance.new("StringValue")
+	cmdrJsonCommandData.Value = HttpService:JSONEncode(commandData)
+	cmdrJsonCommandData.Name = "CmdrJsonCommandData"
+	cmdrJsonCommandData.Parent = commandScript
+
+	self._cmdr.Registry:RegisterCommand(commandScript, commandServerScript)
+end
+
+function CmdrService:__ExecuteCommand(id, ...)
+	assert(type(id) == "string", "Bad serviceId")
+	assert(self._cmdr, "Not initialized")
+
+	local execute = self._executeData[id]
+	if not execute then
+		error(("[CmdrService] - No command definition for id %q"):format(tostring(id)))
+	end
+
+	return execute(...)
+end
+
+-- Global, but only intended for internal use
+function CmdrService:__GetServiceFromId(id)
+	assert(type(id) == "string", "Bad serviceId")
+
+	return GLOBAL_REGISTRY[id]
+end
+
 return CmdrService

package/src/Server/CmdrTemplateProviderServer/CmdrCommandDefinitionTemplate.lua

@@ -0,0 +1,7 @@
+--- Generic command definition template
+-- @module CmdrCommandDefinitionTemplate
+
+local HttpService = game:GetService("HttpService")
+
+local value = script:WaitForChild("CmdrJsonCommandData")
+return HttpService:JSONDecode(value.Value)

package/src/Server/CmdrTemplateProviderServer/CmdrExecutionTemplate.lua

@@ -0,0 +1,20 @@
+--- Generic command definition template
+-- @module CmdrCommandDefinitionTemplate
+
+local function waitForValue(objectValue)
+	local value = objectValue.Value
+	if value then
+		return value
+	end
+
+	return objectValue.Changed:Wait()
+end
+
+local cmdrServiceId = waitForValue(script:WaitForChild("CmdrServiceId"))
+local cmdrCommandId = waitForValue(script:WaitForChild("CmdrCommandId"))
+local commandServiceDefinition = require(waitForValue(script:WaitForChild("CmdrServiceTarget")))
+local cmdrService = commandServiceDefinition:__GetServiceFromId(cmdrServiceId)
+
+return function(...)
+	return cmdrService:__ExecuteCommand(cmdrCommandId, ...)
+end

package/src/Server/CmdrTemplateProviderServer/init.lua

@@ -0,0 +1,9 @@
+--- Retrieves CmdrTemplateProviderServer
+-- @module CmdrTemplateProviderServer
+-- @author Quenty
+
+local require = require(script.Parent.loader).load(script)
+
+local TemplateProvider = require("TemplateProvider")
+
+return TemplateProvider.new(script)

package/test/default.project.json

@@ -1,12 +1,7 @@
 {
-  "name": "cmdrservicetest",
+  "name": "CmdrServiceTest",
   "tree": {
     "$className": "DataModel",
-    "ReplicatedStorage": {
-      "Nevermore": {
-        "$path": "../node_modules/@quenty/loader"
-      }
-    },
     "ServerScriptService": {
       "cmdrservice": {
         "$path": ".."

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

@@ -17,3 +17,29 @@ serviceBag:GetService(require(serverFolder.CmdrService))
 
 serviceBag:Init()
 serviceBag:Start()
+
+serviceBag:GetService(require(serverFolder.CmdrService)):RegisterCommand({
+	Name = "explode";
+	Aliases = { "boom" };
+	Description = "Makes players explode";
+	Group = "Admin";
+	Args = {
+		{
+			Type = "players";
+			Name = "players";
+			Description = "Victims";
+		},
+	};
+}, function(_context, players)
+	for _, player in pairs(players) do
+		local humanoid = player.Character and player.Character:FindFirstChildWhichIsA("Humanoid")
+		local humanoidRootPart = humanoid and humanoid.RootPart
+		if humanoidRootPart then
+			local explosion = Instance.new("Explosion")
+			explosion.Position = humanoidRootPart.Position
+			explosion.Parent = humanoidRootPart
+		end
+	end
+
+	return "Exploded!"
+end)