Wiring or Device Settings Format for the Forums

Community Made Guides
,
1

If you ever want to demonstrate wiring or device settings on the forums, you may run into the following scenarios:

  • Device settings are to tall to fit in one screenshot
  • There are unneeded device settings in the screenshot that may distract and confuse others
  • You aren’t able to access GKC at the moment
  • Photos clutter up your space
  • Etc.

So, today I’ll be talking about a new standard format for showing device or wire settings on the forums for readability and possibly efficiency. I really just came up with this format after responding to a post.

First, the format for device settings:

Device Name

Setting #1: [Any variable]
Setting #2: 0
Setting #3: Some text

Example with a property:

Property

Property Name: [Any variable]
Property Type: Number
Default Value: 0
Property Scope: Global

Next, wiring:

Something → Something else

Example with a button:

Button pressed → Increment Counter

Remember, “->” can create →

This hopefully cleans up your forum topics and posts and simplifies understanding within topics. Anyways, that’s it! Please tell me if I should change something or if I made any mistake.

13 Likes
2

Useful for new users, but;

  1. Take new screenshots, merge or put directly under to appear as merge
  2. This would be semi-easy to figure out, given as it is just the settings put in text form within a blockquote.
3

I’m just trying to give a general format for easier readability and emphasis.

Example of un-formatted explanation from other topic:

1 Like
4

If you are going to make this guide;
More circumstances; Wires/channels, devices, and properties are CERTAINLY not all of the uses for formatting in this case
Tags; Take out gimkit-beginners, add forum-beginners and forum-tips
Photos are just fine; you should also add a sample section describing how to use images since all of your points above have easy fixes.

  • Merge them into one, or make it seem that way
  • Only take some screenshots of the things you need, then merge them or make them seem that way.
  • Then why are you making the guide? Testing, Testing, Testing!
  • Photos cluttering space is only a thing if you like small posts. Most guides are long and detailed [1]. Fixes for this include things like dropdowns, [2], and links.

  1. As they should be ↩︎

  2. This Thing ↩︎

1 Like
5

@Monoreuk (sorry for ping) is the one who removed forum-tips and added gimkit-beginners. (Check edit history)

I was just using the property as an example.

What do you mean?

6
  1. Well it has nothing to do with Gimkit itself, and is for forum tips/beginners; Regulars aren’t always right, they’re people too.
  2. Your example… isn’t the best. You should include a directory of all settings, so they don’t have to wonder what Any variable-0-some text means
  3. Those were disproving your points on why you might need this instead of images.
7

Sorry to say but, PSA’s are not allowed unless you have permission from a mod

8

oh, sorry, I read something wrong, and for some reason I thought it was about the GCK theme, yes 100% gimkit-beginners needs to be removed

my bad yall!

Edit: I change it

2 Likes
9

I just learned that, thanks!

@twofoursixeight , may I keep this topic?

10

I agree, but there are still some posts with exceptions

11

(I believe) Forum posts must be approved beforehand by moderators. If it has been and I missed that post I am deeply sorry.

2 Likes
12

No, you haven’t missed anything, but I asked @twofoursixeight if I could keep this topic in an earlier post.

13

bruh x5
:face_with_raised_eyebrow: x5

you… used my example.

14

Well, it isn’t a guide, how will people know to look through thousands of Help topics to find one reply?