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:
| Script | Description |
|---|---|
| Screenshot HUD | Adds a button to the topbar to enable the 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. |
| Join Badge | A script that awards users a badge when they join your experience which displays within the Badges category of their inventory. |
| Avatar Context Menu | Enables the 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 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 to users with Premium. |
| Contextual Proximity Prompt | Creates a contextual mobile button for triggering proximity prompts. Example |
| Seat Prompt | Proximity prompts to sit in a seat when a user is near a seat with the tag Seat. |
- 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 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.
- Strict type-checking and well-documented
Code that's easy for the eyes to read with strict 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 is easy and just like any other Rojo project.
- Clone the repository
- Open the project in Visual Studio Code with Rojo installed (extension or CLI)
- Run
rojo servein the terminal or use the Rojo extension to serve - Open Roblox Studio and connect to the Rojo server
- Click on the Open in GitHub Codespaces button at the top of the README
- Wait for the Codespace to be created
- Run
rojo servein the terminal or use the Rojo extension to serve - Change the port visibility of
Rojo (34872)toPublic - 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
- Remove the
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.
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.
Each script is customizable using 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.
Feel free to contribute to this project by creating a pull request. Please ensure that you follow the Code of Conduct and Contributing Guidelines before contributing.
This project is licensed under the Apache License 2.0.
