Skip to content

Commit 28e402e

Browse files
authored
Merge pull request #12 from mars-sim/start_chooser
Update for startup chooser
2 parents ee2edd7 + f586600 commit 28e402e

File tree

3 files changed

+33
-9
lines changed

3 files changed

+33
-9
lines changed

content/docs/guide/started/installation.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,35 @@ description: Details of installation procedure
44
weight: 10
55
---
66

7-
## Prerequisites
7+
There are two installation packages available for the Simulation.
8+
9+
- Windows MSI File
10+
- ZIP file
11+
12+
## Windows MSI
13+
14+
This approach provides a shrink wrapped installation of the UI application. It does not contain the headless server version. This can be downloaded from Assets section in [Releases](https://github.com/mars-sim/mars-sim/releases) as a MSI file that is applicable for a Windows installation.
15+
16+
This has no prerequisites.
17+
18+
## ZIP File
19+
20+
This approach is more complex but provides a wider range of options. Command lines arguments can be used.
21+
22+
### Prerequisites
823

924
Currently, mars-sim supports Java 21 which is a LTS (Long Term Support release). Requires only JRE 21 for running mars-sim. See [JDK21](https://jdk.java.net/java-se-ri/21)
1025

1126
The application supports Windows or Linux. MacOS is supported but not via a command script; Java must be called directly.
1227

13-
## Applications
28+
### Applications
1429

1530
The installation consists of 2 application:
1631

1732
- A UI application based on Java Swing
1833
- A headless server version that can be accessed remotely via an SSH interface.
1934

20-
## Installation Process
35+
### Installation Process
2136

2237
The installation process is simple requiring command line access.
2338

content/docs/guide/started/starting.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,18 @@ description: Starting Simulation instructions
55
weight: 30
66
---
77

8-
The distribution supports both Windows and Linux.
8+
## Quick Start Sequence
9+
10+
Starting the simulation with no arguments or via the MSI installation will present the StartUp Chooser offering a number of options.
11+
12+
{{< figure src="/images/screenshots/starter.png" caption="Main Starter" >}}
13+
14+
The _New_ option start a new Simulation using the [Default](../../../definitions/scenario/default) Scenario. Whilst the _Select Scenario_ allows the selecting of a different pre-defined Scenario in a new Simulation.
15+
16+
## Command Line Starting Sequence
17+
18+
The ZIP distribution supports both Windows and Linux and uses a command line starting sequence.
19+
920
It also provides 2 variants of the mars-sim application.
1021
1. Swing based UI
1122
2. Console based engine that is accessed via SSH
@@ -21,16 +32,16 @@ Start commands are:
2132
Common command line arguments are:
2233
-baseurl <URL to remote content> URL to the remote content repository
2334
(defaults to master in GitHub)
24-
-crew <true|false> Enable or disable use of the crews
35+
-configdir <directory> Directory for configurations files
2536
-datadir <path to data directory> Path to the data directory for
2637
simulation files (defaults to user.home)
2738
-diags <<module>,<module>.....> Enable diagnostics modules
2839
-help Display help options
29-
-lat <latitude> Set the latitude of the new template Settlement
3040
-load <path to simulation file> Load the a previously saved sim.
3141
No argument open file selection dialog.
3242
'default' will use default
33-
-lon <longitude> Set the longitude of the new template Settlement
43+
-location <coordinates> Set the coordinates of the new template Settlement
44+
-log <logfile [size K|M|G:count]> Enable logging to a logfile sequence with an optional size per file
3445
-new Enable quick start
3546
-scenario <scenario name> New simulation from a scenario
3647
@@ -41,9 +52,7 @@ Common command line arguments are:
4152
Swing variant arguments
4253
-cleanui Disable loading stored UI configurations
4354
-noaudio Disable the audio
44-
-nogui Disable the main UI
4555
-profile Set up the Commander Profile
46-
-sandbox Start in Sandbox Mode
4756
-site Start the Scenario Editor
4857
4958
Console variant arguments
191 KB
Loading

0 commit comments

Comments
 (0)