User:Anaminus/CmdUtl

CmdUtl ("Command Utility") is a set of tools and functions that enhance the user's building experience in Roblox Studio. CmdUtl can be accessed from within the studio without using solo mode, and (generally) leaves behind no trace of itself when your place is saved. CmdUtl comes in two parts: a GUI panel, and command functions.

The Utility Panel contains an assortment of tools that allow the direct interaction and manipulation of selected objects in the 3D space.

The Command Line functions are built for use with the command toolbar. While most commands are used for manipulating selected objects, their real purpose is to speed up or shorten long or repetitive tasks.

CmdUtl is open source, and you are free to copy, modify, and redistribute it where ever you want. In fact, it's encouraged.

Source

• Roblox Model (v3.0.0) (includes basic documentation)
• Pastebin (v3.0.0)

Setting up CmdUtl

Setting up CmdUtl is rather simple:

1. Open up your preferred text editing program, such as Notepad
2. Copy the entire source code, and paste it into the text editor
3. Save the file in a folder you commonly access with Roblox Studio (such as your Places folder)
4. Save the file as "CmdUtl" or "CmdUtl.lua"

Your file should be successfully saved.

Executing CmdUtl

Running CmdUtl is also simple:

1. While in Roblox Studio, go to the Tools menu (at the top of the studio), and click on Execute Script...
2. Locate the "CmdUtl" file you saved in Setup
3. Open the file

CmdUtl should now be running (the Utility Panel should appear in the upper-left corner, and a message saying CmdUtl has loaded should display in the output).

Activating the Command Line

Once CmdUtl is running, the Command Line functions can be activated by running any of the following functions with the command bar:

• _G.CmdUtl()</syntaxhighlight>
• _G.cu()</syntaxhighlight>

For help with commands, use the help()</syntaxhighlight> command.

Adding Plugins

If you want to add a plugin:

1. Get the AssetId of the Model that contains the plugin
   1. Go to the webpage of the Model
   2. The URL should look something like "http://www.roblox.com/CmdUtl-Plugin-Name-item?id=1234567890"
   3. The numbers at the end (after "?id=") is the AssetId
2. Open the "CmdUtl" file you saved in your preferred text editing program
3. In the file, find the "plugins" table
4. Add the AssetId to that table (don't forget a comma!)
5. Save the file

The next time you run CmdUtl, the plugin should be added (assuming the plugin is valid).

Before using a plugin, make sure it doesn't do anything you feel would compromise your place!

Changes

v3.0.0

• Menus now stack in a list-like way
• Multiple menus can be open at once
• Tools can now have mappable shortcut keys
• Added support for plugins/plugin API
• Moved documentation to within CmdUtl
• Added full descriptions for tools
• Added help for command functions
• Added many config variables
• Resources are now disposed of more properly

v2.1.0

• Fixed FormFactor bug
• Added ability to close CmdUtl
• Any loaded CmdUtls are closed before loading it again

v2.0.0

• Utility Panel got a face lift
• Tools have been grouped into menus
• Made use of delicious tweening functions (can be turned off in super secret config)
• Added sounds for quick-firing tools (also turn off-able)
• Added axis snap locking
• Added dragging delta, which displays the unit change while dragging
• Resizing has been polished
• Changed/added/removed various tools
• Removed BrickColor tool and command (apparently extended colors don't render as intended online)
• Added joint breaking tool
• Added midpoint tool
• Polished command line functions
• Changed/added/removed various commands
• Added fset command

Bugs

If anything breaks, or there are errors in this documentation, send a private message to the user Anaminus, describing the situation. You may also send suggestions for improvement, such as a common building tasks you'd like to see apart of this model.

Documentation

Go to Futher Documentation for none other than further documentation.

Help for tools and commands are included with CmdUtl.

• For help with tools in the Utility Panel, click the Help (?) button. This will turn on Help Mode, which displays a description for each tool when you hover over it.
• For help with commands, type help()</syntaxhighlight> to display a list of possible commands, or help(command)</syntaxhighlight> to display help for a specific command.

Remarks

There's a problem involving GUI size and position. The panel may be scaled down, depending on the size of your screen. For now, either adjust the size of your game screen, or increase the size of the button_size_x</syntaxhighlight> and button_size_y</syntaxhighlight> config variables.