Packages

conch

Connects the vm, compiler, parser and analysis into a useable package. This should be the entry point to every conch installation on Roblox.

pesde wally

conch_ui

This implements a basic UI written in Vide built on top of the api's exposed by conch

pesde wally

conch_analysis

Implements the analysis parts of conch and is used to handle autocomplete and suggestions.

pesde wally

conch_ast

Implements the parser that generates the abstract syntax tree necessary for Conch's language.

pesde wally

conch_compiler

Implements the compiler that converts the language into bytecode.

pesde wally

conch_types

Contains types for Conch's parser, analysis, compiler and vm.

pesde wally

conch_standalone

Exclusive to the rbxm install of conch, conch_standalone bundles conch so that it's all self-contained. It inherits conch, but adds the ui part of conch under conch.ui.

conch_vm

Implements the conch virtual machine which is used to execute the bytecode generated by the compiler.

pesde wally

Conch

Main Page

conch.register

Registers a new command that can be executed by any user.

conch.register_type

Registers a new type that can then be displayed on both the client and server. This is primarily useful for people wanting to add their own

conch.initiate_default_lifecycle

Initiates conch and creates the necessary connections so that everything works properly.

conch.set_role_permissions

Used by the role system, this allows you to give a set amount of permissions to a specific role. It's recommended to keep all roles and permissions stored inside a module

conch.has_permissions

Allows you to check if a user has the required permissions to perform a certain command. You can use this to limit the extent that commands can be used for certain roles.

conch.get_command_context

Returns information about the currently executing command, like the executing user. This will be available within the thread the command executes in.

UI

Main Page

ui.bind_to

Binds the activation of Conch's UI to the given UserInput or KeyCode enum. This also conveniently mounts the UI if it hasn't been mounted yet.

ui.opened

An exposed vide source that stores the state of the UI. When called with a boolean, it updates the state of the UI to that boolean. Otherwise, it would return the stored boolean.