Communication

From #openttdcoop wiki

(Redirected from Naming conventions)
Jump to: navigation, search

This article is a reference to the different types of communication expected to be used in coop server games.

Communication is not restricted to only the IRC and in-game chat, but through the proper use of signs, station names, and other in-game tools, players can convey information to each other. Using the formats displayed below will ensure that players can easily find information they need and that we are all consistent in our communication.

Sign List

The sign list displays an alphabetical list of all the signs in the game. To ensure that important signs are placed at the top of the list, it is common to add spaces at the front of the sign. These spaces cause the sign to float to the top of the list (spaces are alphabetically before "A").

The following conventions should be used when placing signs in coop games:

Notes:

  • To improve readability on the wiki, bullet characters ("•") are used in place of spaces. Be sure to use spaces when making the actual sign.
  • Trailing spaces are optional, but help make the sign symmetrical.
  • The signs listed below are in the order they will appear in the sign list.


Game-Specific Signs use 2 spaces, 2 exclamation marks, 1 space, text, 1 space, 2 exclamation marks, 2 spaces

Game signs are pre-defined signs that exist in all games, such as Message Board, Network Plan, and Voting Board.
••!!•MESSAGE BOARD•!!••
••!!•NETWORK PLAN•!!••
••!!•VOTING BOARD•!!••


Hubs use 1 space, hubname (BBH or SLH, 1 space, two-digit number), 1 space, author (slash followed by name)

Hubs include BBHs, SLHs, and any other significant merge or join in the track. It is currently not necessary to sign connections from a Sideline to a minor station.
•BBH•xx•/author
•SLH•xx•/author


Problem Detection Signs should use 1 space, exclamation mark, short description of error. Additional details of the error, including potential solutions, should be located on nearby signs. The "!" indicates a problem.

Problems are errors in existing constructions. Typical errors are broken or missing priorities, poor connections, sharp turns, missing signals, or anything else that violates the coop building rules.
•!Jam
•!Fix Signals
•!Prio Broken


Todo Signs should use 1 space, plus sign, short description of need. Additional details of what needs to be done should be located on nearby signs. The "+" indicates that something needs to be added.

Todos are items that have not been completed in areas where trains do not run. For example, an unserviced SL can have a Add Priorities Todo item. Once trains start using the SL, the Todo should be rewritten as a Problem (see above).
•+Add Priorities
•+Needs Trains
•+Add SLH here


Station Names

All major stations should be named using a specific format. Major stations include the stations marked on the plan as drop/pickup stations, as well as major transfer stations (like pax ICE terminals). Other stations (like primary industries) can optionally use a prefix to assist in sorting.

Major Stations use 1 space, industry type in all caps, 1 space, optional identifier and 1 space, PICKUP or DROP

•FACTORY•PICKUP
•OIL•NORTH•DROP
•GOODS•MYTOWN•DROP


ICE Terminals use 1 space, then a 3-character city identifier, and an optional directional indicator

•DNW
•CRF NORTH


Minor Stations can optionally use a prefix to group them together (no leading spaces), or a suffix to indicate cargo type, and are typically mixed-case

Author:StationName
SL##:StationName
Fruntleigh•North•Livestock
Powered by MediaWiki
  • This page was last modified on 14 April 2013, at 10:26.