Skip to content

Commit

Permalink
Fixed description + readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
ST-Apps committed Jul 14, 2018
1 parent c18f6ca commit 0c324b3
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 28 deletions.
4 changes: 4 additions & 0 deletions ParallelRoadTool/Localization/en.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
7) Toggles snapping to all existing nodes.
Off: snaps only to the last segments drawn when the mod was on.
On : will try to snap to the closer segment available.

Negative values are allowed for both vertical and horizontal distances.
A negative horizontal distance will place the road on the opposite side.
A negative vertical distance will place the road below terrain level.
</LocalizedString>
</strings>
</NameList>
4 changes: 2 additions & 2 deletions ParallelRoadTool/ModInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ public ModInfo()
#if DEBUG
public string Name => $"[BETA] Parallel Road Tool {Version} b-{Branch}";
#else
public string Name => $"Parallel Road Tool {Version} b-{Branch}";
public string Name => $"Parallel Road Tool {Version}";
#endif

public string Description =>
"This mod allows players to easily draw parallel roads in Cities: Skylines. ";
"This mod allows players to easily draw parallel/stacked roads in Cities: Skylines.";

public void OnSettingsUI(UIHelperBase helper)
{
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# CS-ParallelRoadTool
A mod that allows players to easily draw parallel roads in Cities: Skylines.
A mod that allows players to easily draw parallel/stacked roads in Cities: Skylines.

**Tested on version 1.10.0-f3**
**Tested on version 1.10.1-f3**

## Features
- Limitless parallel/stacked configurations: you can choose any network (not only roads!) and distances (both horizontal and vertical) to easily create every layout that you want
- Visual overlay guidelines to help you visualizing what you're going to build before actually building
- One-way networks support: you can reverse the direction of any one-way network, so that you can easily build highways without needing to manually upgrade direction later
- Left-hand drive support

## Known limitations/issues

- **[Fine Road Anarchy](https://steamcommunity.com/workshop/filedetails/?id=802066100) is highly recommended!** (*mod works without it but you won't be able to connect some segments without an anarchy mod*)
- Sharp angles produce weird results, curves work better
- Roads will always follow terrain elevation
- Tunnel entrances/exists are not working but underground roads should (see [#3](/../../issues/3))
- Snapping only works with the last node drawn by the mode (see [#4](/../../issues/4))

## Features that may come somewhere in the future

- Ability to save/load presets
- Ability to toggle on/off terrain conforming
- Visual guidelines overlay
- Ability to center cursor on the middle point between all the selected roads

## Support my work
Expand Down
75 changes: 54 additions & 21 deletions workshop/description.beta.txt
Original file line number Diff line number Diff line change
@@ -1,47 +1,80 @@
[h1][BETA] ParallelRoadTool[/h1]

A mod that allows players to easily draw parallel roads in Cities: Skylines.
[h1][b][BETA] ParallelRoadTool[/b][/h1]
helps you easily drawing parallel and stacked networks.
Main features are:
[list]
[*] [b]Limitless parallel/stacked configurations[/b]: you can choose [b]any network (not only roads!) and distances (both horizontal and vertical)[/b] to easily create every layout that you want
[*] [b]Visual overlay guidelines[/b] to help you visualizing what you're going to build before actually building
[*] [b]One-way networks support[/b]: you can reverse the direction of any one-way network, so that [b]you can easily build highways without needing to manually upgrade direction later[/b]
[*] Left-hand drive support
[/list]

[h1] The beta version is meant for testing only and it can be unstable. (non-beta version is coming soon)[/h1]
[h1][b]The beta version is meant for testing only and it can be unstable.[/b] (non-beta version is coming soon)[/h1]
[b]Tested on version 1.10.1-f3 - Current branch is [i]dev[/i][/b]

[b]Tested on version 1.10.0-f3[/b]
[quote]
[h1]Current version: [b]0.24.0[/b] [url=http://steamcommunity.com/sharedfiles/filedetails/changelog/1400711138]Changelog[/url], [url=https://github.com/ST-Apps/CS-ParallelRoadTool]Source code[/url][/h1]
[list]
[*] Fixed node snapping when changing offsets.
[*] Added keybinds for vertical offset.
[*] Added Russian translation
[/list]
[/quote]

[quote]
[h1]Known limitations/issues[/h1]

[list]
[*][url=https://steamcommunity.com/workshop/filedetails/?id=802066100][b]Fine Road Anarchy[/b][/url] [b]is highly recommended![/b] ([i]mod works without it but you won't be able to connect some segments without an anarchy mod[/i])
[*]Sharp angles produce weird results, curves work better [*]Roads will always follow terrain elevation
[*]Tunnel entrances/exists are not working but underground roads should
[*]Snapping only works with the last node drawn by the mode
[/list]
[*][url=https://steamcommunity.com/workshop/filedetails/?id=802066100][b]Fine Road Anarchy[/b][/url] [b]is highly recommended![/b] ([i]mod works without it but you won't be able to connect some segments without an anarchy mod[/i])
[*]Sharp angles produce weird results, curves work better
[*]Roads will always follow terrain elevation
[*]Visual overlay guides have a little issue with curves (it's hard to explain) but it's only a little visual glitch that disappears as soon as you click to set curve's angle
[/list]
[/quote]

[quote]
[h1][b]Supported languages (% translated)[/b][/h1]
[list]
[*] English (100 %)
[*] Russian (90 %) (thanks to [url=https://steamcommunity.com/profiles/76561198006764601/]vitalii201[/url])
[/list]

[h1]Features that may come somewhere in the future[/h1]
The language is automatically determined based on your settings in "Options" -> "Gameplay".
Please [b]open an issue on [url=https://github.com/ST-Apps/CS-ParallelRoadTool/issues]GitHub[/url][/b] if you want to help translate this mod, add missing translations or correct translation mistakes.
[/quote]

[quote]
[h1]Features that may come somewhere in the future[/h1]
[list]
[*]Ability to save/load presets
[*]Ability to toggle on/off terrain conforming
[*]Visual guidelines overlay
[*]Ability to toggle on/off terrain conforming
[*]Ability to center cursor on the middle point between all the selected roads
[/list]
[/list]
[/quote]

[quote]
[h1]Support my work[/h1]
Donate using PayPal:
[url=paypal.me/STApps][img]https://i.imgur.com/dSkdACn.png[/img][/url]
[/quote]

Donate using PayPal: [url=https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CZB2MWEN2JZAN][img]https://i.imgur.com/dSkdACn.png[/img][/url]

[quote]
[h1]Source code[/h1]

[url=https://github.com/ST-Apps/CS-ParallelRoadTool]GitHub[/url]
[/quote]

[quote]
[h1]How to contribute[/h1]

If you find an issue, please search [url=https://github.com/ST-Apps/CS-ParallelRoadTool/issues]here[/url] to see if someone already reported it and, eventually, comment on the already reported one.
If you can't find any issue similar to yours, please click [url=https://github.com/ST-Apps/CS-ParallelRoadTool/issues/new]here[/url] and provide all the informations that you can (screenshots and logs are welcome).

If you're interested in helping with development, choose an issue and ask to be assigned. I'll create a branch for that issue and you'll be able to work there.
If there's no issue for the thing you'd like to work on, feel free to open a new one.
[/quote]

[quote]
[h1]Thanks to[/h1]

[list]
[*][url=https://community.simtropolis.com/profile/755624-reasonably1]reasonably1[/url] for his work on the UI
[*]SamsamTS for his FineRoadAnarchy mod, which provided me the basics for this one
[*][url=https://steamcommunity.com/id/samsamts]SamsamTS[/url] for his FineRoadAnarchy mod, which provided me the basics for this one
[*][url=https://steamcommunity.com/id/victorphilipp]LinuxFan[/url] for his pointers on how to fix snapping
[/list]
[/quote]

0 comments on commit 0c324b3

Please sign in to comment.