|
1 | | -# Visual Studio Code |
2 | | -Generated by [Rojo](https://github.com/rojo-rbx/rojo) 7.2.1. |
| 1 | +<h1 align="center">Signs - A Roblox Studio Plugin</h1> |
3 | 2 |
|
4 | | -## Getting Started |
5 | | -To build the place from scratch, use: |
| 3 | +Signs is an easy-to-use, intuitive text tool plugin for creating signs, text, and labels. |
| 4 | +## Installation |
| 5 | +Signs is avaliable on the **Creator Marketplace for 100 Robux** or from **GitHub for free**. There is a free version on the Roblox Marketplace also. |
6 | 6 |
|
7 | | -```bash |
8 | | -rojo build -o "Visual Studio Code.rbxlx" |
9 | | -``` |
| 7 | +### Creator Marketplace (Recommended) |
| 8 | +Installing from the [**Creator Marketplace**](https://create.roblox.com/docs/production/publishing/creator-marketplace) is what is recommened to install **Signs** or **Signs Free** and allows for **automatic updates** from Roblox and **easier installation**. |
10 | 9 |
|
11 | | -Next, open `Visual Studio Code.rbxlx` in Roblox Studio and start the Rojo server: |
| 10 | +To install from the **Creator Marketplace** click the below link for the plugin version you want to install. Once at the page, click <kbd>**Get Plugin**</kbd> to install the plugin into **Roblox Studio**. |
12 | 11 |
|
13 | | -```bash |
14 | | -rojo serve |
15 | | -``` |
| 12 | +- [**Signs** (100 Robux)](https://create.roblox.com/marketplace/asset/6967799394/) |
16 | 13 |
|
17 | | -For more help, check out [the Rojo documentation](https://rojo.space/docs). |
| 14 | +- [**Signs Free** (Free)](https://create.roblox.com/marketplace/asset/6967799394/) |
| 15 | + |
| 16 | +### GitHub |
| 17 | +Installing from [**GitHub**](https://github.com/about) allows you to access the full paid verion of Signs for free but **no automatic updates** due to limitations as well as a slightly harder installation. |
| 18 | + |
| 19 | +To install from **GitHub** first download the lastest `.rbxm` plugin file of Signs from the below link. Once you have the file, go to `C:\Users\YOUR_WINDOWS_USER\AppData\Local\Roblox\Plugins` and insert `Signs.rbxm` (the one you downloaded) into that folder. |
| 20 | + |
| 21 | +- [**Signs**]() |
| 22 | + |
| 23 | +## Features |
| 24 | +Signs offers many features and some benefits to just a TextLabel. You can edit the UI Stroke which isn't possible with just the Text Stroke property. |
| 25 | + |
| 26 | +<details><summary>Live Preview</summary> |
| 27 | +<p> |
| 28 | +Edit signs and view changes in a preview that will show exactly how your sign will look. Each and every change you make in the editor is updated to the preview. View signs before they are inserted. |
| 29 | +</p> |
| 30 | +</details> |
| 31 | + |
| 32 | +<details><summary>High Customization</summary> |
| 33 | +<p> |
| 34 | +Edit the outline of your text, the background, and even the sign itself. Change the colors of each of these properties along with transparency. Manipulate how light interacts with your sign and if it is always rendered on top. |
| 35 | +</p> |
| 36 | +</details> |
| 37 | + |
| 38 | +<details><summary>Dark & Light Theme</summary> |
| 39 | +<p> |
| 40 | +When using Signs the plugin's theme will automatically update to match Roblox Studio's. No restarting Roblox Studio or Signs is needed due to Signs being able to detect and change it's theme when Roblox Studio's theme changes. |
| 41 | +</details> |
| 42 | + |
| 43 | +<details><summary>Rich Text Support</summary> |
| 44 | +<p> |
| 45 | +Rich Text allows you to be able to bold, italicize, underline, change the size, increase stroke, and many more aspects of your text from each and every letter. Use simple markup tags to change any part of your text. |
| 46 | +</p> |
| 47 | +</details> |
| 48 | + |
| 49 | +<details><summary>UI Stroke</summary> |
| 50 | +<p> |
| 51 | +Change the stroke of the font in customize in ways which the text stroke property can't. Edit the outline join and thickness as well as normal text stroke properties like color and transparency. |
| 52 | + |
| 53 | +</p> |
| 54 | +</details> |
| 55 | + |
| 56 | +## Contributing |
| 57 | +We worked hard to make this open-source plugin, so please contribute at your will. Go ahead and fork this repository and maybe we will merge to our's someday. |
| 58 | + |
| 59 | +If you see an bug or want a feature please open a [issue](https://github.com/The-Winners-Games/Signs/issues). Make sure to check our [Trello board](https://trello.com/b/OVQpLwYq/signs-plugin-roadmap) before you request a feature. |
| 60 | + |
| 61 | +## License |
| 62 | +Signs is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/). See [LICENSE.txt](LICENSE.txt) for details. |
0 commit comments