Rider, Jypeli ja ComTest asennusohjeet

Tämän sivun ohjeilla asennetaan Jypeli-kehitystyökalut (JetBrains Rider ja Jypeli) sekä ComTest-laajennus Rideriin.

Aiheeseen liittyvät ohjeet:

• Rider: Projektin luominen ja muita vinkkejä
• Debuggaus

1. Asennuksen vaiheet

1. .NET ja Jypeli asennettu (linkki vie toiseen dokumenttiin)
2. Aktivoi itsellesi JetBrains-opiskelijalisenssi
3. Asenna Rider
4. Testaa Jypeli
5. Asenna ComTest

TODO: Tähän väliin .NET-asennusohjeet

2. Aktivoi itsellesi JetBrains-opiskelijalisenssi

Riderin käyttämiseen tarvitaan lisenssi.

Muistathan myös, että Rideria voi käyttää 30 päivää kirjautumatta / ilman lisenssiä.

Vaihtoehtoisesti niin tutkinto-opiskelijat kuin muut opiskelijat voit käyttää myös maksutonta Visual Studio Communitya (vain Windows). Sen käyttämiseen tarvitaan Microsoft-tili (koulun tunnus tai privaattitunnus).

3. Rider

3.1 Lataaminen ja asentaminen

Lataa Rider klikkaamalla Download sivulla https://www.jetbrains.com/rider/

Käytä oletusasetuksia eli klikkaile Next ja lopuksi Install. Windowsissa Vesa asensi hakemistoon c:\devel\rider.

MacOS - mistä tiedän minkä Riderin lataan?

• Klikkaa työpöydän vasemmasta yläreunasta ompun kuvaa
• Valitse "Tietoja tästä tietokonesta" (tms)
• Valitse Riderin asennuspaketti suorittimen mukaan. Jos suorittimen kohdalla lukee M1 tai M2, valitse ".dmg (Apple Silicon)". Jos taas suorittimen kohdalla lukee Intel, valitse ".dmg (Intel)".

Linux Ubuntuun asennuksen sai helpommin ottamalla Software & Updates -"kaupasta".

3.2 Ensimmäinen käynnistys

Käynnistä Rider. Hyväksy käyttöehdot.

Näppäinoikoteiden asetuksiksi kannattaa valita Visual Studio 2022. Näppäinoikoteitä voi säätää myös jälkikäteen kohdasta Settings -> Keymap.

Plugineja ei tarvitse ladata.

Kirjaudu sisään JetBrain-käyttäjänä käyttäen sitä tiliä, jota käytit tämän ohjeen kohdassa 2. Aktivoi lisenssi. Voit kuitenkin käyttää Rideria 30 päivää ilman lisenssiä (esim. jos lisenssin saamisessa on ongelmia).

3.3 Kokeile toimiiko

Valitse New Solution. Tämän jälkeen .NET / .NET Core alta valitse Console Application ja paina Create. Korvaa Program.cs tiedoston sisältö seuraavalla:

Console.WriteLine("Toimii :-)");

ja valitse ylävalikosta Run. Riderin alaosaan pitäisi avautua konsoli-ikkuna, jossa lukee Riderin suorittama komento ohjelman ajamiseksi ja sen jälkeen "Toimii :-)".

Solutionin ja projektien luomiseksi on yksityiskohtaisemmat ohjeet täällä.

4. Jypeli

4.1 Asentaminen

Jos et jo aikaisemmissa vaiheissa asentanut Jypeliä, niin mene komentoriville ja kirjoita

dotnet new install Jypeli.Templates

Jos ylempi ohje ei toimi tai olet yliopiston koneella, kirjoita

dotnet new --install Jypeli.Templates

Jos on ongelmia, katso auttaako jokin kohdan 7 ratkaisuvaihtoehdoista.

4.2 Kokeile toimiiko

1. Käynnistä Rider
2. Valitse New Solution, valitse Tasohyppelypeli (yliopiston koneilla valitse .NET versioksi 6.0) ja paina Create. Ensimmäisellä kerralla projektin luomisessa saattaa hieman kestää.
3. Klikkaa ylhäällä olevaa vihreää kolmiota jonka vieressä lukee Run tai käytä näppäinoikotietä (näet näppäinoikotien pitäessäsi kursoria Run-kuvakkeen päällä).
4. Nyt pitäisi aueta ikkuna, jossa on nuolinäppäimillä toimiva norsupeli. Jos näin kävi, Jypelin asennus onnistui.

