Skip to content

VSC Extension Explained

Dervex edited this page Oct 30, 2023 · 10 revisions

Menu

To open menu press F1, start typing open menu and select Argon: Open Menu.

Run/Stop Argon

This option starts and stops local server. If you have Auto Run setting enabled you will never need to use this.

Open Argon Settings

This option shows you all available extension Settings.

Execute Snippet

This option executes current selection or whole file inside Roblox Studio's command bar. This action is bound to F6 key. You can disable auto window switching using Snippet Execution Mode setting.

Start Debugging

Switches window to Roblox Studio and starts playtest in client, server or multi-client mode. These actions are bound to F5, F8 and F7 keys.

Launch Roblox Studio

Opens new Roblox Studio instances. This option can be executed automatically when opening VSC using with Auto Launch Studio setting.


Settings

Directories > Compatibility Mode

Enables support for external tooling (uses Rojo namespace). Changes .source files to init and .properties files to init.meta.

[Default: disabled]

Directories > Extension

Changes default file extension (.lua or .luau) for scripts. Used only in Port to VS Code tool.

[Default: .lua]

Directories > Project File

Changes prefix of the Project File name. If using Compatibility Mode this setting will be changed to default if left default.

[Default: .argon]

Directories > Root Folder

Changes name of the root folder which contains whole project.

[Default: src]

Extension > Auto Launch Studio

If enabled Roblox Studio will launch automatically only if there is no other Roblox studio instance running.

[Default: disabled]

Extension > Auto Run

If enabled extension will automatically run and start local server.

[Default: enabled]

Extension > Auto Setup

If enabled Argon will create Root Folder and Project File automatically.

[Default: enabled]

Extension > Hide Notifications

Hides notifications in the bottom right corner.

[Default: disabled]

Extension > Open In Preview

If enabled scripts will be opened in preview mode (temporarily open, if you open other script previous one will close). This setting only affects Only Code Mode.

[Default: enabled]

Extension > Remove Studio Icon

Every time VSC is opened or closed Argon will try to remove Roblox Studio desktop shortcut that gets created automatically every Roblox update.

[Default: disabled]

Extension > Snippet Execution Mode

If enabled Argon will switch window to Roblox Studio before executing snippet.

[Default: enabled]

Server > Host

The host that server should be running on.

[Default: localhost]

Server > Port

The port that server should be running on.

[Default: 8000]


Stats Bar Icons

Argon displays current connection status in the bottom left corner, and there is meaning of every icon:
image - Argon is enabled, server is NOT running
image - Argon is enabled, server is running, client is NOT connected
3 - Argon is enabled, server is running, client is connected


Project File

Argon uses .argon.project.json (or default.project.json in Compatibility Mode) to support external tooling such as Roblox LSP. Prefix of this file can be customized with Project File setting. There are two variables that are customizable:

  • name - changes name of the project and dynamic title on plugin header. By default Argon uses VSC workspace name but if you change Argon to something different it will be used instead.
  • tree - changes paths to the user-specified services/instances. Let's say you want redirect folder Packages inside ReplicatedStorage to your VSC workspace folder (not inside src folder). Then your project file would look like this:
{
    "tree": {
        "ReplicatedStorage": {
            "$path": "src/ReplicatedStorage",
            "Packages": {
                "$path": "Packages"
            }
        }
    }
}

Custom File Icon Theme

Argon comes with custom file icon theme that matches Roblox's icons, you can enable it by pressing: F1 -> Preferences: File Icon Theme -> Argon. Here is how it looks:

image