Unity Package Manager

Unity — en plattform som har funnits länge och ständigt utvecklas. Men när man arbetar med flera projekt samtidigt kan man fortfarande stöta på svårigheter med att använda gemensamma källfiler (.cs), bibliotek (.dll) och andra tillgångar (bilder, ljud, modeller, prefabs). I denna artikel delar vi med oss av vår erfarenhet av en nativ lösning på detta problem för Unity.

Metoder för att sprida gemensamma resurser

Det finns mer än ett sätt att använda gemensamma resurser för olika projekt, men varje metod har sina fördelar och nackdelar.

1. Duplicering — manuellt duplicera resurser mellan projekten.

Fördelar:

• Lämplig för alla typer av resurser.
• Inga problem med beroenden.
• Inga problem med GUID:er för tillgångar.

Nackdelar:

• Gigantiska bibliotek.
• Inga möjligheter till versionshantering.
• Svårigheter att spåra förändringar i gemensamma resurser.
• Svårigheter att uppdatera gemensamma resurser.

2. Git-submoduler — spridning av gemensamma resurser genom externa submoduler.

Fördelar:

• Möjligt att arbeta med källfiler.
• Möjligt att sprida tillgångar.
• Inga problem med beroenden.

Nackdelar:

• Kräver kunskap om Git.
• Git fungerar inte särskilt bra med binära filer — LFS måste anlitas.
• Behörighetsavgränsning för repository.
• Svårigheter vid upp- och nedgraderingar.
• Möjliga GUID-kollisioner och oklarheter i hur Unity hanterar dem.

3. NuGet — spridning av gemensamma bibliotek genom NuGet-paket.

Fördelar:

• Enkel hantering av projekt som inte är beroende av Unity.
• Enkel versionshantering och lösning av beroenden.

Nackdelar:

• Unity kan inte hantera NuGet-paket "ur lådan" (du kan hitta NuGet Package Manager for Unity på GitHub, som åtgärdar detta, men det finns vissa förbehåll).
• Svårigheter vid spridning av andra typer av tillgångar.

4. Unity Package Manager — spridning av gemensamma resurser genom en nativ lösning för Unity.

Fördelar:

• Nativt gränssnitt för att arbeta med paket.
• Skydd mot överskrivning av .meta-filer i paket vid GUID-konflikter.
• Möjlighet till versionshantering.
• Möjlighet att sprida alla typer av resurser för Unity.

Nackdelar:

• Konflikter med GUID:er kan fortfarande inträffa.
• Ingen dokumentation för implementation.

Den senaste metoden har fler fördelar än nackdelar. Men den är för närvarande inte särskilt populär på grund av brist på dokumentation, så vi kommer att gå in på den i detalj.

Unity Package Manager

Unity Package Manager (hädanefter UPM) är ett verktyg för paketledning. Det lades till i Unity 2018.1 och användes enbart för paket som utvecklades av Unity Technologies. Men från och med version 2018.3 blev det möjligt att lägga till anpassade paket.

Gränssnittet för Unity Package Manager

Paket hamnar inte i projektets källfiler (mappen Assets). De finns i en separat mapp. %projectFolder%/Library/PackageCache och påverkar inte projektet; den enda referensen i källfilerna finns i filen packages/manifest.json.

Paket i projektets filsystem

Paketkällor

UPM kan använda flera paketkällor:

1. Filsystem.

Fördelar:

• Genomförande hastighet.
• Kräver inga externa verktyg.

Nackdelar:

• Versioneringens komplexitet.
• Gemensam åtkomst till filsystemet krävs för alla som arbetar med projektet.

2. Git-repository.

Fördelar:

• Endast ett Git-repository behövs.

Nackdelar:

• Kan inte byta versioner via UPM-fönstret.
• Fungerar inte med alla Git-repositories.

3. npm-repository.

Fördelar:

• Stöder fullt ut UPM:s funktionalitet och används för distribution av officiella Unity-paket.

Nackdelar:

• För närvarande ignorerar den alla strängversioner av paket utom »-preview«.

Nedan kommer vi att titta på genomförandet av UPM + npm. Denna kombination är praktisk eftersom den gör det möjligt att arbeta med alla typer av resurser och hantera paketversioner, och stöder även UPM:s ursprungliga gränssnitt helt.

Som npm-repository kan man använda Verdaccio. Det finns en detaljerad dokumentation, och för att köra det behövs bokstavligen några kommandon.

Miljöinställning

För att börja, installera node.js.

Skapa paket

För att skapa ett paket måste filen package.json, som kommer att beskriva det, placeras i katalogen med innehållet för detta paket. Gör följande:

Gå till projektmappen som vi vill göra till ett paket.

Kör kommandot npm init och ange nödvändiga värden under dialogen. För namn anger vi namnet i omvänd domänformat, till exempel com.plarium.somepackage.
För att smidigt visa paketnamnet — lägg till egenskapen displayName i package.json och fyll i det.

