Set-up
Once you've installed CmdrX, you'll need to set it up on both the server and client to get running. Your setup code could exist within your existing codebase (for instance, if you use a framework) or it could be done with simple scripts.
There are plenty of resources available to help you with CmdrX, such as this website and our Discord server, but we've been made aware of a number of DevForum guides and YouTube videos which provide incorrect or outdated instructions.
We recommend you stick to our official resources, especially if you're new to CmdrX. If you decide to use unofficial resources, then the level of support we can provide (for instance in our Discord server) is limited.
Modifying the source code
Please do not modify the source code of CmdrX for your game. Instead, use its API to customise the behaviour you want. Modifying the source code makes it much harder for you to receive future updates.
There shouldn't be any reason why you need to modify the source code of CmdrX (unless you're adding a new feature or fixing a bug). If there's something you think we're missing, please open an issue.
Modifying the source code also includes putting your commands within CmdrX's BuiltInCommands folder; don't do it. You should never touch the CmdrX library or any of its components outside of code.
Server setup
You should create a folder to keep your commands inside and then register them on the server. You only need to register commands, types and hooks on the server: CmdrX will automatically handle replication for you. There is no need to modify the actual CmdrX library itself.
-- This is a script you would create in ServerScriptService, for example
local ServerScriptService = game:GetService("ServerScriptService")
local CmdrX = require(path.to.CmdrX) -- e.g. ServerScriptService.Libs.CmdrX
CmdrX.Registry:RegisterDefaultCommands() -- Optional: This loads the default set of commands that CmdrX comes with.
-- CmdrX.Registry:RegisterCommandsIn(ServerScriptService.CmdrXCommands) -- Optional: Register commands from your own folder.
-- You can also register types or hooks here: read on or check the API reference!
The CmdrX object is the main server singleton. The Registry is used on both the client and server, and it keeps track of all the commands, types and hooks that CmdrX knows about.
CmdrX will automatically create and insert into StarterGui its console interface (called Window). If you'd like to (optionally) customise the look of the Window, we have a guide on this in our Advanced section.
CmdrX will also insert into ReplicatedStorage the CmdrXClient module. On top of being the client entry point (read on below!), this module also houses stuff for internal use, like replication (any commands, types and hooks the client needs to know about) and networking.
Client setup is also required, you need to register CmdrX on the server and client for it to load. Keep going! ↓
Client setup
From the client, you'll need to require the CmdrXClient module.
CmdrX will place CmdrXClient into ReplicatedStorage automatically, no action is required from you. This module includes things used by CmdrX internally, but also provides you - the developer - with methods to customise and tweak CmdrX.
-- This is a local/client script you would create in StarterPlayerScripts, for example
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local CmdrX = require(ReplicatedStorage:WaitForChild("CmdrXClient"))
-- Optional. Configurable, and you can choose multiple keys
CmdrX:SetActivationKeys({ Enum.KeyCode.F2 })
-- You can call any extra methods here, like SetPlaceName, or access the registry to register a hook on the client only (if you want to!)
Activation keys are used to show or hide CmdrX. By default, this is just F2 but you can have as many or as few keys as you'd like (even none).
Next steps
By now, CmdrX is up and running, and will work fine in studio. However, you'll probably want to write your own commands and to run any commands in a live server, you must create a BeforeRun hook.
If you ever need help, you can check the support page.