{"id":15008084,"url":"https://github.com/snipcola/create-roblox-ts-script","last_synced_at":"2025-10-28T11:06:24.108Z","repository":{"id":257661260,"uuid":"858383365","full_name":"snipcola/Create-Roblox-TS-Script","owner":"snipcola","description":"CLI tool for creating Roblox scripts using TypeScript.","archived":false,"fork":false,"pushed_at":"2024-10-19T13:03:57.000Z","size":16026,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-20T09:07:08.441Z","etag":null,"topics":["bundle","lua","luau","rbxts","roblox","roblox-ts","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snipcola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-16T19:53:01.000Z","updated_at":"2024-10-19T13:04:01.000Z","dependencies_parsed_at":"2024-09-24T19:15:07.192Z","dependency_job_id":"6ad7d6b4-f22d-4430-8693-d6d6322844ad","html_url":"https://github.com/snipcola/Create-Roblox-TS-Script","commit_stats":null,"previous_names":["snipcola/roblox-ts-template","snipcola/create-roblox-ts-script"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipcola%2FCreate-Roblox-TS-Script","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipcola%2FCreate-Roblox-TS-Script/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipcola%2FCreate-Roblox-TS-Script/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snipcola%2FCreate-Roblox-TS-Script/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snipcola","download_url":"https://codeload.github.com/snipcola/Create-Roblox-TS-Script/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243180664,"owners_count":20249327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bundle","lua","luau","rbxts","roblox","roblox-ts","typescript"],"created_at":"2024-09-24T19:15:01.956Z","updated_at":"2025-10-28T11:06:19.067Z","avatar_url":"https://github.com/snipcola.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Create Roblox-TS Script\r\n\r\nBuilds \u0026 bundles TypeScript source files into a Lua script, which you can use on Roblox.\r\n\r\n## Prerequisites\r\n\r\nMake sure the following are installed:\r\n\r\n- [node](https://nodejs.org)\r\n\r\nThe following are automatically installed; if it fails, install manually:\r\n\r\n- [aftman](https://github.com/LPGhatguy/aftman/releases/latest)\r\n\r\n## Instructions\r\n\r\n1. **Create Project**\r\n\r\n   Run the following in a terminal, and follow the instructions:\r\n\r\n   ```\r\n   npm create roblox-ts-script\r\n   ```\r\n\r\n2. **Develop**\r\n\r\n   Once the script has created your project, open it in an IDE, preferably [VSCode](https://code.visualstudio.com).\r\n\r\n   In the VSCode Terminal, you can execute `npm run dev`. Now you can edit files in `src`, and it will compile to `out` when you save.\r\n\r\n3. **Build**\r\n\r\n   If you'd like to manually start the build process, instead of running the dev script, run `npm run build` which will build once.\r\n\r\n4. **Sync** (optional)\r\n\r\n   If you want to test your script on Roblox Studio, run the following once: `rojo plugin install`.\r\n\r\n   Then, simply run `npm run dev-sync` and connect on Roblox Studio (look for Rojo in the Plugins section).\r\n\r\n5. **Deploy** (optional)\r\n\r\n   If you chose to initialize a git repository, and have it connected to a remote GitHub repo, you can run `npm run release` to create a release with the script attached.\r\n\r\n   Only do this once you've made changes and pushed them to the `main` branch. Otherwise, it won't do anything.\r\n\r\n6. **Packages** (optional)\r\n\r\n   You can install roblox-ts packages like usual, through your package manager. An example of a package is `@rbxts/vide`.\r\n\r\n   If the package is not under the `@rbxts` scope, use `npm run scope` to add the scope of the package.\r\n\r\n   Here's an example of a package being used:\r\n\r\n   ```ts\r\n   import greet from \"@snipcola/greet-test\";\r\n   greet(\"world\");\r\n   ```\r\n\r\n## Credits\r\n\r\n- [roblox-ts](https://github.com/roblox-ts/roblox-ts), compiler\r\n- [rojo](https://github.com/rojo-rbx/rojo), synchronization\r\n- [tape](https://github.com/Belkworks/tape), bundler (heavily modified)\r\n- [darklua](https://github.com/seaofvoices/darklua), minifier\r\n- [rbxts-hax](https://github.com/richie0866/rbxts-hax), unc types\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnipcola%2Fcreate-roblox-ts-script","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnipcola%2Fcreate-roblox-ts-script","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnipcola%2Fcreate-roblox-ts-script/lists"}