Skip to content

Commit

Permalink
Merge pull request #3 from MiaGobble/dev-unstable
Browse files Browse the repository at this point in the history
Dev unstable
  • Loading branch information
MiaGobble committed May 24, 2024
2 parents 3b865c7 + 7ad9c82 commit b5e8985
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
10 changes: 10 additions & 0 deletions Docs/Temp/InstallInstructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Install Instructions

### Studio Plugin
* Insert the Roblox model for the plugin in studio
* Right click that model and select "save as local plugin", then click save

### Figma App
* Unzip App folder
* In Figma, go to Plugins -> Development -> Import plugin from manifest
* Go to the unzipped App folder and import the file named "manifest"
26 changes: 26 additions & 0 deletions Docs/Temp/Tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Tags
Tags are attached to the names of Figma nodes to modify import behavior. Below are the current tags usable for imports. Incorrect tagging is ignored and won't error.

> [!TIP]
> Tags are written in `@UPPERCASE` format! For example, the "group" tag is written as `@GROUP`. Tags can be stacked, separated by `@`.
### `@GROUP`
Groups a node in export. This means that no children will be exported under it.

### `@IGNORE`
Nodes with `@IGNORE` in the name will not be included in exports.

### `@TYPE_FRAME`
Declares the exported node to be a `Frame` class type in Studio.

### `@TYPE_SCROLLING_FRAME`
Declares the exported node to be a `ScrollingFrame` class type in Studio.

### `@TYPE_BUTTON`
Declares the exported node to be an `ImageButton` class type in Studio.

### `@TYPE_TEXT_BUTTON`
Declares the exported node to be a `TextButton` class type in Studio.

### `@TYPE_IMAGE`
Declares the exported node to be a `ImageLabel` class type in Studio. This is the default behind the scenes.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
View auto import tags [here](./Docs/Temp/Tags.md)

View install instructions [here](./Docs/Temp/InstallInstructions.md)

0 comments on commit b5e8985

Please sign in to comment.