Skip to content

Commit af1b35a

Browse files
authored
Merge pull request #618 from cjakeman/manual-firewall
added web-server firewall to Manual
2 parents 5913d44 + 141ae69 commit af1b35a

File tree

4 files changed

+32
-2
lines changed

4 files changed

+32
-2
lines changed
Loading

Source/Documentation/Manual/options.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ Disable TCS scripts
142142
This option disables the train control system scripts for locomotives where
143143
these have been implemented.
144144

145+
.. _options-web-server-port:
146+
145147
Web server port
146148
-----------------
147149

Source/Documentation/Manual/software-platform.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ MonoGame is an open source implementation of the Microsoft XNA 4 Framework and p
3535
Frames per Second (FPS) Performance
3636
===================================
3737

38-
FPS rate is as default not linked to the sync rate of the monitor. However, with :ref:`this option <options-vsync>` FPS rate may be set at the value of the monitor refresh rate.
38+
FPS rate is as default not linked to the sync rate of the monitor.
39+
However, with :ref:`this option <options-vsync>` FPS rate may be set at the value of the monitor refresh rate.
3940

4041
Game Clock and Internal Clock
4142
=============================
@@ -101,15 +102,26 @@ the software will contribute to better overall performance -- potentially
101102
allowing high polygon models with densely populated routes at acceptable
102103
frame rates.
103104

105+
.. _web-server:
106+
104107
Web Server
105108
==========
106109

107110
.. _sample-web-pages:
108111

112+
The game uses a built-in web-server to deliver standard and custom web-pages
113+
to any browser. This can be running on the same PC as Open Rails or another PC
114+
or other device which is connected to your local network.
115+
116+
The simplest way to access these samples is to start the game and then launch
117+
a browser on the same PC. Then enter "localhost:2150" into your browser address bar.
118+
(2150 is the default port number set in :ref:`Menu > Options > General <options-web-server-port>`)
119+
109120
Sample Web Pages
110121
----------------
111122

112-
These pages give examples of what can be done with the APIs.
123+
A number of web-pages are included in the Open Rails installation as examples of
124+
what can be done with the APIs.
113125

114126
Some of these sample pages repeat data from the in-game panels to provide a more convenient display.
115127

Source/Documentation/Manual/start.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,22 @@ Now, click on ``Start``, and OR will start loading the data needed for your
180180
game. When loading completes you will be within the cab of your
181181
locomotive! You can read further in the chapter :ref:`Driving a Train <driving>`.
182182

183+
Firewall
184+
========
185+
186+
The game uses a built-in web-server to deliver standard and custom web-pages
187+
to any browser - see :ref:`Web Server <web-server>`.
188+
189+
190+
When the game runs for the first time, the web-server will try to use a
191+
port on your PC to serve any browser that you might want to run.
192+
The Windows OS will detect this and pop up a prompt to ask permission for this.
193+
194+
.. image:: images/firewall.png
195+
196+
We recommend that you grant permission as a private network even if you
197+
don't plan to use a browser straight away.
198+
183199
Multiplayer Mode
184200
----------------
185201

0 commit comments

Comments
 (0)