{"id":19261790,"url":"https://github.com/ryanlua/rojo-showcase-template","last_synced_at":"2026-03-01T00:32:02.617Z","repository":{"id":191959766,"uuid":"685763161","full_name":"ryanlua/rojo-showcase-template","owner":"ryanlua","description":"Rojo template for basic showcases","archived":false,"fork":false,"pushed_at":"2026-02-10T06:21:34.000Z","size":349,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-10T12:44:30.904Z","etag":null,"topics":["luau","roblox","rojo","template","works-with-codespaces"],"latest_commit_sha":null,"homepage":"","language":"Luau","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanlua.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"RyanLua"}},"created_at":"2023-09-01T00:38:23.000Z","updated_at":"2026-02-10T06:21:38.000Z","dependencies_parsed_at":"2024-02-11T10:21:11.730Z","dependency_job_id":"22ce634f-6000-43d1-92f1-584a80af1c3d","html_url":"https://github.com/ryanlua/rojo-showcase-template","commit_stats":null,"previous_names":["ryanlua/rojo-showcase","the-winner-games/rojo-showcase-template","ryanlua/rojo-showcase-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ryanlua/rojo-showcase-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanlua%2Frojo-showcase-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanlua%2Frojo-showcase-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanlua%2Frojo-showcase-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanlua%2Frojo-showcase-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanlua","download_url":"https://codeload.github.com/ryanlua/rojo-showcase-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanlua%2Frojo-showcase-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29956195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T22:53:01.873Z","status":"ssl_error","status_checked_at":"2026-02-28T22:52:50.699Z","response_time":90,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["luau","roblox","rojo","template","works-with-codespaces"],"created_at":"2024-11-09T19:28:26.114Z","updated_at":"2026-03-01T00:32:02.594Z","avatar_url":"https://github.com/ryanlua.png","language":"Luau","funding_links":["https://github.com/sponsors/RyanLua"],"categories":[],"sub_categories":[],"readme":"# Roblox Showcase Rojo Template\n\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/RyanLua/rojo-showcase-template?quickstart=1)\n\n\u003c/div\u003e\n\nA Rojo template for Roblox showcases. Includes starter scripts every showcase should have for the best user experience and player acquisition.\n\nMade for those getting into Rojo or wanting to explore how a showcase can be built with Rojo. This template is designed to be able to be used for all of your showcases using just one codebase as opposed to having different scripts for each showcase.\n\nUsed in my collection of open-source showcases under my group, [The Winner Games](https://www.roblox.com/groups/4973811):\n\n* [House in the Woods](https://www.roblox.com/games/5813911804)\n* [Isolated Café](https://www.roblox.com/games/6200761971)\n* [Nature](https://www.roblox.com/games/7442772872)\n* [A New Winter](https://www.roblox.com/games/6279686336)\n\n## What's included\n\n### Scripts\n\n| Script | Description |\n| --- | --- |\n| **Screenshot HUD** | Adds a button to the topbar to enable the [`ScreenshotHud`](https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud) which allows users to capture and save screenshots to their local device. |\n| **Invite Prompt** | Adds a button to the topbar to allow users to invite their friends using [`Player Invite Prompts`](https://create.roblox.com/docs/production/promotion/invite-prompts). |\n| **Join Badge** | A script that [awards users a badge](https://create.roblox.com/docs/production/publishing/badges#awarding-badges) when they join your experience which displays within the Badges category of their inventory. |\n| **Avatar Context Menu** | Enables the [`Avatar Context Menu`](https://create.roblox.com/docs/players/avatar-context-menu) context menu that allows users to send a friend request, begin a private chat, view the user's profile, or wave when a user clicks on another user's character. |\n| **Minimal Mouse Icon** | Changes the default [mouse icon](https://create.roblox.com/docs/reference/engine/classes/UserInputService#MouseIcon) to a more minimal cursor used on console. |\n| **Sprint Script** | Allows users to sprint by holding the left side \u003ckbd\u003eShift\u003c/kbd\u003e key, gamepad X button, or on-screen touch button. |\n| **Premium Chat Tag** | Adds a premium [chat tag](https://create.roblox.com/docs/chat/customizing-in-experience-text-chat#adding-chat-tags) to users with [Premium](https://www.roblox.com/premium/membership). |\n| **Contextual Proximity Prompt** | Creates a [contextual mobile button](https://create.roblox.com/docs/input/mobile#context-dependent-inputs) for triggering proximity prompts. [Example](https://youtu.be/WAwuNaPIkTs) |\n| **Seat Prompt** | Proximity prompts to sit in a seat when a user is near a seat with the [tag](https://create.roblox.com/docs/reference/engine/classes/CollectionService) `Seat`. |\n\n### Features\n\n* High performance means no performance\n\nBuilt for being optimized and performant, this template is designed to be as lightweight as possible to ensure that no performance is lost.\n\n* Automatic translation ready\n\nReady to be localized and translated for your users using [Automatic Translation](https://create.roblox.com/docs/production/localization#automatic-translations) into 15 different languages, with right-to-left language support.\n\n* Modular and Customizable\n\nEach script is modular and can be easily disabled or customized to fit your needs. Delete or disable any scripts you don't need or want. Easily customize scripts using [Instance Attributes](https://create.roblox.com/docs/studio/properties#instance-attributes).\n\n* Strict type-checking and well-documented\n\nCode that's easy for the eyes to read with [strict type-checking](https://create.roblox.com/docs/luau/type-checking) to ensure that your code is bug-free. Comments on each piece of code to help you understand what each part does.\n\n## Installation\n\n### Prerequisites\n\n* [Rojo](https://rojo.space/)\n* [Roblox Studio](https://www.roblox.com/create)\n* [Visual Studio Code](https://code.visualstudio.com/)\n\nInstallation is easy and just like any other Rojo project.\n\n#### Using Visual Studio Code\n\n1. Clone the repository\n1. Open the project in Visual Studio Code with Rojo installed (extension or CLI)\n1. Run `rojo serve` in the terminal or use the Rojo extension to serve\n1. Open Roblox Studio and connect to the Rojo server\n\n#### Using GitHub Codespaces\n\n1. Click on the \u003ckbd\u003eOpen in GitHub Codespaces\u003c/kbd\u003e button at the top of the README\n1. Wait for the Codespace to be created\n1. Run `rojo serve` in the terminal or use the Rojo extension to serve\n1. Change the port visibility of `Rojo (34872)` to `Public`\n1. Open Roblox Studio and connect to the Rojo server\n    * Remove the `https://` at the beginning and the `/` of the forwarded address. It should look something like this: `probable-memory-w44vgv9v4vpfjwj-34872.app.github.dev`\n    * Set the port as `80`\n\nNow accept those changes and your showcase is ready to go. Make sure to change the `BadgeId` in the `JoinBadge` script to your badge ID.\n\n## Usage\n\nThis template is designed to be used for all of your showcases. You can easily customize and disable scripts to fit your needs. Each script is well-documented and has strict type-checking to ensure that your code is bug-free.\n\n### Customizing Scripts\n\nEach script is customizable using [Instance Attributes](https://create.roblox.com/docs/studio/properties#instance-attributes). You can easily change the properties of each script to fit your needs. If you don't want a script or don't need it them you can disable or delete the script.\n\n## Contributing\n\nFeel free to contribute to this project by creating a pull request. Please ensure that you follow the [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guidelines](CONTRIBUTING.md) before contributing.\n\n## License\n\nThis project is licensed under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanlua%2Frojo-showcase-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanlua%2Frojo-showcase-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanlua%2Frojo-showcase-template/lists"}