Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
because of previous commits: fixes #2
  • Loading branch information
Craxy authored and Craxy committed Mar 29, 2015
1 parent 75b8393 commit 500c056
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@ Mod for Cities:Skylines
Tool to **remove or add traffic lights at intersection**. Traffic lights can be added and removed at any kind of road intersection including highways and their off- and on-ramps.
![Same intersection with and without traffic lights](./docs/files/img/TrafficLightsVsNoTrafficLights.png)

In game the tool can be activate via **Ctrl+T**. When you hover over an intersection a ToolTip will show the current Traffic Light status (has traffic light or not). Via a left mouse click you can toggle between traffic lights and no traffic lights. To disable this tool simply select another tool.
In game the tool can be activated via a **button in the roads menu** below the roads tool or via the **Ctrl+T**.
![Deactivated button in the roads menu](./docs/files/img/Button_Deactivated.png)![Activated button in the roads menu](./docs/files/img/Button_Activated.png)
When you hover over an intersection a ToolTip will show the current Traffic Light status (has traffic light or not). Via a left mouse click you can toggle between traffic lights and no traffic lights. To disable this tool simply select another tool.


**Note**: The existence of traffic lights will be added to new savegames (the savegame size increases by a couple of kB (~33kB) -- I think that's negligible). The savegame can be loaded without the mod enabled but in this case the traffic lights will be reset to it's original statuses (see [this table](https://www.reddit.com/r/CitiesSkylines/comments/2zp61z/i_made_a_table_chart_of_which_intersections/) for the default statuses).

Note: If you append or remove a road to/from an intersection the traffic lights will be recalculated by the game and placed according to the used road types. You must then retoggle the traffic lights via this tool.

Note: The tool is now disabled in the editors. It does not have to be disable in the editors anymore.
Note: The tool is disabled in the editors.

## Known Issues & Further Work
This mod is currently a very early version! Toggling the traffic lights works already but there are some issues and further work:
See: https://github.com/Craxy/ToggleTrafficLights/issues
* There is currently no button to activate this tool. You need to use Ctrl+T. A button below the road options is planned.
* On some intersections it's quite hard to find the right point to click (especially on on- and off-ramps). I'm using the integrated detection of NetNode, so the detection will most likely remain the way it is. Just fiddle around a bit until the ToolTip shows up.
* The current ToolTip to indicate an intersection is more or less an interim solution. For later version it's planned to use the same highlighting as the usual selection or bulldozer tools.
This mod is currently a very early version! Toggling the traffic lights works already but there are some issues and further work: https://github.com/Craxy/ToggleTrafficLights/issues

### Issues with other mods
* [Extended Road Upgrade](https://steamcommunity.com/sharedfiles/filedetails/?id=408209297): **Both mods work side by side but the display of the button for this mod will not work correct.** ERU is grabbing all tool changes of the default road tools and reverts the selected button if ERU is not enabled. Therefore whenever the Traffic Lights button is clicked the ERU reverts the selected button to the last selected one of the built-in tools. Because of this when ERU is detected the built-in buttons will not visually deselected and therefore the Traffic Lights button and a built-in button will be highlighted simultaneous:
![Deactivated button in the roads menu](./docs/files/img/Button_ActivatedWithERU.png)
The functionality of the Traffic Lights tool is not affected. But deselecting the tool by clicking on the other selected button is not possible -- click on another button first. Additional changing from one of the ERU tools to traffic lights directly is not -- it will automatically select one of the default tools. Click again on the Traffic Lights button to enable the tool.
* [Lane Changer](https://steamcommunity.com/sharedfiles/filedetails/?id=412101021): **This mod is not compatible with Toggle Traffic Lights**. I have not inspected the problem -- but it seems both mods modify the same data and thwart each other.

* You can toggle traffic lights on every NetNode with an intersection -- i.e. not only intersections between car roads but also on pedestrian paths and railway crossings between trains (both without any visual effect). I have not checked the effect on these kind of intersection. It's planned for further version to disable the toggling on pedestrian and train roads.
* Traffic lights at railway crossings between railway and roads with cars can be added and removed too. I have not inspected the resulting effect. If nobody identifies some use it will most likely be removed in the future.
* It's currently possible to add traffic lights at intersections even if it doesn't make sense -- like just one ingoing road and the remaining ones are just outgoing. The idea for further version is to only allow traffic lights if there are at least two incoming roads present. However this is of very low priority and just might or might not be implemented. At those junctions traffic lights will be most likely always be green, so there is no harm in keeping this.


## Release Notes
Expand All @@ -36,7 +37,12 @@ See: https://github.com/Craxy/ToggleTrafficLights/issues
* Disabled tool inside the editors
* Traffic lights outside the buildable area cannot be toggled anymore

### 0.3.0 (2015-03-29)
* Added button in the roads menu
* Added message for errors while saving/loading
* Shortcut (Ctrl+T) now recognized right Ctrl too



### Additional Infos
* Some code is taken from or inspired by the mod "Extended Road Upgrade" by viakmaky: https://github.com/viakmaky/Skylines-ExtendedRoadUpgrade (MIT licence)
* Some code is taken from or inspired by the mod "Extended Road Upgrade" by viakmaky: https://github.com/viakmaky/Skylines-ExtendedRoadUpgrade (MIT licence)
Binary file added docs/files/img/Button_ActivatedWithERU.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 500c056

Please sign in to comment.