cluaupp 0.1.0

package/runtime/Cmdr/CmdrClient/init.luau

@@ -0,0 +1,377 @@
+const RunService = game:GetService("RunService")
+
+const IS_CLIENT = RunService:IsClient()
+assert(
+	IS_CLIENT,
+	"[Cmdr] The Cmdr client library cannot be required by the server. Please require the server libary instead."
+)
+
+const Dispatcher = require("@self/Shared/Dispatcher")
+const Registry = require("@self/Shared/Registry")
+const Util = require("@self/Shared/Util")
+
+const CmdrInterface = require("@self/CmdrInterface")
+const DefaultEventHandlers = require("@self/DefaultEventHandlers")
+
+const TYPES_FOLDER = script:WaitForChild("Types") :: Folder
+const COMMANDS_FOLDER = script:WaitForChild("Commands") :: Folder
+
+type Signal = {
+	Fire: (self: Signal, ...any) -> (),
+	Connect: (self: Signal, callback: (...any) -> ()) -> RBXScriptConnection,
+}
+
+const function createSignal(): Signal
+	const event = Instance.new("BindableEvent")
+
+	return {
+		Fire = function(_, ...)
+			event:Fire(...)
+		end,
+
+		Connect = function(_, callback)
+			return event.Event:Connect(callback)
+		end,
+	}
+end
+
+--[=[
+	@class CmdrClient
+	@client
+
+	The Cmdr client object and entry point.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+
+	@prop Registry Registry
+
+	Refers to the command Registry.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+
+	@prop Dispatcher Dispatcher
+
+	Refers to the command Dispatcher.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+
+	@prop Util Util
+
+	Refers to a table containing many useful utility functions.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+
+	@prop Gui ScreenGui
+
+	Refers to the current Cmdr GUI.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+
+	@prop Toggled { Connect: (self: Toggled, callback: (visible: boolean) -> ()) -> RBXScriptConnection, Fire: (self: Toggled, visible: boolean) -> () }
+
+	A signal that fires when the Cmdr window is toggled.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _interface CmdrInterface
+
+	Refers to the CmdrInterface object.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _replicatedRoot ModuleScript
+
+	Refers to the CmdrClient modulescript containing all shared functionality.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _remoteEvent RemoteEvent
+
+	Refers to the CmdrEvent RemoteEvent found within CmdrClient.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _remoteFunction RemoteFunction
+
+	Refers to the CmdrFunction RemoteFunction found within CmdrClient.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _enabled boolean
+
+	Whether or not Cmdr is enabled (will show via the defined activation keys). Use [`CmdrClient:SetEnabled`](#SetEnabled) to change.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _activationKeys { [Enum.KeyCode] = true }
+
+	The list of key codes that will show or hide Cmdr. Use [`CmdrClient:SetActivationKeys`](#SetActivationKeys) to change.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _activationUnlocksMouse boolean
+
+	Whether or not acitvating the Cmdr window will unlock the mouse.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _mashToEnable boolean
+
+	Whether or not mashing to enabled is enabled. Use [`CmdrClient:SetMashToEnable`](#SetMashToEnable) to change.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _hideOnLostFocus boolean
+
+	Whether or not loosing focus will hide the Cmdr window.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _placeName string
+
+	The current place name, displayed on the interface. Use [`CmdrClient:SetPlaceName`](#SetPlaceName) to change.
+]=]
+
+--[=[
+	@within CmdrClient
+	@readonly
+	@private
+
+	@prop _events { [string]: (any) -> () }
+
+	A collection of event callbacks used by Cmdr.
+]=]
+
+const CmdrClient = {
+	Registry = nil :: Registry.Registry?,
+	Dispatcher = nil :: any,
+	Util = Util,
+
+	Gui = nil :: ScreenGui?,
+	Toggled = createSignal(),
+
+	_interface = nil :: any,
+
+	_replicatedRoot = script,
+	_remoteEvent = script:WaitForChild("CmdrEvent") :: RemoteEvent,
+	_remoteFunction = script:WaitForChild("CmdrFunction") :: RemoteFunction,
+
+	_enabled = true,
+	_activationKeys = { Enum.KeyCode.F2 },
+	_activationUnlocksMouse = false,
+	_mashToEnable = false,
+	_hideOnLostFocus = true,
+
+	_placeName = "Cmdr",
+
+	_events = {} :: { [string]: (any) -> () },
+}
+
+--[=[
+	@within CmdrClient
+	Sets whether or not Cmdr can be shown via the defined activation keys. Useful for when you want users to opt-in to show the console, for instance in a settings menu.
+]=]
+function CmdrClient:SetEnabled(enabled: boolean)
+	self._enabled = enabled
+end
+
+--[=[
+	@within CmdrClient
+	Sets the key codes that will used to toggle Cmdr.
+]=]
+function CmdrClient:SetActivationKeys(keys: { Enum.KeyCode })
+	self._activationKeys = keys
+end
+
+--[=[
+	@within CmdrClient
+	Sets if activation will free the mouse.
+]=]
+function CmdrClient:SetActivationUnlocksMouse(enabled: boolean)
+	self._activationUnlocksMouse = enabled
+end
+
+--[=[
+	@within CmdrClient
+	Shows the Cmdr window. Does nothing if Cmdr isn't enabled.
+]=]
+function CmdrClient:Show()
+	if not self._enabled then
+		return
+	end
+
+	self._interface.Window:Show()
+end
+
+--[=[
+	within CmdrClient
+	Hides the Cmdr window.
+]=]
+function CmdrClient:Hide()
+	self._interface.Window:Hide()
+end
+
+--[=[
+	@within CmdrClient
+	Toggles the Cmdr window. Does nothing if Cmdr isn't enabled.
+]=]
+function CmdrClient:Toggle()
+	if not self._enabled then
+		self:Hide()
+		return
+	end
+
+	self._interface.Window:SetVisible(not self._interface.Window:IsVisible())
+end
+
+--[=[
+	@within CmdrClient
+	Enables the "Mash to enable" feature.
+	This feature, when enabled, requires the [activation key](#SetActivationKeys) to be pressed 5 times within a second to enable Cmdr.
+	This may be helpful to guard against mispresses from opening the window, for example.
+]=]
+function CmdrClient:SetMashToEnable(enabled: boolean)
+	self._mashToEnable = enabled
+end
+
+--[=[
+	@within CmdrClient
+	Sets the hide on 'lost focus' feature.
+	This feature, which is enabled by default, will cause Cmdr to [hide](#Hide) when the user clicks off the window.
+]=]
+function CmdrClient:SetHideOnLostFocus(enabled: boolean)
+	self._hideOnLostFocus = enabled
+end
+
+--[=[
+	@within CmdrClient
+	Sets the place name label on the interface. This is useful for a quick way to tell what game you're playing in a universe game.
+]=]
+function CmdrClient:SetPlaceName(name: string)
+	self._placeName = name
+	self._interface.Window:UpdateLabelText()
+end
+
+--[=[
+	@within CmdrClient
+	Sets the [network event handler](/docs/networkeventhandlers) for a certain event type.
+]=]
+function CmdrClient:HandleEvent(name: string, callback: (...any) -> ())
+	self._events[name] = callback
+end
+
+-- Initialize CmdrClient
+const function initialize()
+	CmdrClient.Registry = Registry(CmdrClient)
+	CmdrClient.Dispatcher = Dispatcher(CmdrClient)
+	CmdrClient._interface = CmdrInterface(CmdrClient)
+
+	CmdrClient._remoteEvent.OnClientEvent:Connect(function(eventName: string, ...)
+		if not CmdrClient._events[eventName] then
+			return
+		end
+
+		CmdrClient._events[eventName](...)
+	end)
+
+	CmdrClient.Registry:RegisterTypesIn(TYPES_FOLDER)
+	CmdrClient.Registry:RegisterCommandsIn(COMMANDS_FOLDER)
+
+	TYPES_FOLDER.ChildAdded:Connect(function(child: Instance)
+		if not child:IsA("ModuleScript") then
+			warn(`[Cmdr] Ignored non-module child in Types: {child.Name}`)
+			return
+		end
+
+		require(child)(CmdrClient.Registry)
+	end)
+
+	COMMANDS_FOLDER.ChildAdded:Connect(function(child: Instance)
+		if not child:IsA("ModuleScript") then
+			warn(`[Cmdr] Ignored non-module child in Commands: {child.Name}`)
+			return
+		end
+
+		CmdrClient.Registry:RegisterCommand(child)
+	end)
+end
+
+initialize()
+DefaultEventHandlers(CmdrClient)
+
+-- Export CmdrClient
+return setmetatable(CmdrClient, {
+	__index = function(self, key)
+		const dispatcher = rawget(self, "Dispatcher")
+		const value = dispatcher and dispatcher[key]
+		assert(value, `[Cmdr] Dispatcher has no method or property "{key}".`)
+
+		if type(value) == "function" then
+			Util:_emitDeprecationWarning("ProxyCalls")
+
+			return function(_, ...)
+				return value(dispatcher, ...)
+			end
+		end
+
+		return nil
+	end,
+	__newindex = function(_, key)
+		error(`[Cmdr] Cannot assign key "{key}"; the CmdrClient object is read-only.`)
+	end,
+})

package/runtime/Cmdr/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Eryn L. K.
+
+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/runtime/Cmdr/_impl/BuiltInCommands/Admin/announce.luau

@@ -0,0 +1,21 @@
+const ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+const BuiltInGuards = ReplicatedStorage.CmdrClient.Shared.BuiltInGuards
+const NonEmptyString = require(BuiltInGuards.NonEmptyString) :: (number) -> (any) -> string?
+
+return {
+	Name = "announce",
+	Aliases = { "m" },
+	Description = "Makes a server-wide announcement.",
+	Group = "DefaultAdmin",
+	Args = {
+		{
+			Type = "string",
+			Name = "Text",
+			Description = "The announcement text.",
+		},
+	},
+	Guards = {
+		NonEmptyString(1),
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/announceServer.luau

@@ -0,0 +1,17 @@
+const TextService = game:GetService("TextService")
+
+return function(context: any, text: string): string
+	const filterSuccess, filteredText = pcall(function()
+		const filterResult =
+			TextService:FilterStringAsync(text, context.Executor.UserId, Enum.TextFilterContext.PublicChat)
+
+		return filterResult:GetNonChatStringForBroadcastAsync()
+	end)
+
+	if not filterSuccess then
+		return `Failed to filter announcement: {filteredText}`
+	end
+
+	context:BroadcastEvent("Message", filteredText, context.Executor)
+	return "Created announcement."
+end

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/ban.luau

@@ -0,0 +1,59 @@
+const ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+const BuiltInGuards = ReplicatedStorage.CmdrClient.Shared.BuiltInGuards
+const MaxArrayLength = require(BuiltInGuards.MaxArrayLength) :: (number, number) -> (any) -> string?
+const MaxStringLength = require(BuiltInGuards.MaxStringLength) :: (number, number) -> (any) -> string?
+const NonEmptyString = require(BuiltInGuards.NonEmptyString) :: (number) -> (any) -> string?
+
+return {
+	Name = "ban",
+	Description = "Bans a player or set of players.",
+	Group = "DefaultAdmin",
+	Args = {
+		{
+			Type = "playerIds",
+			Name = "Players",
+			Description = "The players to ban (max 50).",
+		},
+		{
+			Type = "duration",
+			Name = "Duration",
+			Description = "How long the ban lasts (negative values indicate a permanent ban).",
+		},
+		{
+			Type = "string",
+			Name = "Public reason",
+			Description = "Ban message shown to the player.",
+		},
+		{
+			Type = "string",
+			Name = "Private reason",
+			Description = "Internal staff notes for ban history.",
+			Optional = true,
+		},
+		{
+			Type = "boolean",
+			Name = "Exclude alt accounts",
+			Description = "Skip banning their alternate accounts.",
+			Default = false,
+		},
+		{
+			Type = "boolean",
+			Name = "Apply to universe",
+			Description = "Ban from all places in this experience.",
+			Default = true,
+		},
+		{
+			Type = "boolean",
+			Name = "Apply device block",
+			Description = "Block their device from rejoining for 24 hours.",
+			Default = false,
+		},
+	},
+	Guards = {
+		MaxArrayLength(1, 50),
+		NonEmptyString(3),
+		MaxStringLength(3, 400),
+		MaxStringLength(4, 1000),
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/banServer.luau

@@ -0,0 +1,30 @@
+const Players = game:GetService("Players")
+
+return function(
+	_,
+	playerIds: { number },
+	duration: number,
+	displayReason: string,
+	privateReason: string?,
+	excludeAltAccounts: boolean,
+	applyToUniverse: boolean,
+	applyDeviceBlock: boolean
+): string
+	const resolvedPrivateReason = if not privateReason or privateReason:match("^%s*$")
+		then displayReason
+		else privateReason
+
+	const resolvedDuration = if duration < 1 and duration ~= -1 then -1 else duration
+
+	const success, errorMessage = pcall(Players.BanAsync, Players, {
+		UserIds = playerIds,
+		Duration = resolvedDuration,
+		DisplayReason = displayReason,
+		PrivateReason = resolvedPrivateReason,
+		ExcludeAltAccounts = excludeAltAccounts,
+		ApplyToUniverse = applyToUniverse,
+		ApplyDeviceBlock = applyDeviceBlock,
+	})
+
+	return if success then `Banned {#playerIds} players.` else `BanAsync failed: {errorMessage}`
+end

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/gotoPlace.luau

@@ -0,0 +1,35 @@
+const ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+const BuiltInGuards = ReplicatedStorage.CmdrClient.Shared.BuiltInGuards
+const NotEquals = require(BuiltInGuards.NotEquals) :: (number, any) -> (any) -> string?
+
+return {
+	Name = "goto-place",
+	Description = "Teleport to a Roblox place.",
+	Group = "DefaultAdmin",
+	AutoExec = {
+		'alias "follow-player|Join a player in another server." goto-place $1{players|Players|The players to teleport.} ${{get-player-place-instance $2{playerId|Target|The player you want to follow.}}}',
+		'alias "rejoin|Rejoin this place. You might end up in a different server." goto-place $1{players|Players|The players to teleport.} ${get-player-place-instance ${me} PlaceId}',
+	},
+	Args = {
+		{
+			Type = "players",
+			Name = "Players",
+			Description = "The players to teleport.",
+		},
+		{
+			Type = "positiveInteger",
+			Name = "Place ID",
+			Description = "The Place ID to teleport to.",
+		},
+		{
+			Type = "string",
+			Name = "JobId",
+			Description = "The JobId to teleport to.",
+			Optional = true,
+		},
+	},
+	Guards = {
+		NotEquals(3, "-"),
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/gotoPlaceServer.luau

@@ -0,0 +1,17 @@
+const TeleportService = game:GetService("TeleportService")
+
+return function(context: any, players: { Player }, placeId: number, jobId: string?): string
+	context:Reply("Commencing teleport...")
+
+	const success, errorMessage = pcall(function()
+		if jobId then
+			const options = Instance.new("TeleportOptions")
+			options.ServerInstanceId = jobId
+			TeleportService:TeleportAsync(placeId, players, options)
+		else
+			TeleportService:TeleportAsync(placeId, players)
+		end
+	end)
+
+	return if success then "Teleported." else `Teleport failed: {errorMessage}`
+end

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/kick.luau

@@ -0,0 +1,19 @@
+return {
+	Name = "kick",
+	Aliases = { "boot" },
+	Description = "Kicks a player or set of players.",
+	Group = "DefaultAdmin",
+	Args = {
+		{
+			Type = "players",
+			Name = "Players",
+			Description = "The players to kick.",
+		},
+		{
+			Type = "string",
+			Name = "Reason",
+			Description = "Kick message shown to the players.",
+			Default = "No reason provided",
+		},
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/kickServer.luau

@@ -0,0 +1,27 @@
+const TextService = game:GetService("TextService")
+
+return function(context: any, players: { Player }, reason: string): string
+	if reason:match("^%s*$") then
+		reason = "No reason provided"
+	end
+
+	local filterSuccess, filteredReason = nil, reason
+	if reason ~= "No reason provided" then
+		filterSuccess, filteredReason = pcall(function()
+			const filterResult =
+				TextService:FilterStringAsync(reason, context.Executor.UserId, Enum.TextFilterContext.PublicChat)
+
+			return filterResult:GetNonChatStringForBroadcastAsync()
+		end)
+
+		if not filterSuccess then
+			return `Failed to filter reason: {filteredReason}`
+		end
+	end
+
+	for _, player in ipairs(players) do
+		player:Kick(filteredReason)
+	end
+
+	return `Kicked {#players} players.`
+end

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/kill.luau

@@ -0,0 +1,13 @@
+return {
+	Name = "kill",
+	Aliases = { "slay" },
+	Description = "Kills a player or set of players.",
+	Group = "DefaultAdmin",
+	Args = {
+		{
+			Type = "players",
+			Name = "victims",
+			Description = "The players to kill.",
+		},
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/killServer.luau

@@ -0,0 +1,13 @@
+return function(_, players: { Player }): string
+	for _, player in ipairs(players) do
+		const character = player.Character
+		const humanoid = character and character:FindFirstChildWhichIsA("Humanoid")
+		if not humanoid then
+			continue
+		end
+
+		humanoid.Health = 0
+	end
+
+	return `Killed {#players} players.`
+end

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/respawn.luau

@@ -0,0 +1,15 @@
+return {
+	Name = "respawn",
+	Description = "Respawns a player or a group of players.",
+	Group = "DefaultAdmin",
+	AutoExec = {
+		'alias "refresh|Respawns the player and returns them to their previous location." var= .refresh_pos ${position $1{player|Player|The players to refresh.}} && respawn $1 && tp $1 @${{var .refresh_pos}}',
+	},
+	Args = {
+		{
+			Type = "players",
+			Name = "targets",
+			Description = "The players to respawn.",
+		},
+	},
+}

package/runtime/Cmdr/_impl/BuiltInCommands/Admin/respawnServer.luau

@@ -0,0 +1,7 @@
+return function(_, players: { Player }): string
+	for _, player in ipairs(players) do
+		task.spawn(pcall, player.LoadCharacterAsync, player)
+	end
+
+	return `Respawned {#players} players.`
+end