Skip to content

Latest commit

 

History

History
116 lines (74 loc) · 6.54 KB

File metadata and controls

116 lines (74 loc) · 6.54 KB

Codify Cover Image

Get it on Roblox Get it on Itch|48x48

Codify converts your pre-existing Roblox UI, models and more into code snippets in a flash. Whether you use vanilla Roblox Luau, or a framework like Roact or Fusion, Codify has you covered!

📥 Installation

Codify is available from the Roblox Plugin Marketplace for 350 Robux, or can be downloaded for free via GitHub (self-build) or its Itch.io store page (optional donation).

Plugin Marketplace

The Creator Marketplace is the easiest way to install Codify. You'll get quick and easy access to updates via the Plugin Management window, and you'll be able to use the plugin anywhere you have Roblox Studio installed.

Get it on Roblox

Don't forget to leave a 👍 like if you enjoy the plugin!

Itch.io

Currently, there's no way to automatically install and update plugins purchased through Itch. You'll need to manually download and drop the plugin file into your Studio plugins folder every time there's an update. You'll also have to repeat this process for every device you want to use the plugin on.

Get it on Itch

Manual Installation

If you don't want to use the Plugin Marketplace or Itch.io, you can clone the plugin source from GitHub. You'll need to compile the plugin binary yourself using a tool like Rojo, and you'll also be responsible for keeping the plugin up to date.

This might be a great option for you if you want to modify the plugin source code, or if you're concerned about security. However, this method sacrifices convenience of installation and updates.

Get it on GitHub

🐛 Found a Bug?

If you think you've found a bug, please report it! Here's all the places you can report bugs:

🛡️ Overview of Permissions

HTTP Requests

Codify requires the ability to make HTTP requests to keep the plugin and Studio in-sync. The table below shows an overview of the domains Codify will make requests to, and why (and if) they're required.

Domain Required Reason
s3.amazonaws.com Studio metadata and API dump
api.github.com List of contributors who helped make Codify possible

Script Injection

Script injection is a completely optional permission. You won't be prompted to give access to this until using the Save to Device feature. This feature allows you to save your code snippets to your computer.

This permission is exclusive to the Save to Device, and is not required for any other feature. Save to Device is great for exporting snippets longer than the TextBox character limit, or for accessing your snippets outside of Roblox Studio.

Save to Device will create a temporary ModuleScript in order to export your snippet. The ModuleScript is unarchivable, meaning it won't be saved to your place during publishing/(auto-)saving. The ModuleScript is also deleted immediately after the snippet is exported.

🖼️ Screenshots

See Demo on YouTube

Screenshots

🤔 Plugin Limitations

Codify does not support Instance properties which accept another Instance as its value. This means properties such as Adornee or ObjectValue.Value are not supported; however, Codify will try its best to link the Parent property to the Instance it's referencing, as long as it's in the tree.

Roblox's TextBoxes are also subject to a character limit. This means you may find large snippets of code are truncated. You can use the Save to Device feature to export your code to a ModuleScript, which is subject to a much larger character limit. However, if you're reaching these limits, you may want to consider reviewing your components/models, and seeing how you can split them down further. This will help you with maintainability and keep your codebase clean.

📦 Open Source Projects

📣 Shoutout to @boatbomber for their help with expanding Codify's scope to include more than just Roact. You should check out their Itch.io store for more of their work, and how you can support them!

Codify is built on top of a few open source projects. Here's a list of the projects Codify uses:

⚠️ Disclaimer

The code snippets produced by Codify are not 100% perfect. You should consider the snippets as a starting point, and not a finished product. You should always review the code snippets before using them in your own projects. This still shouldn't put you off from using Codify, though!