Välj hur användarmenyn ska öppnas

I EarnFX kan du anpassa hur spelarna öppnar användarmenyn, exempelvis genom en specifik knapp, ett kommando, eller automatiskt vid särskilda händelser. Följ denna guide för att konfigurera detta.

1. Öppna inställningsfilen

Navigera till mappen EarnFX_Master i din servers resources-mapp.
Öppna filen settings.json med en textredigerare, exempelvis Notepad++ eller Visual Studio Code.

2. Förstå inställningarna i "Actions"

Sektionen "Actions" i settings.json innehåller olika sätt att trigga användarmenyn. Här är några vanliga typer av åtgärder

• in-game-button: Öppna menyn med en knapptryckning.
• on-server-event: Öppna menyn som svar på en serverhändelse.
• on-client-event: Öppna menyn som svar på en klienthändelse.
• on-player-entered: Öppna menyn automatiskt när en spelare går in i spelet.

Exempel på en befintlig konfiguration i "Actions":

"Actions": [
    {
        "type": "in-game-button",
        "keybind": "F9",
        "notification": {
            "type": "default",
            "eventname": "",
            "eventargs": []
        }
    }
]

3. Lägg till eller ändra åtgärder

A. Öppna med en knapptryckning

Skapa en ny åtgärd med type: "in-game-button".
Ange en knapp (t.ex. F9, F10, eller en annan tangent som inte används av andra funktioner).

Exempel:

{
    "type": "in-game-button",
    "keybind": "F10",
    "notification": {
        "type": "default",
        "eventname": "",
        "eventargs": []
    }
}

B. Öppna med en serverhändelse

Skapa en åtgärd med type: "on-server-event".
Ange namnet på den serverhändelse som ska trigga menyn.

Exempel:

{
    "type": "on-server-event",
    "eventname": "custom:server:openMenu"
}

C. Öppna med en klienthändelse

Skapa en åtgärd med type: "on-client-event".
Ange namnet på den klienthändelse som ska trigga menyn.

Exempel:

{
    "type": "on-client-event",
    "eventname": "custom:client:showMenu"
}

D. Öppna automatiskt när en spelare ansluter

Skapa en åtgärd med type: "on-player-entered".
Ingen ytterligare konfiguration krävs.
Exempel:

{
    "type": "on-player-entered"
}

4. Kombinera flera metoder

Du kan lägga till flera åtgärder för att ge spelarna fler sätt att öppna menyn.

Exempel:

"Actions": [
    {
        "type": "in-game-button",
        "keybind": "F9"
    },
    {
        "type": "on-client-event",
        "eventname": "custom:client:showMenu"
    },
    {
        "type": "on-player-entered"
    }
]

5. Spara och testa

• Spara ändringarna i settings.json.
• Starta om servern och resursen EarnFX.
• Testa att menyn öppnas på de sätt du har konfigurerat.

Tips för en smidig upplevelse

• Undvik konflikt med andra funktioner: Kontrollera att den valda knappen eller händelsen inte används av andra resurser på din server.
• Kommunicera tydligt med spelarna: Informera spelarna om hur de kan öppna menyn, exempelvis i välkomstmeddelanden eller Discord-kanaler.

Förstå notification-fältet i inställningarna

Fältet notification används för att styra vilken typ av meddelande som skickas när en spelare får tillgång till menyn.

1. Notifikationstyper

Det finns två typer av notifikationer:

• default: Visar ett standardmeddelande på skärmen med GTA:s vanliga stil, som exempelvis ovanför kartan.
• custom: Triggar en specifik server- eller klienthändelse och kan skicka med data i form av ett händelsenamn och argument.

2. Konfigurationsexempel

A. Default (standardmeddelande)

Använd denna typ för att informera spelaren om vilken knapp som används för att öppna menyn.

Exempel:

{
    "type": "in-game-button",
    "keybind": "F9",
    "notification": {
        "type": "default",
        "eventname": "",
        "eventargs": []
    }
}

Vad händer?

När spelaren går med i servern eller resursen startas, visas ett meddelande som:
"Tryck på F9 för att öppna menyn."

B. Custom (händelsebaserad notifikation)

Använd denna typ för att trigga ett server- eller klientevent istället för att visa ett meddelande.

Exempel:

{
    "type": "in-game-button",
    "keybind": "F9",
    "notification": {
        "type": "custom",
        "eventname": "custom:client:notify",
        "eventargs": ["EarnFX är aktivt!", 5000]
    }
}

Vad händer?

När spelaren går med i servern eller resursen startas, triggas eventet custom:client:notify med argumenten:
"EarnFX är aktivt!" (meddelandet).
5000 (tid i millisekunder för visning).
Servern eller klienten hanterar eventet och kan visa ett anpassat meddelande eller utföra andra åtgärder.

3. Ta bort notifikationen

Om du vill att ingen notis ska skickas, tar du bort hela notification-fältet från åtgärdsinställningen.

Exempel utan notis:

{
    "type": "in-game-button",
    "keybind": "F9"
}

Vad händer?
Ingen notis visas eller skickas, men knappen (eller händelsen) öppnar fortfarande menyn.

När ska man använda vilken typ?

default:

När du vill informera spelarna med en enkel och tydlig notis, t.ex. för att visa vilken knapp de ska trycka på.

custom:

När du vill integrera en mer avancerad funktionalitet, som att trigga ett specifikt event eller skicka data vidare.

Ingen notifikation:

När du inte vill att spelarna ska få en visuell eller händelsebaserad notis alls