GTSSweBot i korthet

Allmänt om kommandon

Detta dokument avser att i korta drag beskriva hur man, som förare, använder boten. Då boten styrs av kommandon via PSN, webben eller Discord så måste man lära sig hur dessa kommandon fungerar. Man ska vara noga med att stavningen av kommandona är korrekt, annars kommer boten inte att förstå vad man menar.

Kommando anges på följande sätt:

!kommando <parameter>

Utropstecknet måste alltid vara det första på raden, och det är inte något mellanslag mellan utropstecknet och kommandot. Parametern kan vara exempelvis ett nummer eller text beroende på kommandot. Man ska INTE skriva med < och > när man anger parametern. Ett kommando kan också ha ett "subkommando" och/eller flera parametrar beroende på funktion (för förare är detta inte vanligt förekommande). Då kan det se ut ungefär så här:

!kommando subkommando <parameter> : <parameter> <parameter>

Här är det noga med att man med vissa kommandon MÅSTE ange ett kolon mellan vissa parametrar. Detta för att underlätta för boten att särskilja olika parametrar.

En mer ingående manual för boten och för de som vill skapa ett eget team eller driva en egen serie finns på http://granturismosport.se/bot/help/

Registrera dig med boten

Detta är bara för att boten ska kunna skapa din användarprofil i databasen och känna igen den för framtida kommandon. Behöver bara göras en gång:

!hello

Bara detta kommando, inga parametrar; ett utropstecken och ordet "hello". Inga mellanslag nånstans.

OBS! I vissa fall kanske det inte fungerar att använda boten beroende på vilka inställningar man har på sitt PSN-konto. I första hand är det att man valt att inte ta emot meddelanden från användare man inte är vän med. Har man den inställningen så kan man således inte ta emot svaren från boten, även om det vad boten anbelangar fungerar precis likadant oavsett. Det man kan göra då är att be boten skicka en vänförfrågan (tvärtom funkar inte eftersom boten inte kan bekräfta vänförfrågan), vilket man gör med kommandot:

!hello friend

Sen måste man naturligtvis acceptera vänförfrågan från boten, och när man är vän med boten kör man kommandot !hello igen (om man inte redan gjort det, och bara inte kunnat ta emot botens svar).

Startnummer

Man kan om man vill välja sitt startnummer med boten. Detta för att inte två förare ska köra med samma startnummer på bilen (med ömsesidig respekt för andra förare och serierna så hoppas vi att alla väljer ett nummer och kör med det). Man kan inte välja startnummer 1-3 då de är reserverade för speciella ändamål.

Ett startnummer är inte "för evigt" (vissa undantag gäller). Om föraren som har ett visst nummer inte anmält sig till en serie eller race på 6 månader så anser boten att det startnumret är tillgängligt. Dock är det bara om någon aktivt väljer det startnumret (se "Välja startnummer") som det frigörs.

Välja startnummer

Ett enkelt kommando med ett enda argument; numret du önskar köra med:

!number <startnummer>

Numret kan vara upptaget redan, då får man välja ett annat nummer. Det startnummer man önskar är den enda parameter detta kommando accepterar. Endast siffror accepteras.

Exempel:

!number 42

Detta försöker sätta ditt startnummer till #42.

Visa alla startnummer

Vill man kontrollera vilka startnummer som är tagna så kan man göra det med:

!number list

Här är det ett mellanslag mellan !number och list. Kommandot listar alla tagna nummer och vem som har respektive startnummer. Är startnumret inte med på denna lista så är det ledigt.

Visa eget startnummer

Vill man bara se sitt eget startnummer så kör man bara kommandot:

!number

Boten svarar då med vilket startnummer (om du har valt ett) du har valt.

Frigöra sitt startnummer

Om man av någon anledning vill frigöra sitt startnummer så att någon annan kan använda det så gör man det med följande kommando:

!number remove

Här är det ett mellanslag mellan !number och remove. Efter detta kommando körts så har du inte längre något startnummer angivet.

Team

I boten finns stöd för team. Team kan ha i princip hur många förare som helst, men man kan inte automatiskt gå med i ett team. Den biten får skötas "manuellt" genom att ta kontakt med teamchefen eller någon av teamets admins. Man kan köra för olika team i olika klasser, men för varje klass kan man bara vara med i ett enda team.