Jypeli vaatii, että sinulla on .NET asennettuna. Nämä sinulla pitäisi olla, jos olet seurannut asennusohjeita.

4.3 Jypelin päivittäminen

Kun Jypeliin julkaistaan päivitys, Rider lataa sen sinulle automaattisesti uutta projektia luodessa.

Suurten päivitysten yhteydessä ns. major-versio saattaa muuttua. Tällöin Jypeli on asennettava uudestaan komennolla

dotnet new install Jypeli.Templates

5. Rider-asetukset

Oletusasetukset koodin muotoilulle ja analysoinnille ovat tämän kurssin näkökulmasta usein turhan aggressiivisia (ts. auttavat turhan innokkaasti tai väärään suuntaan), joten muutetaan asetuksia tämän kurssin suositusten mukaisiksi.

Jos haluat varmuuskopioida nykyiset asetuksesi, tee se valikosta File \(\rightarrow\) Manage IDE Settings \(\rightarrow\) Export Settings...

• Lataa asetuspaketti (settings.zip)
• Mene Riderissa File \(\rightarrow\) Manage IDE Settings \(\rightarrow\) Import Settings...
• Etsi ja valitse äsken haettu tiedosto
• Klikkaa OK, sitten Import and Restart

Vaihtoehtoisesti voit mukauttaa asetuksia yksitellen alla olevien ohjeiden mukaisesti.

Pro tip: Jos käytät Rideria usealla tietokoneella, voit synkronoida asetuksesi valitsemalla File \(\rightarrow\) Manage IDE Settings \(\rightarrow\) Settings sync.

6. Sisällön tuominen projektiin (content)

Kuvat ja äänet lisätään peliprojektin Content-kansioon, joka näkyy editorin tiedostolistauksessa.

Content-kansion voi luoda klikkaamalla hiiren oikealla projektia -> Add -> Directory

1. Lisää tiedosto klikkaamalla kansiota hiiren oikealla napilla -> Add -> Add Existing Item
2. Valitse tiedosto(t) jonka haluat lisätä ja paina ok.
3. Valitse Copy.
4. Klikkaa tuomaasi tiedostoa Content-kansiossa hiiren oikealla ja valitse Properties
5. Vaihda Copy to output directory -kohtaan "Copy if newer"

7. Ongelmia

7.1 Rider-lisenssin uudelleenaktivointi

Opiskelukäyttöön tarkoitettu lisenssi täytyy aika ajoin uudelleenaktivoida kohdasta Help -> Manage licenses. Seuraa alla olevan videon ohjeita.

7.2 dotnet not found / command not found: dotnet

Katso .NET-asennusohjeet

7.3 Linux

Jos komentoriviltä tulee:

A fatal error occurred. The folder [/usr/share/dotnet/host/fxr] does not exist 

niin ks: https://stackoverflow.com/questions/73753672/a-fatal-error-occurred-the-folder-usr-share-dotnet-host-fxr-does-not-exist

7.4 Jypeli-peli ei käynnisty, esim. You must install or update .NET

Etene kuten kohdassa 7.1.

7.5 Näppäinkomennot eivät toimi

Iso osa editorin näppäinoikoteistä (TODO: Esimerkkejä?) ei toimi sellaisenaan muilla kuin Yhdysvaltalaisilla näppäimistöillä. On siis tarpeen valita toimimattomille suosikkikomennoillesi uudet näppäinoikotiet asetuksista: File → Settings → Keymap → Editor actions.

7.6 Silk.NET.Core.Loader.SymbolLoadingException' occurred in Silk.NET.Core.dll: 'Native symbol not found (Symbol: glfwWindowHintString)

Yllä olevan virheviestin syynä on todennäköisimmin että sinulla ei ole GLFW asennettuna, tai se on liian vanha. Monen Linux-distron mukana tulee versio 3.2, mutta Jypeli vaatii vähintään version 3.3.

Asenna uusin GLFW-versio käyttämäsi paketinhallinnan avulla.

7.7 System.PlatformNotSupportedException: GLFW is not supported on this platform...

Voi olla että tietokoneellasi ei ole näytönohjaimen ajureita asennettuna. Mene Windowsin asetukset -> Päivitykset -> Valinnaiset (päivitä-nappulan alapuolella) -> Ajurit. Asenna sieltä jotenkin näyttöön liittyvä ajuri, esimerkiksi "Intel Display Driver"

