Files
Nitro-V3/docs/local-development-setup.md
T
2026-05-06 06:27:40 +02:00

280 lines
6.4 KiB
Markdown

# Setup locale con `yarn start`
Questa guida serve per avviare Nitro in locale con Vite, usando:
- UI locale su `http://localhost:5173`;
- API/emulatore locale su `http://localhost:2096`;
- WebSocket locale su `ws://localhost:2096`;
- asset e gamedata remoti plain, così non devi copiare tutta la cartella `client/nitro`.
## 1. Avvia l'emulatore
Nel repo `Arcturus-Morningstar-Extended/Emulator`, avvia l'emulatore con WebSocket attivo.
Nel tuo `config.ini` locale usa valori tipo:
```ini
ws.enabled=true
ws.host=0.0.0.0
ws.port=2096
ws.whitelist=*
ws.ip.header=
crypto.ws.enabled=0
nitro.secure.assets.enabled=false
nitro.secure.api.enabled=false
```
Per il locale è meglio tenere spenti:
- `crypto.ws.enabled`;
- `nitro.secure.assets.enabled`;
- `nitro.secure.api.enabled`.
Così puoi debuggare senza layer secure in mezzo.
## 2. `public/configuration/client-mode.json`
File:
```txt
Nitro-V3/public/configuration/client-mode.json
```
Config locale consigliato:
```json
{
"distObfuscationEnabled": true,
"secureAssetsEnabled": false,
"secureApiEnabled": false,
"apiBaseUrl": "http://localhost:2096",
"plainConfigBaseUrl": "http://localhost:5173/configuration/",
"plainGamedataBaseUrl": "https://hotel.example.com/client/nitro/gamedata/"
}
```
Note:
- `secureAssetsEnabled=false` evita `/nitro-sec/file`.
- `secureApiEnabled=false` evita cifratura `/api/*`.
- `apiBaseUrl` deve puntare all'emulatore locale.
- `plainGamedataBaseUrl` può rimanere remoto se non hai gamedata copiato in locale.
Se vuoi tutto locale, usa:
```json
"plainGamedataBaseUrl": "http://localhost:5173/client/nitro/gamedata/"
```
ma devi avere davvero i file sotto:
```txt
Nitro-V3/public/client/nitro/gamedata/
```
## 3. `public/configuration/renderer-config.json`
File:
```txt
Nitro-V3/public/configuration/renderer-config.json
```
Valori minimi locali:
```json
{
"socket.url": "ws://localhost:2096",
"api.url": "http://localhost:2096",
"crypto.ws.enabled": false,
"gamedata.url": "https://hotel.example.com/client/nitro/gamedata",
"external.texts.url": [
"${gamedata.url}/ExternalTexts.json",
"${gamedata.url}/UITexts.json"
],
"furnidata.url": "${gamedata.url}/FurnitureData.json?t=%timestamp%",
"productdata.url": "${gamedata.url}/ProductData.json?t=%timestamp%",
"avatar.actions.url": "${gamedata.url}/HabboAvatarActions.json?t=%timestamp%",
"avatar.figuredata.url": "${gamedata.url}/FigureData.json?t=%timestamp%",
"avatar.figuremap.url": "${gamedata.url}/FigureMap.json?t=%timestamp%",
"avatar.effectmap.url": "${gamedata.url}/EffectMap.json?t=%timestamp%",
"login.endpoint": "${api.url}/api/auth/login",
"login.register.endpoint": "${api.url}/api/auth/register",
"login.forgot.endpoint": "${api.url}/api/auth/forgot-password",
"login.logout.endpoint": "${api.url}/api/auth/logout",
"login.remember.endpoint": "${api.url}/api/auth/remember",
"login.health.endpoint": "${api.url}/api/health",
"login.health.method": "GET",
"login.check-email.endpoint": "${api.url}/api/auth/check-email",
"login.check-username.endpoint": "${api.url}/api/auth/check-username",
"login.register.imaging.url": "${api.url}/api/avatar/imaging",
"login.news.url": "${api.url}/api/auth/news",
"badges.custom.list.endpoint": "${api.url}/api/badges/custom",
"badges.custom.create.endpoint": "${api.url}/api/badges/custom",
"badges.custom.update.endpoint": "${api.url}/api/badges/custom/%badgeId%",
"badges.custom.delete.endpoint": "${api.url}/api/badges/custom/%badgeId%",
"badges.custom.texts.endpoint": "${api.url}/api/badges/custom/texts"
}
```
Importante:
- Non usare `https://localhost:2096/nitro-sec/file` in locale se `secureAssetsEnabled=false`.
- Non usare `ws://192.168.x.x/:2096`: è malformato. Usa `ws://localhost:2096` oppure `ws://192.168.x.x:2096`.
## 4. `public/configuration/ui-config.json`
File:
```txt
Nitro-V3/public/configuration/ui-config.json
```
Per la login view puoi usare immagini remote plain:
```json
{
"loginview": {
"images": {
"background": "https://hotel.example.com/client/nitro/images/reception/background_gradient_apr25.png",
"background.colour": "#6eadc8",
"drape": "https://hotel.example.com/client/nitro/images/reception/drape.png",
"left": "https://hotel.example.com/client/nitro/images/reception/mute_reception_backdrop_left.png",
"right": "https://hotel.example.com/client/nitro/images/reception/background_right.png"
}
}
}
```
Se vedi `ERR_NAME_NOT_RESOLVED`, il dominio configurato non esiste o non è raggiungibile.
## 5. News dal database
Le news della login devono arrivare dal database tramite l'emulatore.
Nel renderer config usa:
```json
"login.news.url": "${api.url}/api/auth/news"
```
L'emulatore legge dalla tabella:
```txt
ui_news
```
SQL di riferimento:
```txt
Arcturus-Morningstar-Extended/Database Updates/013_UI_Client_News.sql
```
Colonne principali:
- `title`
- `body`
- `image`
- `link_text`
- `link_url`
- `enabled`
- `sort_order`
`public/configuration/news.json` può rimanere solo come mock/fallback, ma non è il flow corretto.
## 6. Avvio Nitro
Nel repo `Nitro-V3`:
```bash
yarn start
```
Apri:
```txt
http://localhost:5173
```
Consiglio: usa `localhost`, non `192.168.x.x`, perché cookie e sessioni API possono cambiare host e causare `401 Unauthorized`.
## 7. Errori comuni
### `Unable to load renderer-config.json`
Controlla:
```txt
public/configuration/client-mode.json
```
Deve avere:
```json
"secureAssetsEnabled": false
```
### `Invalid JSON ... Unexpected token '<'`
Vuol dire che il client ha chiesto un JSON, ma Vite ha risposto HTML.
Succede quando un URL punta a un file che non esiste, per esempio:
```txt
http://localhost:5173/client/nitro/gamedata/ExternalTexts.json
```
Soluzione:
- usa gamedata remoto plain;
- oppure copia davvero i gamedata in `public/client/nitro/gamedata`.
### WebSocket `1006`
Controlla:
```json
"socket.url": "ws://localhost:2096"
```
e nel config emulator:
```ini
ws.enabled=true
ws.port=2096
```
### Custom badges `401 Unauthorized`
È normale se non sei loggato o se apri Nitro da un host diverso.
Usa:
```txt
http://localhost:5173
```
e API:
```txt
http://localhost:2096
```
## 8. Differenza con produzione
Locale con `yarn start`:
```html
<script type="module" src="/src/bootstrap.ts"></script>
```
Produzione buildata:
```html
<script src="/configuration/bootstrap.js"></script>
```
Non mischiare i due flow.