Visa alla team

För att se vilka team som finns kör man kommandot:

!team

Som helt enkelt listar alla team (inklusive deras id-nummer och vem som är teamchef).

Visa enskilt team

Vill man få mer information om ett specifikt team så kan man använda kommandot:

!team <teamets id/namn>

Som returnerar mer information om teamet med angivet id eller namn.

Exempel:

!team 22
!team Team Orange

Första exemplet returnerar mer information om teamet med id 22. Det andra exemplet försöker returnera information om ett team som heter "Team Orange".

Lämna ett team

Om man vill lämna ett team man är förare för så kan man göra det med kommandot:

!team resign <teamets id/namn>

I detta fall är <id/namn> antingen teamets id-nummer (se "Visa alla team") eller teamets namn. Använder man teamets namn så måste det anges exakt (stora eller små bokstäver spelar ingen roll).

Exempel:

!team resign Fastest Team Ever
!team resign 16 : Gr.2

Det första exemplet gör att boten försöker plocka bort dig som förare från ALLA klasser för teamet med namnet "Fastest Team Ever". Det andra exemplet försöker plocka bort dig som förare från Gr.2 i teamet med id-nummer 16 (se "Visa alla team" för mer information).

Serier

Boten bygger på att race körs i serier, det vill säga inte enstaka race utan en hel "säsong" av racing med ett eller fler race. För att delta i en serie så MÅSTE man anmäla sig till serien i boten PER SÄSONG. Man kan vara anmäld till flera serier samtidigt.

När en ny säsong startar så anmäler man sig för serien och den aktuella säsongen. Eventuellt kommer boten att tala om i utvalda PSN-grupper när en säsong startas, annars får man följa med i PSN-grupper och/eller sociala media för att veta när en ny säsong startas.

Visa vilka serier som finns

För att se vilka serier som finns och vad de heter och vilka klasser som körs så kör man kommandot:

!league

Detta returnerar en lista på tillgängliga serier. Där ingår seriens id-nummer, namn och klass. Vill man få mer info om en viss serie kan man även köra kommandot:

!league <seriens id/namn>

Som då visar mer information om serien med angivet id eller namn.

Exempel:

!league SSGr3
!league 15

Exemplet överst visar mer information om serien med namnet "SSGr3", medan det undre exemplet visar mer info om serien med id-nummer 15.

Anmäla sig till en serie

För att anmäla sig till en serie använder man kommandot:

!league register <seriens id/namn>

Detta anmäler DIG (via ditt PSN-id) till serien med angivet id-nummer eller namn. Man kan inte anmäla någon annan förare än sig själv.

Exempel:

!league register 11
!league register SSGr4

Första exemplet anmäler dig till serien med id-nummer 1, medan det andra exemplet anmäler dig till serien med namnet "SSGr4".

Seriens förutsättningar

Ibland kanske man vill se om en serie tillåter TCS, tuning och liknande innan man anmäler sig. Dessa inställningar kan man se med kommandot:

!league settings <seriens id/namn>

Vilket returnerar de aktuella lobbyinställningarna serien kör med.

Exempel:

!league settings 13
!league settings SRLTest

Exemplen visar inställningarna för serien med id-nummer 13 respektive namnet "SRLTest".

Race

När det är dags för race så sköts även detta via boten. För den som kör är det ganska okomplicerat. Boten "öppnar" automatiskt (i normala fall) ett race för anmälan 8 timmar innan racet ska köras. När ett race är öppet så kan man anmäla sig till ett race. Detta för att förare inte ska kunna anmäla sig dagar eller veckor i förväg och sen kanske inte dyker upp. OBS! Man MÅSTE vara anmäld till den aktuella SERIEN (!league register) för att kunna anmäla sig till ett RACE!

Visa kommande race

Om man vill se vilka race som är aktuella på kalendern så gör man det med kommandot:

!race

Detta listar helt enkelt alla nästkommande race, oavsett serie. Det som listas är racets id-nummer, vilken serie det körs i, när det körs och på vilken bana (samt när på banan).

Visa mer info om ett race

Om man vill se ytterligare information om ett specifikt race så kan man göra det med kommandot:

!race <racets id>

Racets id-nummer visas när man listar race, så där får man först kolla vilket id-nummer ett race har. Kommandot ger ytterligare information om statusen för racet, samt eventuella inställningar som är aktuella för racet.

