Skip to content

Commit 41c9f26

Browse files
Changed the documentation
1 parent a0eae37 commit 41c9f26

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed
Loading

Source/Documentation/Manual/software-platform.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ A number of web-pages are included in the Open Rails installation as examples of
124124
what can be done with the APIs.
125125

126126
Some of these sample pages repeat data from the in-game panels to provide a more convenient display.
127+
The sample pages can be found in the ``Content\Web`` subfolder of the OR
128+
program folder and the web server defaults to ``Content\Web\index.html``.
129+
130+
If you choose to develop your own pages, please consider sharing them with the Open Rails community.
127131

128132
- The HUD web page repeats the F5 overlay.
129133

@@ -139,17 +143,10 @@ Some of these sample pages repeat data from the in-game panels to provide a more
139143

140144
.. image:: images/web-page-clock.png
141145

142-
- The Map page shows the position and direction of the train in the real world on the
143-
`OpenRailwayMap <https://www.openrailwaymap.org/`_. Different OpenRailwayMap layers are available.
146+
- The Map page shows the position and direction of the train in the real world on the OpenRailwayMap https://www.openrailwaymap.org. Different OpenRailwayMap layers are available. Usability depends on the route, position of the train is not always 100% correct.
144147

145148
.. image:: images/web-page-map.png
146149

147-
148-
The sample pages can be found in the ``Content\Web`` subfolder of the OR
149-
program folder and the web server defaults to ``Content\Web\index.html``.
150-
151-
If you choose to develop your own pages, please consider sharing them with the Open Rails community.
152-
153150
.. _web-server-api:
154151

155152
Application Programming Interfaces (APIs)
@@ -191,6 +188,11 @@ Note: To avoid overloading the simulator, please keep API calls to once or twice
191188
- | ``/API/TIME``
192189
- | Retrieves just the simulation time in seconds since midnight.
193190
- | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiTime``
191+
* - | GET
192+
- | ``/API/MAP``
193+
- | Retrieves the postion and direction of the train.
194+
| Next to various Open Rails route data.
195+
- | ``Orts.Viewer3D.WebServices .WebServer.ORTSApiController .ApiMap``
194196
* - | GET
195197
- | ``/API/CABCONTROLS``
196198
- | Retrieves an array of the cab controls for the player localhost

0 commit comments

Comments
 (0)