/
spherun.1
75 lines (74 loc) · 2.91 KB
/
spherun.1
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
.TH SPHERUN 1 "2018-07-01" "miniSphere 5.2.11" "Sphere Game Development Kit"
.SH NAME
spherun \- run a Sphere game in a dev-friendly environment
.SH SYNOPSIS
.nh
.na
.TP 8
.B spherun
[\fB\-\-debug\fR | \fB\-\-profile]
[\fB\-\-retro]
[\fB\-\-fullscreen\fR | \fB\-\-window\fR]
[\fB\-\-frameskip \fImaxframes\fR]
[\fB\-\-verbose \fIlevel\fR]
.I path
.RI [ arguments ]
.ad
.hy
.SH DESCRIPTION
miniSphere is a general-purpose game engine which uses JavaScript for game coding, based on the Sphere engine developed by Chad Austin.
See
.BR minisphere (1)
for more information.
Typically, miniSphere is launched via the command
.BR minisphere (1).
When the engine is started that way, all debugging and logging features are disabled to maximize game performance.
.BR spherun (1)
is the preferred way to invoke the engine while developing a game.
.SH OPTIONS
.IP \fB\-\-fullscreen
Start the engine in fullscreen mode. This option is ignored if
.B \-\-debug
is used (see below).
.IP \fB\-\-window
Start the engine in windowed mode. This is the default when the engine is started using the
.BR spherun (1)
command.
.TP
.BR \-d ", " \-\-debug
Instruct the engine to wait for the
.BR ssj (1)
debugger to attach before beginning game execution.
If no debugger attaches within 30 seconds, miniSphere will exit.
.TP
.BR \-p ", " \-\-profile
Enables full-performance JavaScript execution by disabling the single-step debugger.
Note that this comes at the cost of SSj support.
You will not be able to attach an SSj instance later if you use this option.
.TP
.BR \-r ", " \-\-retro
Tells the engine to run in "retrograde mode", in which it will emulate the minimum API level required by the game as specified in its manifest.
In this mode, any functions, objects and properties which were added in later API levels are completely disabled, which can help you to find compatibility issues.
.TP
.BR \-v ", " \-\-verbose
Set the engine's diagnostic verbosity level.
This lets you to see under the hood at the engine's internal operation, which can often illuminate bugs in your game's logic.
If this option is not given, miniSphere will only print its version header and whatever output is generated by the game being executed.
.IP \fB\-\-frameskip
Set the maximum number of consecutive frames to skip.
miniSphere skips rendering frames when it can't keep up with a game's requested framerate.
To ensure games remain playable, no more than 5 frames will be skipped by default.
Use this option to change the maximum; note that games can override the value you provide.
.IP \fB\-\-version
Show the version number of miniSphere along with the version numbers of any libraries it depends on.
.SH READ MORE
Complete API documentation for miniSphere and related components has been installed in
.BR /usr/share/doc/minisphere .
.SH BUGS
Report any bugs found in miniSphere or the miniSphere GDK tools to:
.br
.I Bruce Pascoe <fatcerberus@icloud.com>
.SH "SEE ALSO"
.BR minisphere (1),
.BR cell (1),
.BR ssj (1)