Jos ajuria ei löydy ja käytät kannettavaa, todennäköisesti sinulla on integroitu näytöonohjain, jolloin ajuri voi löytyä prosessorin valmistajan (Intel tai AMD) sivulta. Hae ajurit Googlesta esimerkiksi hakusanalla Intel graphics driver tai AMD graphics driver prosessorin valmistajasta riippuen.

7.8 Muita ongelmia?

Jos vastaan tuli jokin muu ongelma jota ei tällä sivulla ole raportoitu, ilmoita siitä jotta ongelma ja korjaus voidaan dokumentoida tänne.

8. ComTest

ComTest-testaustyökalua tarvitaan neljännestä demoviikosta alkaen.

Riderille on tarjolla toistaiseksi testikäytössä oleva ComTest-laajennos

Tiedoksi (älä avaa jos et halua tutkia sisältö): Pluginin sivu JetBrains pluginrepossa:
https://plugins.jetbrains.com/plugin/20223-comtest-rider

Plugin sisältää valmiiksi oikean ComTestin eikä vaadi muuta esiasennusta taikka konfigurointia.

8.1 Pluginin asentaminen

1. Avaa Rider ja luo ConsoleMain projekti
2. Mene File | Settings | Plugins:
3. Valitse Marketplace-välilehti ja hae hakusanalla ComTest
4. Valitse Comtest Runner -pluginin kohdalta Install.

5. Paina Save
6. Käynnistä Rider uudelleen.

Jatkossa päivittäminen onnistuu samasta valikosta, mutta Install-painikkeen sijaan näkyy Update.

8.2 ComTest-testipohjan lisääminen koodiin

Plugin lisää uuden comt-pohjan, jolla voi generoida valmiin pohjan yksikkötestien kirjoittamiselle.

Käyttö:

1. Kirjoita testattavalle funktiolle runko, esimerkiksi

       public static int Summa(int a, int b) 
       {
           return 0;
       }

2. Siirrä kursori rungon yläpuolelle ja kirjoita ///, jolloin Rider generoi valmiin rungon funktion dokumentaatiolle:

   

3. Lisää uusi rivi dokumentaation alapuolelle:

   

4. Kirjoita comt ja varmista, että ehdotuksissa näkyy vastaava pohja:

   

5. Paina Enter. Dokumentaation loppuun ilmestyy valmis pohja ComTest-testille:

   

6. Kirjoita tuonne <pre name="test"> rivin ja </pre> rivin väliin

       /// Sum(0, 0) === 0;
       /// Sum(2, 3) === 5;
       /// Sum(-2, 1) === -1;

7. Aja testit alla olevilla ohjeilla.

8. Pitäisi tulla punaista.

9. Korjaa funktion return-lause muotoon

           return a + b;

10. Aja testit uudelleen, pitäisi tulla vihreää.

8.3 Testikoodin generointi ja ajaminen

Valitse Tests | ComTest: Generate Tests from Solution varsinaisen testikoodin generointiin tehtyihin ComTest-testeihin perustuen. Tämä valinta generoi (tai päivittää mikäli testit olivat muuttuneet) ja myös ajaa kaikki testit solutionissa.

Voit myös pelkästään ajaa testit (ilman generointia / päivitystä) valinnalla Tests | Run All Tests from Solution

Vinkki: Nopeinta on käyttää pikanäppäimiä:

• Generoi/päivitä ja aja testit komennolla Ctrl + Shift + T (Windows) tai ⇧ + ⌘ + T (macOS)
• Testien ajo manuaalisesti: Ctrl + U, L (Windows) tai ⌘ + ; (macOS)

8.3.1 Oman pikanäppäimen tekeminen

Vesa: Koska mulla ei toimi tuo Ctrl + Shift + T ja haluan, että ajon voisi suorittaa Ctrl+Q, niin vaihdan pikanäppäintä:

• File/Settings
• hakusanaksi comt
• Valitaan löytyvistä ehdotuksista ComTest: Generate Test from Solution tuplaklikkaamalla
• poistetaan vanha näppäin yhdistelmä (Remove...)
• tuplaklikataan uudelleen
• Add Keyboard Shortcut
• Painetaan sinisella kehystetyssä laatikossa haluttua näppäinyhdistelmää (nyt siis Ctrl+Q)
• OK/Save

8.4 Lähdekoodi

Pluginin lähdekoodi: https://gitlab.jyu.fi/tie/tools/comtest.intellij

9. Muita Rider ohjeita

• Projektin luominen ja muita vinkkejä
• Debuggaus