Lordmau5/esa-nodecg
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add new currency options in the config

Browse Source 
Defaults to `$` and `en-US` for the currency symbol and country code respectively
This commit is contained in:
Lordmau5 2024-03-14 09:03:39 +01:00
parent f6837d1435
commit e5c993d5dc
4 changed files with 206 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
configschema.json
View File

@ -94,6 +94,22 @@
"fallbackTwitchTitle": { "fallbackTwitchTitle": {
"$comment": "Set the fallback Twitch title for this event; {{total}} and {{run}} can be used as placeholders (see source code).", "$comment": "Set the fallback Twitch title for this event; {{total}} and {{run}} can be used as placeholders (see source code).",
"type": "string" "type": "string"
},
"currency": {
"$comment": "Overrides for the currency symbol and country code used in various graphics",
"additionalProperties": false,
"properties": {
"symbol": {
"$comment": "The currency symbol (defaults to $)",
"type": "string",
"default": "$"
},
"countryCode": {
"$comment": "The country code (defaults to en-US)",
"type": "string",
"default": "en-US"
}
}
} }
}, },
"required": [ "required": [
@ -356,7 +372,7 @@
] ]
}, },
"groups": { "groups": {
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"gameCaptures": { "gameCaptures": {
@ -745,4 +761,4 @@
"streamlabsCharity", "streamlabsCharity",
"therungg" "therungg"
] ]
} }

61
package-lock.json generated
View File

