מנהל חבילות יוניטי

Unity היא פלטפורמה שקיימת די הרבה זמן ומתפתחת כל הזמן. עם זאת, כאשר עובדים בו עם מספר פרויקטים בו-זמנית, אתה עדיין יכול להיתקל בקשיים בשימוש במקורות נפוצים (.cs), ספריות (.dll) ונכסים אחרים (תמונות, צלילים, דגמים, טרומיות). במאמר זה נדבר על הניסיון שלנו עם פתרון מקורי לבעיה כזו עבור Unity.

שיטות הפצת משאבים משותפים

יש יותר מדרך אחת להשתמש במשאבים משותפים עבור פרויקטים שונים, אבל לכל גישה יש את היתרונות והחסרונות שלה.

1. שכפול - אנו משכפלים משאבים בין פרויקטים "ביד".

יתרונות:

• מתאים לכל סוגי המשאבים.
• אין בעיות תלות.
• אין בעיות עם GUID של נכסים.

חסרונות:

• מאגרי ענק.
• אין אפשרות לניהול גרסאות.
• קושי לעקוב אחר שינויים במשאבים משותפים.
• קושי לעדכן משאבים משותפים.

2. תת מודולים של גיט - הפצה של משאבים משותפים באמצעות תת-מודולים חיצוניים.

יתרונות:

• אפשר לעבוד עם המקורות.
• אתה יכול לחלק נכסים.
• אין בעיות תלות.

חסרונות:

• חובה ניסיון ב-Git.
• Git לא מאוד ידידותי לקבצים בינאריים - תצטרך לחבר את LFS.
• בקרת גישה למאגרים.
• קושי בשדרוג ושדרוג גרסאות לאחור.
• התנגשויות GUID אפשריות ואין התנהגות ברורה מצידה של Unity כדי לפתור אותן.

3. NuGet - הפצת ספריות משותפות באמצעות חבילות NuGet.

יתרונות:

• עבודה נוחה עם פרויקטים שאינם תלויים ב-Unity.
• ניהול גרסאות ופתרון תלות נוחים.

חסרונות:

• Unity לא יכולה לעבוד עם חבילות NuGet מחוץ לקופסה (ב-GitHub אתה יכול למצוא את NuGet Package Manager for Unity, שמתקן את זה, אבל יש כמה ניואנסים).
• קשיים בחלוקת סוגים אחרים של נכסים.

4. Unity Package Manager - הפצת משאבים משותפים באמצעות פתרון מקורי ל-Unity.

יתרונות:

• ממשק מקורי לעבודה עם חבילות.
• הגנה מפני החלפת קובצי .meta בחבילות עקב התנגשויות GUID.
• אפשרות לניהול גרסאות.
• יכולת להפיץ את כל סוגי המשאבים עבור Unity.

חסרונות:

• התנגשויות GUID עדיין יכולות להתרחש.
• אין תיעוד ליישום.

לשיטה האחרונה יש יותר יתרונות מחסרונות. עם זאת, זה לא מאוד פופולרי עכשיו בגלל היעדר תיעוד, ולכן נתעכב על זה בפירוט.

מנהל חבילות יוניטי

Unity Package Manager (UPM) הוא כלי לניהול חבילות. הוא התווסף ב-Unity 2018.1 והיה בשימוש רק עבור חבילות שפותחו על ידי Unity Technologies. עם זאת, החל מגרסה 2018.3, ניתן היה להוסיף חבילות מותאמות אישית.

ממשק Unity Package Manager

החבילות אינן מגיעות למקורות הפרויקט (ספריית הנכסים). הם נמצאים בספרייה נפרדת %projectFolder%/Library/PackageCache ואינם משפיעים על הפרויקט בשום אופן, האזכור היחיד שלהם בקוד המקור הוא בקובץ packages/manifest.json.

חבילות במערכת קבצי הפרויקט

מקורות חבילה

UPM יכולה להשתמש במספר מקורות חבילה:

