Adding Documentation #1

Kulltero · 2023-02-01T02:28:05Z

PR to collect feedback & improvements

Uploading Documentation onto a clean branch because having 557 Stackedit commits doesn't seem sensible

…o Docs

WheteThunger · 2023-02-01T02:38:59Z

docs/components/RectTransform.md

@@ -0,0 +1,60 @@
+# Components: RectTransform
+**< [Previous Component](/docs/components/README.md)** | **[Back to Components](/docs/components/README.md)** | **[Next Component](/docs/components/UnityEngine.UI.RawImage.md) >**


I suggest removing Next links when at the end, and removing the Previous links when at the beginning.

i agree, i initially kept it for the symmetry/aesthetics, but its more important the navigation actually makes sense

WheteThunger · 2023-02-01T02:39:53Z

docs/components/RectTransform.md

+A common Technique is to use Anchors to specify what part of the Parent the UI should be anchored to (Top Left Corner or Dead Center. Etc.) and to use Offsets for Size & Position.
+
+## Offsets and Scaling
+Rust will automatically scale Offsets depending on the Player's Resolution, which ensures your Offsets are predictable.


I suggest also mentioning that Rust accounts for the client's graphics.uiscale since I still see people believing otherwise.

I completely forgot to mention that, so I've added it to the scaling section as a note

WheteThunger · 2023-02-01T02:44:55Z

docs/components/UnityEngine.UI.RawImage.md

+
+---
+before using RawImage, take a look at the Image Component to see if it's better suited for your usecase.
+**< [Previous Component](/docs/components/README.md)** | **[Back to Components](/docs/components/README.md)** | **[Next Component](/docs/components/UnityEngine.UI.RawImage.md) >**


The Next Component link location is wrong.

fixed, thanks for pointing it out

WheteThunger · 2023-02-01T02:47:40Z

docs/components/UnityEngine.UI.InputField

@@ -0,0 +1,46 @@
+# Components: InputField


Needs to be a markdown file. Links to this page are broken.

noticed it too late, fixed now

WheteThunger · 2023-02-01T02:52:51Z

docs/Bugs-Tips.md

+### Positioning your CUI alongside rust UI
+for features that augment Rust's existing UI, like when you're working with Furnaces & other storage Inventories, its important to make sure your CUI doesn't interfere with the UI you augment.
+
+Rust UI uses the same Placement system CUI does. it anchors all of the UI to the Bottom Middle of the Screen and then uses offsets to position each element. by doing the same you can ensure that your CUI is positioned properly, regardless of Screensize & Aspect Ratio.


it anchors all of the UI to the Bottom Middle of the Screen

This is true for many elements, but of course not true for the status bars, compass, missions, etc. Also not true for vendor dialog which is anchors to middle center.

Wouldn't hurt to also mention that the computer station UI doesn't use this, to save people time from trying to get that to work.

i expanded on that section to clarify it based on your feedback, i did choose to show an easy way to find what a UI element is anchored to instead of repeating your list, i did look at the computer station UI and couldn't really figure out what it was doing either so i'm not sure how to address that one

WheteThunger · 2023-02-01T03:14:24Z

docs/components/UnityEngine.UI.Text.md

+| `font`      | string | the Asset name of the Font you wish to use |
+| `align`     | string (enum `TextAnchor`) | the way your Text should be aligned |
+| `color`     | string | the default Color of your Text |
+| `verticalOverflow` | string (enum `VerticalWrapMode`) | how Text Overflowing vertically should be handled |


I suggest documenting the enum values and/or providing a link to Unity docs.

added a section on the verticalOverflow enum

WheteThunger · 2023-02-01T03:32:59Z

docs/components/UnityEngine.UI.InputField

+| `lineType`  | string (enum `InputField.LineType`) | dictates if the Field should allow multiple Lines & how to handle when the Player presses `enter` |
+| `password`  | key presence Field | if the input should be obscured |
+| `needsKeyboard`  | key presence Field | prevents default Keyboard behavior (movement, item switching etc) while the field is Focused |
+| `hudMenuInput`  | key presence Field | same as above but for Rust UI (Inventory, Crafting, etc.) |


It might be worth mentioning that this if you try to use needsKeyboard while the hud is open, the hud will be closed when clicking on the input. Can also mention that, unlike needsKeyboard, it doesn't block movement or key binds.

