forked from Marginal/SeaTraffic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SeaTraffic-ReadMe.html
155 lines (138 loc) · 9.6 KB
/
SeaTraffic-ReadMe.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
<meta content="Marine traffic plugin for X-Plane">
<meta content="X-Plane, simulator, scenery, marine, sea" name="keywords">
<title>SeaTraffic</title>
<meta content="Jonathan Harris" name="author">
<style type="text/css">
.banner { font-family: Arial,Helvetica,sans-serif; background-color: lightskyblue; text-align: left; vertical-align: middle; height: 32px; }
td { vertical-align: middle; }
.dnl { font-family: Arial,Helvetica,sans-serif; font-size: small; background-color: lightskyblue; }
samp { font-family: Arial,Helvetica,sans-serif; }
h2 { font-family: Arial,Helvetica,sans-serif; }
h3 { font-family: Arial,Helvetica,sans-serif; }
h4 { font-family: Arial,Helvetica,sans-serif; }
h5 { font-family: Arial,Helvetica,sans-serif; }
</style>
</head>
<body>
<table style="width: 100%;" border="0" cellpadding="2">
<tbody>
<tr>
<td class="banner">Marginal → <a href="http://marginal.org.uk/x-planescenery/">X-Plane Scenery</a> → <a href="http://marginal.org.uk/x-planescenery/tools.html">Tools</a> → SeaTraffic</td>
</tr>
</tbody>
</table>
<hr>
<h2>SeaTraffic plugin for X-Plane<small><sup>®</sup></small></h2>
<h3>Overview</h3>
<p>This X-Plane plugin displays ships moving along real-life routes.</p>
<h3>Requirements</h3>
<p>This plugin can be used with X-Plane 9 or later. It relies on the <a target="_blank" href="http://www.opensceneryx.com/">OpenSceneryX</a> Object Library for some of its ship models.</p>
<h3>Installation</h3>
<ul>
<li>If you do not already have the OpenSceneryX Object Library installed, <a target="_blank" href="http://www.opensceneryx.com/">download</a> and install it.</li>
<!--
</ul>
<h4>Installing using <a target="_blank" href="http://code.google.com/p/xaddonmanager/">XAddOnManager</a> (recommended)</h4>
<ul>
<li>Run XAddOnManager.</li>
<li>Click on the the <samp>Plugins</samp> tab.</li>
<li>Press the <samp>Install…</samp> button.</li>
<li>Navigate to and select this <code>.zip</code> archive.</li>
</ul>
<h4>Installing by hand</h4>
<ul>
-->
<li>Copy or move the <code>SeaTraffic</code> folder from within this archive into the <code>X-Plane/Resources/plugins</code> folder.</li>
</ul>
<h3>Options</h3>
<p>If the plugin is installed correctly, you will see a <samp>SeaTraffic</samp> entry in X-Plane’s <samp>Plugins</samp> menu. This offers one option:</p>
<dl style="margin-left: 40px;">
<dt><samp>Draw routes in Local Map</samp></dt>
<dd>Controls whether routes and current ship positions are shown in X-Plane’s <samp>Location → Local Map</samp>.</dd>
</dl>
<p>The plugin obeys the following settings in X-Plane’s <samp>Settings → Rendering Options</samp>:</p>
<dl style="margin-left: 40px;">
<dt><samp>number of objects</samp></dt>
<dd>Controls the maximum number of ships.</dd>
<dt><samp>shadow detail</samp> <small>(X-Plane 10 or later)</small></dt>
<dd>Ships are shown with shadows when this is set to “global (low)” or above.</dd>
<dt><samp>water reflection detail</samp></dt>
<dd>Ships are shown with reflections and wakes when this is set to “medium” or above.</dd>
</dl>
<hr>
<h3>Adding / modifying routes</h3>
<p>This plugin uses ferry routes extracted from the <a target="_blank" href="http://www.openstreetmap.org/">OpenStreetMap</a> project. If you find that a ferry route is missing or incorrect you can <a target="_blank" href="http://www.openstreetmap.org/user/new">sign up</a> to the project and add or modify the route. Start by reading the Beginners’ guide and other info on the <a target="_blank" href="http://wiki.openstreetmap.org">Main Page</a>.</p>
<p>The OpenStreetMap “way” tags for creating a ferry route are described <a target="_blank" href="http://wiki.openstreetmap.org/wiki/Tag:route%3Dferry">here</a> and <a target="_blank" href="http://wiki.openstreetmap.org/wiki/Proposed_features/ferry#cruise_ships.2C_cruise_ferries.2C_express_boats">here</a>. This plugin uses these tags to choose which type of ship to display. At minimum you should set the following tags:</p>
<ul>
<li><tt><a target="_blank" href="http://wiki.openstreetmap.org/wiki/Tag:route%3Dferry">route</a> = ferry</tt></li>
<li><tt>name = <i>route name</i></tt></li>
<li><tt>ref = <i>line number or route code</i> </tt><small>(if applicable)</small></li>
<li><tt>motor_vehicle = yes / no</tt></li>
</ul>
<p>You can further specify the type and size of ship with the following tags:</p>
<ul>
<li><tt><a target="_blank" href="http://wiki.openstreetmap.org/wiki/Proposed_features/ferry#cruise_ships.2C_cruise_ferries.2C_express_boats">ferry</a> = tourist / cruise</tt> <small>(if applicable)</small></li>
<li><tt>hgv = yes / no</tt></li>
<li><tt>motorcar = yes / no</tt></li>
<li><tt>foot = yes / no</tt></li>
</ul>
<h4>Getting your new / modified route into X-Plane</h4>
<p>This plugin doesn’t read ferry routes directly from the OpenStreetMap servers (that would be too slow). Instead, it contains a pre-computed database of routes. In order to visualise your new or modified ferry route(s) in X-Plane you can either:</p>
<ul>
<li>wait for the <a href="mailto:x-plane@marginal.org.uk">author</a> to release a new version of the plugin, or</li>
<li>wait about an hour for your edits to appear on the OpenStreetMap servers, then re-generate the plugin’s database by running the script <code>X-Plane/Resources/plugins/SeaTraffic/buildroutes.py</code> <small>(Windows users must install <a target="_blank" href="https://www.python.org/downloads/windows/">Python 2.7</a> in order to run this script)</small>.</li>
</ul>
<hr>
<h3>Replacing ship models</h3>
<p>You can use X-Plane’s <a target="_blank" href="http://developer.x-plane.com/?article=library-library-txt-file-format-specification">library system</a> to replace the plugin’s built-in ship models. <tt>EXPORT</tt> object(s) from your scenery package with the following ‹virtual path(s)›:</p>
<dl style="margin-left: 40px;">
<dt><tt>marginal/seatraffic/tourist.obj</tt></dt>
<dt><tt>marginal/seatraffic/cruise.obj</tt></dt>
<dt><tt>marginal/seatraffic/ped/sml.obj</tt></dt>
<dt><tt>marginal/seatraffic/ped/med.obj</tt></dt>
<dt><tt>marginal/seatraffic/veh/sml.obj</tt></dt>
<dt><tt>marginal/seatraffic/veh/med.obj</tt></dt>
<dt><tt>marginal/seatraffic/veh/big.obj</tt></dt>
</dl>
<p>You <i>must</i> use the <tt>REGION</tt> statement in your <samp>library.txt</samp> file to restrict the use of your ship models to your geographical area of interest. Ships starting their journey within your region will use your model(s), but any ships arriving from outside of your region will still use the default models.</p>
<p>You must restart X-Plane to see the effect of changes to your <samp>library.txt</samp> file - X-Plane only looks for and reads scenery libraries once at startup.</p>
<p>Refer to this <a target="_blank" href="http://marginal.org.uk/x-planescenery/tutorials.html#seatraffic">example scenery package</a> for a worked example.</p>
<h4>Troubleshooting</h4>
<dl>
<dt>There is no <samp>SeaTraffic</samp> entry in X-Plane’s <samp>Plugins</samp> menu, and I don't see any ships at all:</dt>
<dd>Open the file <samp>Log.txt</samp> in the X-Plane folder and search for a message <tt>SeaTraffic: Missing REGION statement for customization of ship ‹virtual path›</tt>.<br>
If you see this message then you haven't correctly used a <tt>REGION</tt> for your ship model(s) in your <samp>library.txt</samp> file.</dd>
<dt> </dt>
<dt>I see the default ship models instead of my ship models:</dt>
<dd>Check that you’re overriding the appropriate ‹virtual path(s)› (listed above) in your <samp>library.txt</samp> file.<br>
Check that you’re using the <tt>REGION_RECT</tt> statement correctly in your <samp>library.txt</samp> file.</dt>
<dt> </dt>
<dt>I see ship wakes, but I don't see my ship models:</dt>
<dd>Search in <samp>Log.txt</samp> for error messages from the SeaTraffic plugin and/or from X-Plane containing your ship object’s filename.</dd>
</dl>
<hr>
<h3>Acknowledgements</h3>
<p>“X-Plane” is a registered trademark of <a href="http://www.x-plane.com/">Laminar Research</a>.</p>
<p>Medium vehicle ferry courtesy of Roy Leonard.</p>
<h3>License</h3>
<p>This kit is licensed under the GNU <a rel="license" target="_blank" href="http://www.gnu.org/licenses/lgpl-2.1-standalone.html">LGPL v2.1</a> license.<br>
It uses map data © <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, licensed under the <a href="http://opendatacommons.org/licenses/odbl/">Open Data Commons Open Database License</a> (ODbL).</p>
<hr>
<table style="width: 100%;" border="0" cellspacing="0" cellpadding="2">
<tbody>
<tr>
<td class="banner">Version 1.31 © 2012-2015 <a href="mailto:x-plane@marginal.org.uk">Jonathan Harris</a>
<a rel="license" target="_blank" href="http://www.gnu.org/licenses/lgpl-2.1-standalone.html"><img style="border: 0px solid ; width: 88px; height: 62px; vertical-align: middle;" alt="LGPLv2.1 License" src="http://i.creativecommons.org/l/LGPL/2.1/88x62.png"></a></td>
<td class="banner" style="text-align: right">
<a href="http://www.openstreetmap.org/"><img src="SeaTraffic/Osm_linkage.png" style="border: none;" /></a>
<a href="http://www.opensceneryx.com/"><img src="SeaTraffic/enhancedby_opensceneryx_logo.png" alt="Enhanced by OpenSceneryX" style="border: none;" /></a>
</td>
</tr>
</tbody>
</table>
</body>
</html>