@ -60,6 +60,7 @@
"globby": "^12.2.0", "globby": "^12.2.0",
"gsap": "^3.12.5", "gsap": "^3.12.5",
"html-webpack-plugin": "^5.6.0", "html-webpack-plugin": "^5.6.0",
"json-schema-to-typescript": "^13.1.2",
"mini-css-extract-plugin": "^2.7.7", "mini-css-extract-plugin": "^2.7.7",
"nodecg-cli": "^8.6.8", "nodecg-cli": "^8.6.8",
"npm-run-all": "^4.1.5", "npm-run-all": "^4.1.5",
@ -303,15 +304,21 @@
} }
}, },
"node_modules/@bcherny/json-schema-ref-parser": { "node_modules/@bcherny/json-schema-ref-parser": {
"version": "9.0.9", "version": "10.0.5-fork",
"resolved": "https://registry.npmjs.org/@bcherny/json-schema-ref-parser/-/json-schema-ref-parser-9.0.9.tgz", "resolved": "https://registry.npmjs.org/@bcherny/json-schema-ref-parser/-/json-schema-ref-parser-10.0.5-fork.tgz",
"integrity": "sha512-vmEmnJCfpkLdas++9OYg6riIezTYqTHpqUTODJzHLzs5UnXujbOJW9VwcVCnyo1mVRt32FRr23iXBx/sX8YbeQ==", "integrity": "sha512-E/jKbPoca1tfUPj3iSbitDZTGnq6FUFjkH6L8U2oDwSuwK1WhnnVtCG7oFOTg/DDnyoXbQYUiUiGOibHqaGVnw==",
"dev": true, "dev": true,
"dependencies": { "dependencies": {
"@jsdevtools/ono": "^7.1.3", "@jsdevtools/ono": "^7.1.3",
"@types/json-schema": "^7.0.6", "@types/json-schema": "^7.0.6",
"call-me-maybe": "^1.0.1", "call-me-maybe": "^1.0.1",
"js-yaml": "^4.1.0" "js-yaml": "^4.1.0"
},
"engines": {
"node": ">= 16"
},
"funding": {
"url": "https://github.com/sponsors/philsturgeon"
} }
}, },
"node_modules/@colors/colors": { "node_modules/@colors/colors": {
@ -6002,12 +6009,12 @@
} }
}, },
"node_modules/json-schema-to-typescript": { "node_modules/json-schema-to-typescript": {
"version": "11.0.3", "version": "13.1.2",
"resolved": "https://registry.npmjs.org/json-schema-to-typescript/-/json-schema-to-typescript-11.0.3.tgz", "resolved": "https://registry.npmjs.org/json-schema-to-typescript/-/json-schema-to-typescript-13.1.2.tgz",
"integrity": "sha512-EaEE9Y4VZ8b9jW5zce5a9L3+p4C9AqgIRHbNVDJahfMnoKzcd4sDb98BLxLdQhJEuRAXyKLg4H66NKm80W8ilg==", "integrity": "sha512-17G+mjx4nunvOpkPvcz7fdwUwYCEwyH8vR3Ym3rFiQ8uzAL3go+c1306Kk7iGRk8HuXBXqy+JJJmpYl0cvOllw==",
"dev": true, "dev": true,
"dependencies": { "dependencies": {
"@bcherny/json-schema-ref-parser": "9.0.9", "@bcherny/json-schema-ref-parser": "10.0.5-fork",
"@types/json-schema": "^7.0.11", "@types/json-schema": "^7.0.11",
"@types/lodash": "^4.14.182", "@types/lodash": "^4.14.182",
"@types/prettier": "^2.6.1", "@types/prettier": "^2.6.1",
@ -6799,6 +6806,18 @@
"node": ">=8" "node": ">=8"
} }
}, },
"node_modules/nodecg-cli/node_modules/@bcherny/json-schema-ref-parser": {
"version": "9.0.9",
"resolved": "https://registry.npmjs.org/@bcherny/json-schema-ref-parser/-/json-schema-ref-parser-9.0.9.tgz",
"integrity": "sha512-vmEmnJCfpkLdas++9OYg6riIezTYqTHpqUTODJzHLzs5UnXujbOJW9VwcVCnyo1mVRt32FRr23iXBx/sX8YbeQ==",
"dev": true,
"dependencies": {
"@jsdevtools/ono": "^7.1.3",
"@types/json-schema": "^7.0.6",
"call-me-maybe": "^1.0.1",
"js-yaml": "^4.1.0"
}
},
"node_modules/nodecg-cli/node_modules/chalk": { "node_modules/nodecg-cli/node_modules/chalk": {
"version": "3.0.0", "version": "3.0.0",
"resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz",
@ -6835,6 +6854,34 @@
"node": ">=6 <7 || >=8" "node": ">=6 <7 || >=8"
} }
}, },
"node_modules/nodecg-cli/node_modules/json-schema-to-typescript": {
"version": "11.0.3",
"resolved": "https://registry.npmjs.org/json-schema-to-typescript/-/json-schema-to-typescript-11.0.3.tgz",
"integrity": "sha512-EaEE9Y4VZ8b9jW5zce5a9L3+p4C9AqgIRHbNVDJahfMnoKzcd4sDb98BLxLdQhJEuRAXyKLg4H66NKm80W8ilg==",
"dev": true,
"dependencies": {
"@bcherny/json-schema-ref-parser": "9.0.9",
"@types/json-schema": "^7.0.11",
"@types/lodash": "^4.14.182",
"@types/prettier": "^2.6.1",
"cli-color": "^2.0.2",
"get-stdin": "^8.0.0",
"glob": "^7.1.6",
"glob-promise": "^4.2.2",
"is-glob": "^4.0.3",
"lodash": "^4.17.21",
"minimist": "^1.2.6",
"mkdirp": "^1.0.4",
"mz": "^2.7.0",
"prettier": "^2.6.2"
},
"bin": {
"json2ts": "dist/src/cli.js"
},
"engines": {
"node": ">=12.0.0"
}
},
"node_modules/nodecg-cli/node_modules/jsonfile": { "node_modules/nodecg-cli/node_modules/jsonfile": {
"version": "4.0.0", "version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",

6
package.json
View File

@ -28,7 +28,8 @@
"watch": "run-p watch:*", "watch": "run-p watch:*",
"watch:browser": "webpack -w", "watch:browser": "webpack -w",
"watch:extension": "tsc -b tsconfig.extension.json -w", "watch:extension": "tsc -b tsconfig.extension.json -w",
"postinstall": "cd shared && node postinstall.js" "postinstall": "cd shared && node postinstall.js",
"configschema": "json2ts --input configschema.json --output src/types/schemas/configschema.d.ts"
}, },
"dependencies": { "dependencies": {
"@esamarathon/mq-events": "^1.0.1", "@esamarathon/mq-events": "^1.0.1",
@ -81,6 +82,7 @@
"globby": "^12.2.0", "globby": "^12.2.0",
"gsap": "^3.12.5", "gsap": "^3.12.5",
"html-webpack-plugin": "^5.6.0", "html-webpack-plugin": "^5.6.0",
"json-schema-to-typescript": "^13.1.2",
"mini-css-extract-plugin": "^2.7.7", "mini-css-extract-plugin": "^2.7.7",
"nodecg-cli": "^8.6.8", "nodecg-cli": "^8.6.8",
"npm-run-all": "^4.1.5", "npm-run-all": "^4.1.5",
@ -381,4 +383,4 @@
} }
] ]
} }
} }

256
src/types/schemas/configschema.d.ts vendored
View File