Visa kommande race i serie

Vill man se kommande race för en specifik serie gör man det med kommandot:

!race list <seriens id/namn>

Detta listar kommande race endast för serien angiven med id-nummer eller namn. I övrigt samma som "Visa kommande race" ovan.

Exempel:

!race list 11
!race list SSGr3

Det första exemplet listar kommande race för serien med id-nummer 11 (om det finns något) och det andra exemplet listar kommande race för serien med namnet "SSGr3".

Anmäla sig till race

OBS! Man MÅSTE vara anmäld till den aktuella SERIEN (!league register) för att kunna anmäla sig till ett RACE! Ett race öppnas normalt för anmälan 8 timmar innan kvalet startar. När ett race är öppnat för anmälan så kan man anmäla sig till det öppnade racet i serien med kommandot:

!race register <seriens id/namn>

Detta anmäler DIG (via ditt PSN-id) för det öppnade racet i serien. Beroende på seriens utformning så kan det även spela roll NÄR du anmäler dig, då det i undantagsfall kan bli så att anmälda förare som inte kvalar ändå kan tas med på startgridden. Dessa förare sorteras efter anmälningstid, så "först till kvarn" gäller. I de flesta fall kommer detta inte att vara ett problem.

OBS! Man kan bara registrera sig fram till max 30 minuter efter racets utsatta tid! Detta är dock ingen garanti för att man ska få köra. Blir ett race betydligt försenat bör seriens admins ändra tid för racet istället.

Exempel:

!race register SSGr2
!race register 12

Det övre exemplet anmäler dig till det öppna racet i serien "SSGr2" medan det nedre exemplet gör det motsvarande för serien med id-nummer 12.

Rapportera kvaltid

När kvalet körts ska alla förare mata in sina respektive kvaltider för att startordningen i racet ska kunna avgöras. I tidernas begynnelse gjordes detta helt manuellt, men senare har ett formulär på Google Forms använts för detta ändamål. Med boten som redskap ska kvaltiderna istället rapporteras direkt till boten. Detta görs med kommandot:

!race qt <bästa varvtid> <position i lobbyn> <lobbyns ägare>

Varvtiden man anger ska anges i format som 1:23.456, d.v.s. ett kolon skiljer minuter från sekunder och en punkt (inte komma) skiljer sekunder och tusendelar. Sekunder skrivs alltid med två siffror, tusendelar alltid med tre siffror. Det är inte obligatoriskt men önskvärt att mata in sin kvalposition i kvallobbyn och i vilken kvallobby (PSN-id för den som kör lobbyn). Position anges som ex.vis P3 för placering 3 i lobbyn, och t.ex. SwOiL om det är PSN-id:t på den som håller i lobbyn.

Exempel:

!race qt 1:23.456
!race qt 1:23.456 P1
!race qt 1:23.456 West308
!race qt 1:23.456 P1 West308

Ovanstående fyra exempel registrerar alla kvaltid för DIG (via ditt PSN-id). Första exemplet anger enbart varvtiden du vill registrera som kvaltid. Andra exemplet lägger även till vilken position du hade efter kvalet var slut i den lobby du kvalade i. I det tredje exemplet anges inte kvalposition i lobbyn, däremot anges vem som höll i lobbyn. I sista exemplet anges både kvalposition och vem som höll i lobbyn.

OBS! Vid sådana tillfällen då man av någon anledning är anmäld till mer än ett race och både racen är öppna för kval så ber boten dig att även specifiera racets id före varvtiden. Så det kan komma att krävas ytterligare en parameter.

Övrigt

Boten tillhandahåller ytterligare några mer generella funktioner. Dessa påverkar inte någon av de funktioner som boten tillhandahåller vad gäller serier, race och teams.

Visa ditt id

Om man vill se sitt interna GT Sport-id så gör man det med kommandot:

!id

Som returnerar ditt numeriska id i Polyphony Digitals system.

Visa statistik

Du kan se level, DR (driver rating) och SR (sportmanship rating) för dig själv eller någon annan med kommandot:

!stats <psn-id>

Boten försöker då ta reda på aktuell statistik (uppdateras max var 5:e minut) för angivet <psn-id>. Man kan även skippa parametern för att se sin egen statistik.

Exempel:

!stats
!stats Bornhall

