https://github.com/ryanlua/rojo-showcase-template
Rojo template for basic showcases which include scripts and common utilities.
https://github.com/ryanlua/rojo-showcase-template
luau roblox rojo template works-with-codespaces
Last synced: 8 months ago
JSON representation
Rojo template for basic showcases which include scripts and common utilities.
- Host: GitHub
- URL: https://github.com/ryanlua/rojo-showcase-template
- Owner: RyanLua
- License: apache-2.0
- Created: 2023-09-01T00:38:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-03T09:49:08.000Z (8 months ago)
- Last Synced: 2025-02-17T02:53:55.729Z (8 months ago)
- Topics: luau, roblox, rojo, template, works-with-codespaces
- Language: Luau
- Homepage:
- Size: 290 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roblox Showcase Rojo Template
[](https://codespaces.new/RyanLua/rojo-showcase-template?quickstart=1)
A Rojo template for Roblox showcases. Includes starter scripts every showcase should have for the best user experience and player acquisition.
Made 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.
Used in my collection of open-source showcases under my group, [The Winner Games](https://www.roblox.com/groups/4973811):
* [House in the Woods](https://www.roblox.com/games/5813911804)
* [Isolated Café](https://www.roblox.com/games/6200761971)
* [Nature](https://www.roblox.com/games/7442772872)
* [A New Winter](https://www.roblox.com/games/6279686336)
## What's included
### Scripts
| Script | Description |
| --- | --- |
| **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. |
| **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). |
| **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. |
| **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. |
| **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. |
| **Sprint Script** | Allows users to sprint by holding the left side Shift key, gamepad X button, or on-screen touch button. |
| **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). |
| **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) |
| **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`. |
### Features
* High performance means no performance
Built for being optimized and performant, this template is designed to be as lightweight as possible to ensure that no performance is lost.
* Automatic translation ready
Ready 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.
* Modular and Customizable
Each 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).
* Strict type-checking and well-documented
Code 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.
## Installation
### Prerequisites
* [Rojo](https://rojo.space/)
* [Roblox Studio](https://www.roblox.com/create)
* [Visual Studio Code](https://code.visualstudio.com/)
Installation is easy and just like any other Rojo project.
#### Using Visual Studio Code
1. Clone the repository
1. Open the project in Visual Studio Code with Rojo installed (extension or CLI)
1. Run `rojo serve` in the terminal or use the Rojo extension to serve
1. Open Roblox Studio and connect to the Rojo server
#### Using GitHub Codespaces
1. Click on the Open in GitHub Codespaces button at the top of the README
1. Wait for the Codespace to be created
1. Run `rojo serve` in the terminal or use the Rojo extension to serve
1. Change the port visibility of `Rojo (34872)` to `Public`
1. Open Roblox Studio and connect to the Rojo server
* 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`
* Set the port as `80`
Now accept those changes and your showcase is ready to go. Make sure to change the `BadgeId` in the `JoinBadge` script to your badge ID.
## Usage
This 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.
### Customizing Scripts
Each 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.
## Contributing
Feel 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.
## License
This project is licensed under the [Apache License 2.0](LICENSE).