1. מערכת קבצים.

יתרונות:

• מהירות היישום.
• אינו דורש כלי צד שלישי.

חסרונות:

• קושי בניהול גרסאות.
• גישה משותפת למערכת הקבצים נדרשת לכל מי שעובד עם הפרויקט.

2. מאגר Git.

יתרונות:

• כל מה שאתה צריך זה מאגר Git.

חסרונות:

• לא ניתן לעבור בין גרסאות דרך חלון UPM.
• לא עובד עם כל מאגרי Git.

3. מאגר npm.

יתרונות:

• תומך באופן מלא בפונקציונליות UPM ומשמש להפצת חבילות Unity רשמיות.

חסרונות:

• כרגע מתעלם מכל גרסאות המחרוזות של החבילות מלבד "-preview".

להלן נבחן את היישום של UPM + npm. החבילה הזו נוחה מכיוון שהיא מאפשרת לך לעבוד עם כל סוג של משאב ולנהל גרסאות חבילה, וגם תומך באופן מלא בממשק UPM המקורי.

אתה יכול להשתמש בו כמאגר npm ורדאצ'יו. יש מפורט תיעוד, ורק כמה פקודות נדרשות כדי להפעיל אותו.

הקמת הסביבה

ראשית אתה צריך להתקין node.js.

יצירת חבילה

כדי ליצור חבילה, עליך למקם את הקובץ package.json, שיתאר זאת, לספרייה עם התוכן של חבילה זו. אתה צריך לעשות את הפעולות הבאות:

עבור אל ספריית הפרויקט שאנו רוצים ליצור חבילה.

הפעל את הפקודה npm init והזן את הערכים הנדרשים במהלך הדו-שיח. עבור שם, ציין את השם בפורמט תחום הפוך, למשל com.plarium.somepackage.
כדי להציג בנוחות את שם החבילה, הוסף את המאפיין displayName ל-package.json ומלא אותו.

מכיוון ש-npm מכוון js, הקובץ מכיל את המאפיינים הראשיים והסקריפטים שאנחנו לא צריכים, שבהם Unity לא משתמשת. עדיף להסיר אותם כדי לא לבלבל את תיאור החבילה. הקובץ אמור להיראות בערך כך:

1. עבור אל ספריית הפרויקט שאנו רוצים ליצור חבילה.
2. הפעל את הפקודה npm init והזן את הערכים הנדרשים במהלך הדו-שיח. עבור שם, ציין את השם בפורמט תחום הפוך, למשל com.plarium.somepackage.
3. כדי להציג בנוחות את שם החבילה, הוסף את המאפיין displayName ל-package.json ומלא אותו.
4. מכיוון ש-npm מכוון js, הקובץ מכיל את המאפיינים הראשיים והסקריפטים שאנחנו לא צריכים, שבהם Unity לא משתמשת. עדיף להסיר אותם כדי לא לבלבל את תיאור החבילה. הקובץ אמור להיראות בערך כך:

   {
    "name": "com.plarium.somepackage",
    "displayName": "Some Package",
    "version": "1.0.0",
    "description": "Some Package Description",
    "keywords": [
      "Unity",
      "UPM"
    ],
    "author": "AUTHOR",
    "license": "UNLICENSED"
   }

5. פתח את Unity וצור קובץ .meta עבור package.json (Unity לא רואה נכסים ללא קובצי .meta, חבילות עבור Unity נפתחות לקריאה בלבד).

שולח חבילה

כדי לשלוח את החבילה עליך להפעיל את הפקודה: npm publish --registry *адрес до хранилища пакетов*.

התקנה ועדכון חבילות באמצעות Unity Package Manager

כדי להוסיף חבילה לפרויקט Unity, אתה צריך:

