mirror of
https://github.com/Pandipipas/scoreko-dev.git
synced 2026-06-06 03:32:06 +00:00
Pandipipas
71 lines
1.4 KiB
Markdown
71 lines
1.4 KiB
Markdown
# scoreko-dev
|
|
|
|
NodeCG bundle for producing fighting game overlays.
|
|
|
|
## Project
|
|
|
|
- Repository: https://github.com/Pandipipas/scoreko-dev
|
|
- Stack: NodeCG, Vue 3, TypeScript, Quasar, and Vite.
|
|
|
|
## Requirements
|
|
|
|
- Node.js 24.14.0+
|
|
|
|
## Scripts
|
|
|
|
- `npm run autofix`: automatically fixes lint errors.
|
|
- `npm run build`: builds dashboard/graphics and extension.
|
|
- `npm run lint`: validates project linting.
|
|
- `npm run schema-types`: generates types from schemas.
|
|
- `npm run start`: starts NodeCG using the local dependency (`nodecg start`).
|
|
- `npm run watch`: development mode with watch.
|
|
|
|
## Usage
|
|
|
|
- `npm install`
|
|
- `npm run build`
|
|
- `npm run start` (equivalent to `npx nodecg start`)
|
|
|
|
## Version
|
|
|
|
Initial project version: `0.1.0`.
|
|
|
|
## Assets por HTTP (sin GitHub API)
|
|
|
|
La descarga de assets usa **únicamente HTTP**. Debes configurar un servidor propio.
|
|
|
|
1. En `cfg/scoreko-dev.json`, configura `assetsBaseUrl` (opcional, por defecto `http://localhost`):
|
|
|
|
```json
|
|
{
|
|
"scoreko-dev": {
|
|
"assetsBaseUrl": "http://localhost"
|
|
}
|
|
}
|
|
```
|
|
|
|
2. Sirve por HTTP esta estructura:
|
|
|
|
```text
|
|
games/
|
|
street-fighter-6/
|
|
manifest.json
|
|
fighting-characters.json
|
|
characters/...
|
|
tekken-8/
|
|
manifest.json
|
|
...
|
|
```
|
|
|
|
3. Cada `manifest.json` debe ser un array con rutas relativas, o con objetos `{ "path", "size", "url" }`.
|
|
|
|
Ejemplo mínimo:
|
|
|
|
```json
|
|
[
|
|
"fighting-characters.json",
|
|
"characters/ryu.png"
|
|
]
|
|
```
|
|
|