i assume with your second sentence you were talking about the hudMenuInput, which i also wasnt aware of. i've added a section to explain this a bit more

WheteThunger · 2023-02-01T03:41:50Z

docs/components/UnityEngine.UI.Image.md

+| `sprite`    | string | the asset Path to the sprite |
+| `color`     | string | the normalized RGBA values of your color |
+| `material`  | string | the asset Path to the Material |
+| `imagetype` | string (enum `Image.Type`) | sets the display mode of the Image* |


Consider documenting the known values and/or linking to Unity docs.

i've added some more information for the imagetype field, but i also used the chance to reiterate that the setting really only does things for preconfigured sprites.

i think particularly the sliced & tiled options could be really useful for server loaded images too so it would be really nice to see the api include fields for this in the future

WheteThunger · 2023-02-01T03:43:19Z

docs/components/UnityEngine.UI.Image.md

+| `sprite`    | string | the asset Path to the sprite |
+| `color`     | string | the normalized RGBA values of your color |
+| `material`  | string | the asset Path to the Material |


Would be awesome to somehow document the known sprite/material values. Not sure if this is the best place for that, since it can change, but perhaps you can document a process by which the allowed values can be determined.

i dont really know an easy way short of digging out asset files from the game, there is a very outdated repo by orange that lists them of somewhat conveniently https://github.com/OrangeWulf/Rust-Docs/blob/master/Extended/Materials.md, but i'm unsure if linking to it in the docs is the best way to go about it

WheteThunger · 2023-02-01T03:46:11Z

README.md

+
+---
+### Disclaimer
+the readme & Documentation is Community maintained it aims to give Developers a starting Point and educate them on effectively using CUIs for their Projects


Lots of sentence capitalization issues throughout the docs.

i fixed most of the capitalization issues & went through it with LanguageTool just to make sure I'd catch all the obvious ones, should be a bit better to read now

Fixed InputField name & added section about Text Selection added notice explaining the default values in the json examples

Improved spelling & fixed capitalization issues added section for Layers in the Basics expanded on Positioning in Bugs-Tips expanded on the imagetype setting for the image component added references to the bugs/error messages in some of the other pages added explanation for hudMenuInput & needsKeyboard fields on Input Component

added note explaining that supplying a skinid of 0 causes client issues

Corrected ordering of all Layer values & added descriptions to Hud & Hud.Menu

WheteThunger · 2023-02-08T02:24:37Z

docs/components/UnityEngine.UI.Image.md

+	"skinid": 0,
+    "fadeIn": 0.0


"fadeIn" has 4 spaces on various pages, but the other fields are using tabs.

Kulltero added 4 commits February 1, 2023 01:37

Upload Initial Documentation files

02ef09a

Uploading Documentation onto a clean branch because having 557 Stackedit commits doesn't seem sensible

Upload Initial Documentation files

4d4ddd9

Uploading Documentation onto a clean branch because having 557 Stackedit commits doesn't seem sensible

Merge branch 'Docs' of https://github.com/Kulltero/Rust.Community int…

3d00489

…o Docs

fix InputField file name

8cb074f

WheteThunger suggested changes Feb 1, 2023

View reviewed changes

Kulltero added 4 commits February 1, 2023 06:13

Fix InputField, Add fadeIn

dd55080

Fixed InputField name & added section about Text Selection added notice explaining the default values in the json examples

Add Note about SkinID = 0 bug

7c4b2b4

added note explaining that supplying a skinid of 0 causes client issues

Amend Layer Descriptions

906616e

Corrected ordering of all Layer values & added descriptions to Hud & Hud.Menu

WheteThunger reviewed Feb 8, 2023

View reviewed changes

Kulltero and others added 3 commits February 10, 2023 12:47

fix fadeIn using spaces in json

8f51106

Update from rust repo

eb57d9d

Merge branch 'Facepunch:master' into Docs

da0e060

		@@ -0,0 +1,60 @@
		# Components: RectTransform
		< [Previous Component](/docs/components/README.md) \| [Back to Components](/docs/components/README.md) \| [Next Component](/docs/components/UnityEngine.UI.RawImage.md) >

Adding Documentation #1

Are you sure you want to change the base?

Adding Documentation #1

Uh oh!

Conversation

Kulltero commented Feb 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants