-
Notifications
You must be signed in to change notification settings - Fork 0
/
rigg.1
113 lines (113 loc) · 2.31 KB
/
rigg.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
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
.Dd $Mdocdate$
.Dt RIGG 1
.Os
.Sh NAME
.Nm rigg
.Nd run independent games
.Sh SYNOPSIS
.Nm rigg
.Op Fl v
.Op Fl u Ar strict | permissive | none
.Ar engine
.Ar file
.Op Ar game arguments
.Nm rigg
.Op Fl hl
.Sh DESCRIPTION
.Nm
serves as a thin,
.Ox Ns -adapted runtime wrapper for independent games based on certain engines
.Po
see
.Ar engine
.Pc .
.Nm
handles visibility of files by using
.Xr unveil 2
to hide those that conflict with execution on
.Ox .
This solves a common problem with commercial games based on open-source
frameworks like FNA, LibGDX, or HashLink.
In addition,
.Nm
also enforces a minimum-necessary filesystem view by default via
.Xr unveil 2 .
Some basic engine configuration for
.Ox
like dllmap for
.Xr mono 1
is included.
More complex configuration like filesystem changes or
game-specific environment variables are out of scope.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Ar engine
Specify the engine to use.
Can select from:
.Ar mono ,
.Ar hl .
.It Ar file
The file to launch with the engine, e.g.
.Pa Game.exe
.Pq mono
or
.Pa hlboot.dat
.Pq hl .
.It Fl h
Show usage information.
.It Fl l
List the binaries of supported engines.
.It Fl u
Set unveil mode.
.Ar strict
is the default and reduces read/write/create/execute permissions to a limited
set of paths and hides game files that interfere with execution on
.Ox .
.Ar permissive
only hides game files when needed for engine execution, but otherwise doesn't
restrict filesystem access.
.Ar none
disables all uses of unveil and is generally equivalent to running the
.Ar engine Ns 's
own binary.
.It Fl v
Enable verbose output.
.El
.Sh EXIT STATUS
.Ex -std
After successful launch of the engine, the
.Ar engine Ns 's
exit status is returned.
See engine-specific documentation.
.Sh EXAMPLES
Run Mono game
.Pa Game.exe
with a game-specific flag
.Fl windowed :
.Bd -literal -offset indent
$ rigg mono Game.exe -windowed
.Ed
.Pp
Run HashLink game
.Pa hlboot.dat
with verbose output:
.Bd -literal -offset indent
$ rigg -v hl hlboot.dat
.Ed
.Sh SEE ALSO
.Xr mono 1 ,
.Xr unveil 2
.Sh AUTHORS
.An -nosplit
.An Thomas Frohwein Aq Mt thfr@openbsd.org
.Sh CAVEATS
The selection of directories that are
.Xr unveil 2 Ns ed
may not cover all potential use cases.
Some games fail to launch or have bugs in
.Ar strict
mode if they try to
.Xr stat 2
.Pa /home
or other hidden directories.