-
Notifications
You must be signed in to change notification settings - Fork 0
/
PackageJsonStructure.ts
45 lines (38 loc) · 1.06 KB
/
PackageJsonStructure.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
/**
* Interface describing set of fields, which are expected in game plugin package.json
*/
export interface PackageJsonStructure {
/**
* Name of the game
*/
name : string;
/**
* Version of plugin
*/
version: string;
/**
* Description of the game
*/
description: string;
/**
* Array of supported languages
*/
languages : string[];
/**
* How many concurrent players can be in the game session.
* 1 = for solo game,
* (1, unlim) = for limitings number of game players
* Default value (`undefined`) means unlimited count.
*/
maxPlayers ?: number;
/**
* Path main game plugin's entry point file with class name after hash.
* @example ./app/app.js#GameClass
* @example ./app/app.js - default export will be used, if class name is not specified.
*/
textGameEntryPoint: string;
/**
* If true, any joining user will automatically receive private channel or thread for communication with game.
*/
autoCreateUserChannels : boolean;
}