@ -6,132 +6,136 @@
*/ */
export interface Configschema { export interface Configschema {
useTestData: boolean; useTestData: boolean;
event: { event: {
theme?: string; theme?: string;
shorts: string | [string] | [string, string]; shorts: string | [string] | [string, string];
thisEvent: number; thisEvent: number;
online: boolean | ('partial' | 'full'); online: boolean | ("partial" | "full");
fallbackTwitchTitle?: string; fallbackTwitchTitle?: string;
}; currency?: {
omnibar: { symbol?: string;
miniCredits: { countryCode?: string;
header: string; };
screeners?: string; };
tech?: string; omnibar: {
}; miniCredits: {
}; header: string;
streamdeck: { screeners?: string;
enabled: boolean; tech?: string;
port: number; };
key: string; };
debug: boolean; streamdeck: {
}; enabled: boolean;
rabbitmq: { port: number;
enabled: boolean; key: string;
protocol: string; debug: boolean;
hostname: string; };
username: string; rabbitmq: {
password: string; enabled: boolean;
vhost: string; protocol: string;
queuePrepend?: string; hostname: string;
}; username: string;
obs: { password: string;
enabled: boolean; vhost: string;
address: string; queuePrepend?: string;
password: string; };
canvasResolution: { obs: {
width: number; enabled: boolean;
height: number; address: string;
}; password: string;
names: { canvasResolution: {
scenes: { width: number;
commercials: string; height: number;
gameLayout: string; };
readerIntroduction: string; names: {
intermission: string; scenes: {
intermissionPlayer: string; commercials: string;
countdown: string; gameLayout: string;
}; readerIntroduction: string;
sources: { intermission: string;
gameSources: string | [string, ...string[]]; intermissionPlayer: string;
cameraSources: string | [string, ...string[]]; countdown: string;
cameraSourceCrowd?: string | null; };
twitchSources: string | [string] | [string, string]; sources: {
videoPlayer: string; gameSources: string | [string, ...string[]];
donationSound: string; cameraSources: string | [string, ...string[]];
}; cameraSourceCrowd?: string | null;
groups: { twitchSources: string | [string] | [string, string];
gameCaptures: string | [string, ...string[]]; videoPlayer: string;
cameraCaptures: string | [string, ...string[]]; donationSound: string;
}; };
}; groups: {
}; gameCaptures: string | [string, ...string[]];
music: { cameraCaptures: string | [string, ...string[]];
enabled: boolean; };
address: string; };
username: string; };
password: string; music: {
}; enabled: boolean;
x32: { address: string;
enabled: boolean; username: string;
ip: string; password: string;
localPort: number; };
xr18: boolean; x32: {
}; enabled: boolean;
xkeys: { ip: string;
enabled: boolean; localPort: number;
}; xr18: boolean;
tracker: { };
enabled: boolean; xkeys: {
address: string; enabled: boolean;
username: string; };
password: string; tracker: {
prizesUrl: string; enabled: boolean;
commentaryBias: BidwarBias; address: string;
otherBidwarBias: BidwarBias; username: string;
donationTotalInTitle: boolean; password: string;
}; prizesUrl: string;
tts: { commentaryBias: BidwarBias;
enabled: boolean; otherBidwarBias: BidwarBias;
voiceAPI: string; donationTotalInTitle: boolean;
key: string; };
}; tts: {
flagcarrier: { enabled: boolean;
enabled: boolean; voiceAPI: string;
allowedDevices?: string | [string, ...string[]] | null; key: string;
group: string; };
availableButtons: { flagcarrier: {
id: string; enabled: boolean;
name: string; allowedDevices?: string | [string, ...string[]] | null;
}[]; group: string;
}; availableButtons: {
offsite: { id: string;
enabled: boolean; name: string;
address: string; }[];
key: string; };
}; offsite: {
server: { enabled: boolean;
enabled: boolean; address: string;
address: string; key: string;
key: string; };
}; server: {
discord: { enabled: boolean;
enabled: boolean; address: string;
token: string; key: string;
textChannelId: string; };
}; discord: {
streamlabsCharity: { enabled: boolean;
enabled: boolean; token: string;
apiUrl: string; textChannelId: string;
}; };
therungg: { streamlabsCharity: {
enabled: boolean; enabled: boolean;
}; apiUrl: string;
};
therungg: {
enabled: boolean;
};
} }
export interface BidwarBias { export interface BidwarBias {
bidId: number; bidId: number;
option1Id: number; option1Id: number;
option2Id: number; option2Id: number;
optionTitle: string; optionTitle: string;
} }