Skip to content

Start Documenting Roblox's Standard Scripts#1453

Open
karl-police wants to merge 30 commits intoRoblox:mainfrom
karl-police:roblox-scripts-docs
Open

Start Documenting Roblox's Standard Scripts#1453
karl-police wants to merge 30 commits intoRoblox:mainfrom
karl-police:roblox-scripts-docs

Conversation

@karl-police
Copy link
Contributor

@karl-police karl-police commented Feb 27, 2026

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

Changes

The changes introduce early documentation about Roblox's Standard Scripts. This is important because things like the CameraModule do things is important to know about. For instance, the RenderPriority of the Camera and how it changes the CFrame of the camera. Otherwise, it causes confusion.

image

The current text and information is through careful analyzing and from Roblox's own comments within the code. There is not much documentation yet, because I happen to find bugs that need to be resolved before this documentation can continue. Until then, I want to share my vision on how these documentation could be structured and look like and hope to have this PR accepted, which provide this initial set up for documenting Roblox's Standard Scripts, as I did all these changes just by using the GitHub websites. I even had to temporarily change .gitattributes just to upload a PNG.

It also adds info about BoundKeys which is a StringValue that is comma-separated and can be overwritten to change the bindings for Shift-Lock.

This documentation is necessary so that there's also official guidelines on what can be done and what shouldn't be done. Keep in mind that the PlayerModule says that a Creator is allowed to access things that it provides, but never had a documentation.

Bug Reports:

@karl-police karl-police requested review from a team as code owners February 27, 2026 23:28
@github-actions github-actions bot added assets Changes content/en-us/assets/ engine guides Changes the Engine guides navigation Changes the navigation labels Feb 27, 2026
@github-actions github-actions bot added the changes requested This pull request has changes requested prior to merging label Feb 27, 2026
@karl-police karl-police marked this pull request as draft February 27, 2026 23:29
Copy link
Contributor Author

@karl-police karl-police left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test

@karl-police karl-police marked this pull request as ready for review February 27, 2026 23:35
@karl-police karl-police marked this pull request as draft February 27, 2026 23:35
@karl-police karl-police marked this pull request as ready for review February 27, 2026 23:42
@michaeltipman-gif
Copy link

No cousin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

assets Changes content/en-us/assets/ changes requested This pull request has changes requested prior to merging engine guides Changes the Engine guides navigation Changes the navigation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants