> For the complete documentation index, see [llms.txt](https://destplay.gitbook.io/pluginframework/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://destplay.gitbook.io/pluginframework/quick-start.md).

# Quick Start

{% hint style="info" %}
All you need to do is download the source. And you already have a ready-made basis for the plug-in.
{% endhint %}

## Download

Download from the dev forum:

{% embed url="<https://devforum.roblox.com/t/open-source-pluginframework-create-a-beautiful-gui-for-your-plug-in/1636465>" %}

## Play

Click to play.

![](https://1770016262-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqUSQB3cNmQ1GnmH5bFXg%2Fuploads%2FqHf00aGPwUxnP5XqKUWd%2Fimage.png?alt=media\&token=c167206e-c270-4ece-9061-6f6660832ab1)

And you will immediately get a local preview of the plugin. All its buttons will work.

{% embed url="<https://www.youtube.com/watch?v=Lun4vxNGDN4>" %}

## Now on to the settings

Open ReplicatedStorage.MyPlugin.Setting

![](https://1770016262-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqUSQB3cNmQ1GnmH5bFXg%2Fuploads%2FvqbxHhbhB9ZgmbQQYNje%2Fimage.png?alt=media\&token=92bdbd6b-e0b3-4679-a1b3-057cab963a83)

<details>

<summary>Setting module</summary>

```lua
local Setting = {}


--The indication of the plug-in. Must be unique for each plugin, and have the same name as the main folder
Setting.Ind = "MyPlugin";


--Start page that is displayed after the plugin has been started
Setting.PageStart = "Start";


--This allows you to select in which mode the plug-in is displayed. 
Setting.Run ={
    isStudio = true,
    isPlayMode = false,
}


--Window size settings
Setting.Window ={
    widthMin = 140,
    width = 346,
    
}


--What the icon looks like in the toolbar of roblox studios.
Setting.Toolbar = {
    Icon = "rbxassetid://6948627768",
    Name = "Your plagin name",    
    Descr = "Your description in bottom icon",      
};



--Which tabs will be displayed at the top of the plug-in. Each tab should lead to a page. 
Setting.Tabs = {
    Start = {
        Text = "Start",    
        Image = "rbxassetid://994425457",    
    },   
    Example6 = {
        Text = "Container",        
    },
 
};


--Do not change this parameter!!!
Setting.DEVELOP_LOCAL_MODE = false; 


 
 


return Setting

```

</details>

## Parameters

### .Ind

The indication of the plug-in. Must be unique for each plugin, and have the same name as the main folder

### .PageStart

Start page that is displayed after the plugin has been started

![](https://1770016262-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqUSQB3cNmQ1GnmH5bFXg%2Fuploads%2FDOGWMg3XQRsC0NMXklC4%2Fimage.png?alt=media\&token=cd697f0d-0723-415d-a33a-c8e05288173d)

### .Run

This allows you to select in which mode the plug-in is displayed.

### .Toolbar

What the icon looks like in the toolbar of roblox studios.

![](https://1770016262-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqUSQB3cNmQ1GnmH5bFXg%2Fuploads%2F5jLvL6iVaD1yW54bPRe3%2Fimage.png?alt=media\&token=339918e3-f14b-46df-aa52-1b8527bea4c7)

### .Tabs

Which tabs will be displayed at the top of the plug-in. Each tab should lead to a page.

![](https://1770016262-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqUSQB3cNmQ1GnmH5bFXg%2Fuploads%2FOnKab16P9sgJ9Xm8WCWY%2Fimage.png?alt=media\&token=1b8829c6-8d6b-44b2-ad50-810c0e0d8ca7)