Eftersom npm är js-orienterat, finns det i filen onödiga egenskaper som main och scripts, som Unity inte använder. Det är bättre att ta bort dem för att inte överbelasta paketbeskrivningen. Filen bör se ut ungefär så här:

1. Gå till projektmappen som vi vill göra till ett paket.
2. Kör kommandot npm init och ange nödvändiga värden under dialogen. För namn anger vi namnet i omvänd domänformat, till exempel com.plarium.somepackage.
3. För att smidigt visa paketnamnet — lägg till egenskapen displayName i package.json och fyll i det.
4. Eftersom npm är js-orienterat, finns det i filen onödiga egenskaper som main och scripts, som Unity inte använder. Det är bättre att ta bort dem för att inte överbelasta paketbeskrivningen. Filen bör se ut ungefär så här:

   {
    "name": "com.plarium.somepackage",
    "displayName": "Något Paket",
    "version": "1.0.0",
    "description": "Beskrivning av Något Paket",
    "keywords": [
      "Unity",
      "UPM"
    ],
    "author": "FÖRFATTARE",
    "license": "OBEHOVLIG"
   }

5. Öppna Unity och generera en .meta-fil för package.json (Unity ser inte tillgångarna utan .meta-filer; paket för Unity öppnas endast för läsning).

Skicka paketet

För att skicka paketet, måste du köra kommandot: npm publish --registry *adress till paketlagret*.

Installation och uppdatering av paket via Unity Package Manager

För att lägga till ett paket i ett Unity-projekt måste du:

1. Föra in i filen manifest.json information om paketkällor. För detta måste du lägga till egenskapen scopedRegistries och ange scopes och adressen till källan där specifika scopes ska sökas.

   
   "scopedRegistries": [
      {
        "name": "Huvud",
        "url": "adress till paketlagret",
        "scopes": [
          "com.plarium"
        ]
      }
    ]
   

2. Gå till Unity och öppna Package Manager-fönstret (hantering av anpassade paket skiljer sig inte från hantering av inbyggda).
3. Välj Alla Paket.
4. Hitta det nödvändiga paketet och lägg till det.

Arbete med källkod och felsökning

För att källkoden ska kopplas till projektet måste du skapa en Assembly Definition för paketet.

Användningen av paket begränsar inte möjligheterna till felsökning. Men vid arbete med paket i Unity kan du inte gå till IDE genom att klicka på ett fel i konsolen, om felet inträffade i paketet. Detta beror på att Unity inte ser skripten som enskilda filer, eftersom de sammanställs i ett bibliotek och kopplas till projektet vid användning av Assembly Definition. Vid arbete med källkoden från projektet är övergång till IDE möjlig.

Skript i projektet med kopplad paket:

Skript från paketet med fungerande brytpunkt:

Akut ändring av paket

Paketen som har lagts till i projektet är endast skrivskyddade, men de kan redigeras i paketens cache. För detta måste du:

1. Gå till paketet i paketens cache.

   

2. Göra nödvändiga ändringar.
3. Uppdatera versionen i filen package.json.
4. Skicka paketet npm publish --registry *adress till paketlagret*.
5. Uppdatera paketversionen till den korrigerade genom UPM-gränssnittet.

Konflikter vid import av paket

Vid import av paket kan följande GUID-konflikter inträffa:

1. Paket – paket. Om det vid import av paket upptäcks att det finns tillgångar med samma GUID redan i de tillagda paketen, kommer tillgångar med matchande GUID från det importerade paketet inte att läggas till i projektet.
2. Paketet är ett projekt. Om det upptäckts att det finns tillgångar med samma GUID:er i projektet vid import av paketet, kommer inte tillgångarna från paketet att läggas till i projektet. Dock kommer tillgångar som är beroende av dem att börja använda tillgångarna från projektet.

Överföring av tillgångar från projektet till paketet

Om du överför en tillgång från projektet till paketet med Unity öppen, kommer dess funktionalitet att bevaras, och referenser i beroende tillgångar kommer att börja använda tillgången från paketet.

Det är viktigt: vid kopiering av en tillgång från projektet till paketet uppstår konflikten "Paket - projekt", som beskrivits i avsnittet ovan.

Möjliga lösningar på konflikter

1. Omdefiniera GUID:er med egna algoritmer vid import av alla tillgångar för att undvika kollisioner.
2. Samla alla tillgångar i ett projekt och dela dem upp i paket senare.
3. Skapa en databas som innehåller GUID:erna för alla tillgångar och validera vid sändning av paket.

Slutsats

UPM är en ny lösning för distribution av gemensamma resurser på Unity, som kan bli ett värdigt alternativ till befintliga metoder. Riktlinjerna som beskrivs i artikeln har kommit fram genom verkliga fall. Vi hoppas att de är till hjälp.

Källa: habr.com