diff --git a/.moonwave/static/guides/studio/thingsyoushouldchange1.png b/.moonwave/static/guides/studio/thingsyoushouldchange1.png new file mode 100644 index 0000000..e7be1b2 Binary files /dev/null and b/.moonwave/static/guides/studio/thingsyoushouldchange1.png differ diff --git a/.moonwave/static/guides/working-with-parts/selectpartandshowpropertieswindow.png b/.moonwave/static/guides/working-with-parts/selectpartandshowpropertieswindow.png new file mode 100644 index 0000000..2077420 Binary files /dev/null and b/.moonwave/static/guides/working-with-parts/selectpartandshowpropertieswindow.png differ diff --git a/docs/global-configurations/_category_.json b/docs/global-configurations/_category_.json index 9d678a5..8b19634 100644 --- a/docs/global-configurations/_category_.json +++ b/docs/global-configurations/_category_.json @@ -1,4 +1,4 @@ { "label": "Global Configurations", - "position": 6 + "position": 7 } \ No newline at end of file diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json new file mode 100644 index 0000000..9581cc9 --- /dev/null +++ b/docs/guides/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Guides", + "position": 6 +} \ No newline at end of file diff --git a/docs/guides/intro-to-guides.md b/docs/guides/intro-to-guides.md new file mode 100644 index 0000000..5eb2ee0 --- /dev/null +++ b/docs/guides/intro-to-guides.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 0 +--- + +# Introduction to Guides + +Guides contain a lot of useful resources relating to the usage of Roblox Studio and the usage of the kit itself. + +If you are a beginner, it is recommended the first few guides after this introduction. They explain how you should set up Roblox Studio and your places and explain how to use core features within Studio and the kit. + +If you are a more advanced builder looking for guides for more complex mechanics, some guides are sorted into certain categories, like Client Objects or Physics. + +## How do I find guides that aren't listed here? + +If you are looking for guides related to certain parts of Roblox Studio, you may always read the [documentation for Roblox studio](https://create.roblox.com/docs), where you may find articles that suite your needs. + +If you are looking for guides related to certain parts of the kit, you may be able to ask within the `#tower-development` or `#tower-building-help` channels for help. Sometimes, the `scripting sanctuary` thread of `#tower-development` discusses scripting with the kit, so you may ask there for more complex scripting issues. + +## How do I write my own guides? + +You can fork the kit repository and make your own changes, and then make a pull request on the kit repository to submit your own changes to the documentation. + +If you do not have access to a GitHub account or would prefer using alternate methods, you can write it within Discord messages or on a Google Doc and then ping an EToH game scripter to get your guide reviewed. + +## What's happening to the `#building-tutorials` channel? + +The channel won't be getting deleted until we are confident that the guides provided here are better and more insightful than the guides within `#building-tutorials`. + +## Can I edit any of the existing guides? + +Yes! If you have anything you want to change or add, [make a pull request](https://github.com/etohgame/kit/pulls) with the edits, where we can review and approve them. You may also [make an issue report](https://github.com/etohgame/kit/issues) too. Most of the stuff here is pretty new, so there is bound to be some errors and mishaps along the way. + +Currently wanted edits include: +- More content within the `Using Studio Correctly` guide. +- Updates to the `Working With Parts` guide to be more concise and accurate, along with a more precise description for `CustomPhysicalProperties`. +- Building style guides. + +## Resources + +* [Tower Theory](https://docs.google.com/document/d/1vLhS-dHPZjxy59igqfzvHPXMQkptlbqvn5u1_rSrV4k/edit?usp=sharing) - A document by emflamed that contains advice pertaining to tower building. Feel free to suggest additions. +* [Roblox Creator Docs](https://create.roblox.com/docs) - Documentation pertaining to Roblox. \ No newline at end of file diff --git a/docs/guides/studio.md b/docs/guides/studio.md new file mode 100644 index 0000000..b48b87a --- /dev/null +++ b/docs/guides/studio.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 1 +--- + +# Using Studio Correctly + +There are many ways to use Roblox Studio, and we want to make sure that you are using it in ways that help you and your tower thrive. + +## Must-Dos + +Please do the following or else you will have an insufferable time and have a really hard time fixing whatever went wrong. + +- Please have your resize increment be set to 1 or 0.5 and your rotate increment be a factor of 90 for the best experience. +- Anything else that needs to be mentioned is in the image. + +![](/guides/studio/thingsyoushouldchange1.png) + +## Keybinds + +A possibly outdated list of shortcuts can be found [here](https://github.com/Roblox/creator-docs/blob/tfinniga-split-attributes-draft/content/en-us/studio/shortcuts.md). + diff --git a/docs/guides/working-with-cos b/docs/guides/working-with-cos new file mode 100644 index 0000000..e1e6d6b --- /dev/null +++ b/docs/guides/working-with-cos @@ -0,0 +1,7 @@ +--- +sidebar_position: 3 +--- + +# Working with Client Objects + +Client objects consist of most of the mechanics in the game. Within this guide, you will learn how to use configurations to \ No newline at end of file diff --git a/docs/guides/working-with-parts b/docs/guides/working-with-parts new file mode 100644 index 0000000..ce71e5b --- /dev/null +++ b/docs/guides/working-with-parts @@ -0,0 +1,45 @@ +--- +sidebar_position: 2 +--- + +# Working with Parts + +Parts are the most important feature in Roblox. Within this guide, you will learn how to use parts and customize them to your liking. + +## Properties + +When you click on a part, you will see the properties of the part within the Properties window. If you do not know how to access this, read the [guide on Studio](studio.md). + +![](/guides/working-with-parts/selectpartandshowpropertieswindow.png) + +Within this menu, you will be able to select a variety of properties and change them. Most properties are categorized into a few core categories, like Apperance, Collision, Part, and more. Properties within these categories determine how the part functions. + +Note that the following section will only cover the most important properties of parts. Another other properties may be found within the [`BasePart` documentation](https://create.roblox.com/docs/reference/engine/classes/BasePart). + +## Appearance + +Changing how a part appears is one of the most fundamental things you need to know in order to make a tower, and even more important when making the tower look nice. + +You can change the color of a part by using the `Color` property. When changing the `Color` property, you may type out the color in the RBG format by clicking on the text box, or use a color picker by clicking on the colored square next to the text box. The `BrickColor` property isn't recommended to be used as it is less customizable, only letting you choose from a collection of pre-selected colors. + +The `Transparency` property changes how transparent the part is. This property is sometimes used to indicate parts with no collision, which may be used to set up traps for the player. You can also use this property in combination with the `Glass` `Material` to create some nice visuals. + +If you don't want your part always using the Stud texture, there are a few ways to customize it. Within the Surface category, you can change the texture of each side of the part, however note that this category hides itself if all the properties within it are set to `Smooth`, and it will need to be manually set to something else using a plugin or code in order to make it come back in the Properties window. There is also a `Material` property in the Apperance tab that you can use to change what textures the parts use entirely. If you know how to use `MaterialVarient`s, please submit all `MaterialVarient`s used in the tower model, and give them a unique name to prevent possible name conflict. + +`Reflectance` exists. `CastShadow` also exists but it only works with certain Lighting settings. + +## Collision + +You can change how a part interacts with other parts by changing its Collision properties. + +`CanCollide` determines if a part collides with other parts. If this is set to false, it will never collide with anything. `CanTouch` determines if the `Touched` event of the part is fired when the part is touched by another part. + +The `CollisionGroup` of a part determines what parts it can and cannot collide with. A list of built-in collision groups can be found [here](/docs/misc.md#collision-groups). Note that they do not have autocomplete unless already used in the place due to the collision groups being properly created when the place is ran. + +## Part Data + +`Anchored` determines if a part is not affected by physics. Please do not disable this on any parts in the obby folder. + +`CustomPhysicalProperties` can be used in a lot of cool ways. You can set Elacticity to 0 and Elacticity to 100 to make the part not bounce you off if you are moving at very high speeds. You can also change the friction of the part to change how slippery it is. + +`Shape` changes the shape of the part. \ No newline at end of file