Signals icon indicating copy to clipboard operation
Signals copied to clipboard

Feature request: Documentation

Open za3k opened this issue 7 years ago • 5 comments

Can you please have some documentation not in the form of a Youtube video?

If you need help with hosting, documentation design etc feel free to ping me

za3k avatar Mar 12 '17 21:03 za3k

See #14 .

The in game documentation includes a description of each thing in the mod. I also currently host a copy of this on the internet, at https://fleeting.penwatch.net/signals/ . So written documentation already exists.

However;

  • There are no tutorials.

  • Nor are there any examples of typical set-ups.

Those would be worthy additions to the in-game documentation.

But that would be a separate issue.

LiaungYip avatar Mar 12 '17 23:03 LiaungYip

On Sun, Mar 12, 2017 at 04:50:33PM -0700, Li-aung Yip wrote:

See #14 .

The in game documentation includes a description of each thing in the mod. I also currently host a copy of this on the internet, at https://fleeting.penwatch.net/signals/ . So written documentation already exists.

Ah, didn't know about that.

I'd suggest making it more discoverable instead of writing more.

  • Add a README to the github project, linking to documentation, youtube, etc.
  • Link to it from https://minecraft.curseforge.com/projects/signals
  • Link to it from https://mods.curse.com/mc-mods/minecraft/245824-signals
  • Possibly, add a reference that there are newer features in the youtube video description, since that's a bit out of date?
  • Mention that it works with the in-game wiki mod. (I did notice that, but only by reading your github issues page)

za3k avatar Mar 13 '17 04:03 za3k

Hi, I've found in pointed documentation:

Signals are visualized as their current color (red signals are a red dot, green signals are green).

What does mean yellow signal state? On OTTD wiki is that double yellow in UK means 2 blocks to stop (red). And why I see double-yellow state in single line? EDIT: just before station marker.

rysson avatar Sep 08 '18 16:09 rysson

In Signals the solid yellow means that the signal conditionally can be green or red, depending on which cart tries to pass it. This is the case for Chain Signals, where their signal is dependent on the next signal, which is dependent on the route the cart is taking.

Blinking yellow means the signal is incorrectly configured (not next to a straight rail piece for instance)

MineMaarten avatar Sep 09 '18 08:09 MineMaarten

Is there any documentation or notes about how to use Rail Link?

g-plane avatar Oct 09 '18 08:10 g-plane