-
-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathcommon-config.ts
277 lines (255 loc) · 8.47 KB
/
common-config.ts
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
import { Type, Static } from '@sinclair/typebox';
import {
LayoutConfig,
LayoutConfigSchema,
defaultLayoutConfig,
} from './layout-config';
import { SettingsConfig, SettingsConfigSchema } from './settings-config';
import { DEFAULT_TEXT_SPEED } from '@/constants';
export const HotkeysConfigSchema = Type.Optional(
// See inputs-store.ts for possibilities
Type.Record(Type.String(), Type.Union([Type.String(), Type.Boolean()])),
);
export type HotkeysConfig = Static<typeof HotkeysConfigSchema>;
export const DialogPanelConfigSchema = Type.Optional(
Type.Object({
animateText: Type.Optional(Type.Boolean()),
textSpeed: Type.Optional(Type.Number()),
timeBetweenLines: Type.Optional(Type.Number()),
overlayMode: Type.Optional(Type.Boolean()),
rightOffset: Type.Optional(Type.Number()),
bottomOffset: Type.Optional(Type.Number()),
width: Type.Optional(Type.Number()),
height: Type.Optional(Type.Number()),
hideDuringTransition: Type.Optional(Type.Boolean()),
historyLength: Type.Optional(Type.Number()),
allowHistoryToggling: Type.Optional(Type.Boolean()),
showAfterScriptEnd: Type.Optional(Type.Boolean()),
}),
);
export type DialogPanelConfig = Static<typeof DialogPanelConfigSchema>;
export const SplashScreenConfigSchema = Type.Object({
engineSplashScreen: Type.Optional(
Type.Object({
skip: Type.Optional(Type.Boolean()),
fadeDuration: Type.Optional(Type.Number()),
timeBeforeFadeout: Type.Optional(Type.Number()),
overrideText: Type.Optional(Type.String()),
overrideLogo: Type.Optional(Type.String()),
}),
),
gameSplashScreen: Type.Optional(
Type.Object({
startButtonText: Type.Optional(Type.String()),
}),
),
});
export type SplashScreenConfig = Static<typeof SplashScreenConfigSchema>;
export const NotificationsConfigSchema = Type.Object({
timeOnScreen: Type.Number(),
alsoPrintInDialogue: Type.Optional(Type.Boolean()),
});
export type NotificationsConfig = Static<typeof NotificationsConfigSchema>;
export const HudStatDataSchema = Type.Object({
name: Type.String(),
icon: Type.String(),
startingValue: Type.Number(),
maxValue: Type.Optional(Type.Number()),
minValue: Type.Optional(Type.Number()),
decimals: Type.Optional(Type.Number()),
prefix: Type.Optional(Type.String()),
suffix: Type.Optional(Type.String()),
hideName: Type.Optional(Type.Boolean()),
// Formatting options, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options
formatting: Type.Optional(
Type.Object({
style: Type.Union([
Type.Literal('decimal'),
Type.Literal('currency'),
Type.Literal('percent'),
Type.Literal('unit'),
]),
currency: Type.Optional(Type.String()),
unit: Type.Optional(Type.String()),
}),
),
});
export type HudStatData = Static<typeof HudStatDataSchema>;
export const HudStatsConfigSchema = Type.Record(
Type.String(),
HudStatDataSchema,
);
export type HudStatsConfig = Static<typeof HudStatsConfigSchema>;
export const InteractionTagsConfigSchema = Type.Record(
Type.String(),
Type.Object({
onlyInteractOutsideOfScripts: Type.Optional(Type.Boolean()),
}),
);
export type InteractionTagsConfig = Static<typeof InteractionTagsConfigSchema>;
export const TransitionSettingsSchema = Type.Object({
delay: Type.Optional(Type.Number()),
duration: Type.Optional(Type.Number()),
});
export type TransitionSettings = Static<typeof TransitionSettingsSchema>;
export const TransitionsConfigSchema = Type.Record(
Type.String(),
TransitionSettingsSchema,
);
export type TransitionsConfig = Static<typeof TransitionsConfigSchema>;
export const MenuButtonConfigSchema = Type.Object({
text: Type.String(),
cssClass: Type.Optional(Type.String()),
});
export type MenuButtonConfig = Static<typeof MenuButtonConfigSchema>;
export const MenuButtonsConfigSchema = Type.Record(
Type.String(),
MenuButtonConfigSchema,
);
export type MenuButtonsConfig = Static<typeof MenuButtonsConfigSchema>;
export const DebuggingConfigSchema = Type.Object({
showScriptFinishedMessage: Type.Optional(Type.Boolean()),
});
export type DebuggingConfig = Static<typeof DebuggingConfigSchema>;
export const SavesConfigSchema = Type.Object({
mode: Type.String(),
slots: Type.Number(),
runOnReload: Type.Optional(Type.String()),
disabled: Type.Optional(Type.Boolean()),
autosaveDisabledOnLabels: Type.Optional(Type.Array(Type.String())),
autosaveFeedback: Type.Optional(
Type.Object({
enabled: Type.Boolean(),
text: Type.Optional(Type.String()),
backgroundImage: Type.Optional(Type.String()),
foregroundImage: Type.Optional(Type.String()),
duration: Type.Number(),
}),
),
allowManualSave: Type.Optional(Type.Boolean()),
});
export type SavesConfig = Static<typeof SavesConfigSchema>;
export const GraphicsSettingsSchema = Type.Object({
allowFullscreen: Type.Optional(Type.Boolean()),
});
export type GraphicsSettings = Static<typeof GraphicsSettingsSchema>;
export const ScriptsConfigSchema = Type.Array(Type.String());
export type ScriptsConfig = Static<typeof ScriptsConfigSchema>;
export const defaultScriptsConfig = [];
export const ScenesConfigSchema = Type.Object({
startMenuScene: Type.Optional(Type.String()),
gameScene: Type.Optional(Type.String()),
gameSplashScene: Type.Optional(Type.String()),
});
export type ScenesConfig = Static<typeof ScenesConfigSchema>;
export const InputConfigSchema = Type.Object({
showPromptsOnKeyboard: Type.Optional(Type.Boolean()),
showPromptsOnGamepad: Type.Optional(Type.Boolean()),
showBottomLegend: Type.Optional(Type.Boolean()),
});
export type InputConfig = Static<typeof InputConfigSchema>;
export const CommonConfigInputSchema = Type.Object({
baseAssetsPath: Type.Optional(Type.String()),
baseDataPath: Type.Optional(Type.String()),
gameTitle: Type.String(),
saveFileName: Type.String(),
images: Type.Optional(Type.Record(Type.String(), Type.String())),
layout: LayoutConfigSchema,
settings: Type.Optional(SettingsConfigSchema),
graphics: Type.Optional(GraphicsSettingsSchema),
gameFlow: Type.Optional(
Type.Object({
labelToJumpOnScriptEnd: Type.Optional(Type.String()),
}),
),
dialogPanel: Type.Optional(DialogPanelConfigSchema),
splashScreens: Type.Optional(SplashScreenConfigSchema),
notifications: Type.Optional(NotificationsConfigSchema),
hudStats: HudStatsConfigSchema,
interactionTags: Type.Optional(InteractionTagsConfigSchema),
transitions: Type.Optional(TransitionsConfigSchema),
menuButtons: Type.Optional(MenuButtonsConfigSchema),
debugging: Type.Optional(DebuggingConfigSchema),
saves: Type.Optional(SavesConfigSchema),
input: Type.Optional(InputConfigSchema),
hotkeys: HotkeysConfigSchema,
scenes: Type.Optional(ScenesConfigSchema),
});
export type CommonConfigInput = Static<typeof CommonConfigInputSchema>;
export interface CommonConfig {
baseAssetsPath: string;
baseDataPath: string;
gameTitle: string;
saveFileName: string;
images: {
[key: string]: string;
};
layout: LayoutConfig;
settings: SettingsConfig;
graphics: GraphicsSettings;
gameFlow: {
labelToJumpOnScriptEnd?: string;
};
dialogPanel: DialogPanelConfig;
splashScreens: SplashScreenConfig;
notifications: NotificationsConfig;
hudStats: HudStatsConfig;
interactionTags: InteractionTagsConfig;
transitions: TransitionsConfig;
menuButtons: MenuButtonsConfig;
debugging: DebuggingConfig;
saves: SavesConfig;
input: InputConfig;
hotkeys: HotkeysConfig;
scenes: ScenesConfig;
}
export const defaultCommonConfig: CommonConfig = {
baseAssetsPath: '',
baseDataPath: '',
gameTitle: 'Narrat Game',
saveFileName: 'narrat save',
images: {},
layout: defaultLayoutConfig,
settings: {},
graphics: {},
gameFlow: {},
dialogPanel: {
overlayMode: true,
rightOffset: 100,
bottomOffset: 50,
width: 475,
height: 680,
textSpeed: DEFAULT_TEXT_SPEED,
animateText: true,
timeBetweenLines: 100,
hideDuringTransition: false,
showAfterScriptEnd: false,
},
splashScreens: {},
notifications: {
timeOnScreen: 2.5,
alsoPrintInDialogue: false,
},
hudStats: {},
interactionTags: {
default: {
onlyInteractOutsideOfScripts: true,
},
},
transitions: {},
menuButtons: {},
debugging: {
showScriptFinishedMessage: false,
},
saves: {
mode: 'manual',
slots: 10,
},
input: {
showPromptsOnKeyboard: true,
showPromptsOnGamepad: true,
showBottomLegend: true,
},
hotkeys: {},
scenes: {},
};