Det första exemplet returnerar level, DR och SR för DIG (via ditt PSN-id), medan det andra exemplet returnerar motsvarande information för användaren/föraren med PSN-id "Bornhall".

Visa bilar

Boten har alla bilar i Gr.1, Gr.2, Gr.3 och Gr.4 inlagda i databasen. Dessa kan man lista med kommandot:

!cars

Vilket ger hela listan över bilarna. Bilarna listas med deras id-nummer, märke och modell samt vilken klass de tillhör. I dagsläget finns ingen ytterligare information inlagd om bilar, som tekniska data och liknande.

Visa bilar efter klass

Vill man se bilar för bara en enda klass kan man göra det med kommandot:

!cars <klass>

Vilket listar enbart bilarna i angiven klass. I dagsläget svarar boten bara på klasserna Gr.1, Gr.2, Gr.3 och Gr.4 då det är de enda bilarna inlagda i databasen.

Exempel:

!cars Gr.1
!cars Gr.2
!cars Gr.3
!cars Gr.4

Observera att det inte är något mellanrum mellan punkten och siffran i klasserna. Det första exemplet listar enbart Gr.1-bilar, andra exemplet enbart Gr.2 o.s.v.

Visa bilar efter märke

Vill man se bilar för ett enskilt bilmärke kan man göra det med kommandot:

!cars <bilmärke>

Boten försöker tolka det du skriver in så gott den kan för att matcha bilmärken i databasen.

Exempel:

!cars arston matrin
!cars hundai

Den skarpögde ser naturligtvis att bilmärkena är felstavade i båda exemplen. Boten försöker dock tolka det man skrivit så gott den kan, så det första exemplet ska ändå returnera bilarna för "Aston Martin". Det andra exemplet kommer däremot att matcha på både "Hyundai" och "Honda", så där returneras båda märkena.

Visa banor

Boten har de flesta banor inlagda i databasen. Dessa kan man lista med kommandot:

!track

Vilket lista banorna i bokstavsordning. Banorna listas med id-nummer, namn och längd i km.

Visa enskild bana

Man kan få lite mer information om en enskild bana med kommandot:

!track <banans id/namn>

Vilket visar bland annat vilka klockslag/förhållanden på banan som finns tillgängliga. Om man anger banans namn istället för id-nummer så försöker boten så gott den kan att tolka det du skrivit mot vad som finns i databasen.

Exempel:

!track 503
!track nrbrgring 24h

Det första exemplet returnerar mer info om banan med id 503 ("Autodrome Lago Maggiore", i det här fallet) och det andra försöker matcha så gott den kan och returnerar information om "Nürburgring 24h".

Verifiera en webbläsare

Man kan om man vill använda en webbläsare för att interagera med boten, men då måste man först verifiera vem man är via PSN. Boten finns på webben här: http://granturismosport.se/bot/

Boten håller sig verifierad i upp till 30 dagar om man inte använder den under den tiden. Därefter slutar den automatiska verifieringen att fungera, och man måste på nytt verifiera sin webbläsare. Detta lagras i form av cookies på din dator/läsplatta/telefon, så om du rensar cookies så tappar webbläsaren sin verifiering.

Det första man gör är att man surfar till boten i sin webbläsare. Sen går man tillbaka till PSN och en grupp eller diskussion där boten är med och skriver kommandet:

!webreg

Detta kommando returnerar (via PSN) en sexsiffrig kod som man sen ska ange till boten i sin webbläsare tillsammans med ett kommando:

!verify <sexsiffrig kod>

Koden är bara giltig i 5 minuter från att den genererats med !webreg och man kan maximalt ha 5 webbläsare anslutna till sin användare i boten. Försöker man lägga till en sjätte webbläsare så plockas den webbläsare man inte använt på längst tid bort.

Exempel:

!webreg (via PSN)
!verify 123456 (via webbläsaren)

Det första kommandot kör du via PSN, där du får (i exemplet 123456) den sexsiffriga koden. I din webbläsare kör du sedan det andra kommandot (med den kod boten genererade till dig) så att den kan identifiera dig.

När boten verifierat att du är du så kan du köra de flesta kommandon från webbläsaren istället. När kommandon skickas till boten via webben kommer även svaret att gå till webbläsaren. Undantag är kommandon som utannonserar något till hela grupper.