1. הוסף לקובץ manifest.json מידע על מקור החבילות. לשם כך עליך להוסיף את הנכס scopedRegistries וציינו את ההיקפים וכתובת המקור שבה יחפשו היקפים ספציפיים.

   
   "scopedRegistries": [
      {
        "name": "Main",
        "url": "адрес до хранилища пакетов",
        "scopes": [
          "com.plarium"
        ]
      }
    ]
   

2. עבור אל Unity ופתח את חלון מנהל החבילות (עבודה עם חבילות מותאמות אישית אינה שונה מעבודה עם חבילות מובנות).
3. בחר כל החבילות.
4. מצא את החבילה שאתה צריך והוסף אותה.

עבודה עם מקורות וניפוי באגים

כדי שהמקורות יתחברו לפרויקט, צריך ליצור הגדרת הרכבה עבור החבילה.

השימוש בחבילות אינו מגביל את אפשרויות ניפוי הבאגים שלך. עם זאת, כאשר עובדים עם חבילות ב-Unity, לא ניתן לעבור ל-IDE על ידי לחיצה על שגיאה במסוף אם השגיאה התרחשה בחבילה. זאת בשל העובדה ש-Unity לא רואה בסקריפטים קבצים נפרדים, שכן בעת ​​שימוש ב-Assembly Definition הם נאספים לספרייה ונכללים בפרויקט. כאשר עובדים עם מקורות מפרויקט, לחיצה על ה-IDE זמינה.

סקריפט בפרויקט עם חבילה מחוברת:

סקריפט מהחבילה עם נקודת שבירה עובדת:

תיקונים דחופים לחבילות

חבילות Unity שנוספו לפרויקט הן לקריאה בלבד, אך ניתן לערוך אותן במטמון החבילה. כדי לעשות זאת אתה צריך:

1. עבור אל החבילה במטמון החבילה.

   

2. בצע את השינויים הדרושים.
3. עדכן גרסה בקובץ package.json.
4. שלח חבילה npm publish --registry *адрес до хранилища пакетов*.
5. עדכן את גרסת החבילה לגרסה המתוקנת באמצעות ממשק UPM.

התנגשויות בייבוא ​​חבילה

התנגשויות ה-GUID הבאות עלולות להתרחש בעת ייבוא ​​חבילות:

1. חבילה - חבילה. אם בעת ייבוא ​​חבילה מתגלה שחבילות שכבר נוספו מכילות נכסים עם אותו GUID, נכסים עם GUID תואמים מהחבילה המיובאת לא יתווספו לפרויקט.
2. חבילה היא פרויקט. אם בעת ייבוא ​​חבילה יתגלה שהפרויקט מכיל נכסים עם GUID תואמים, אז הנכסים מהחבילה לא יתווספו לפרויקט. עם זאת, נכסים התלויים בהם יתחילו להשתמש בנכסים מהפרויקט.

העברת נכסים מפרויקט לחבילה

אם תעבירו נכס מפרויקט לחבילה בזמן ש-Unity פתוחה, הפונקציונליות שלו תישמר, וקישורים בנכסים תלויים יתחילו להשתמש בנכס מהחבילה.

זה חשוב: בעת העתקת נכס מפרויקט לחבילה, תתרחש התנגשות "חבילה - פרויקט" המתוארת בסעיף לעיל.

פתרונות אפשריים לקונפליקטים

1. הקצאה מחדש של GUIDs באמצעות אלגוריתמים משלנו בעת ייבוא ​​כל הנכסים כדי למנוע התנגשויות.
2. הוספת כל הנכסים לפרויקט אחד ואז חלוקתם לחבילות.
3. יצירת מסד נתונים המכיל את ה-GUIDs של כל הנכסים וביצוע אימות בעת שליחת חבילות.

מסקנה

UPM הוא פתרון חדש להפצת משאבים משותפים ב-Unity, שיכול להוות אלטרנטיבה ראויה לשיטות קיימות. ההמלצות המתוארות במאמר התבססו על מקרים אמיתיים. אנו מקווים שתמצאו אותם שימושיים.

מקור: www.habr.com