Difference between revisions of "Legends Of Aria Toolkit"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
 
(5 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
*2. From the Unity Asset Store search for Standard Assets and import the Unity provided Standard Assets.  
 
*2. From the Unity Asset Store search for Standard Assets and import the Unity provided Standard Assets.  
 
*3. From the Unity menu select Assets -> Import Packages -> Custom Package, select the Legends of Aria Toolkit that has been downloaded and import it completely.
 
*3. From the Unity menu select Assets -> Import Packages -> Custom Package, select the Legends of Aria Toolkit that has been downloaded and import it completely.
*4. Optionally from the Unity Asset Store search for Post Processing, and import the Unity provided Post Processing Stack.  
+
*4. Optionally you may also wish to install post processing support.  
** '''Note:''' With Unity 2018.3 and higher the Post Processing Stack asset has some errors which need manually corrected, as the asset is out of date.  
+
** '''Note:''' With Unity 2018.3 and higher the Post Processing Stack asset available via the asset store has errors and does not compile without manual changes.  
 
** In the file MinDrawer.cs change all references of MinAttribute to UnityEngine.PostProcessing.MinAttribute to resolve the namespace conflict.
 
** In the file MinDrawer.cs change all references of MinAttribute to UnityEngine.PostProcessing.MinAttribute to resolve the namespace conflict.
*5. At this time you should now have a LoA Toolkit Menu bar item present, and you should also be able to open and run the ShardsToolkit scene without issue.  
+
*5. At this time you should now have a LoA Toolkit Menu bar item present, and you should also be able to open and run the ShardsToolkit scene without issue.
  
 
=== Upgrading Versions ===  
 
=== Upgrading Versions ===  
* Upgrading to a new version of the toolkit can be an easy or difficult process. This is in part as it means also upgrading to a new Unity version which often can cause problems. Below is a slower but safer route for upgrades. Consult the toolkit change log for any importance notices that might affect upgrading.
+
* Upgrading to a new version of the toolkit can be an easy or difficult process. This is in part as it means also upgrading to a new Unity version which often can cause problems. Consult the toolkit change log for any importance notices that might affect upgrading.
 +
 
 +
==== Slow/Safer Method ====
 
* 1. Upgrade or install another Unity to the proper version.  
 
* 1. Upgrade or install another Unity to the proper version.  
 
* 2. Backup your project.  
 
* 2. Backup your project.  
* 3. Delete the Legends of Aria Toolkit folder from your project's Assets directory.
+
* 3. Delete the Legends of Aria Toolkit folder from your project's Assets directory. (Make sure you don't have any project specific files stored in here)
 
* 4. Delete the Library folder from your project's root directory. (This will force Unity to do a full re-import)
 
* 4. Delete the Library folder from your project's root directory. (This will force Unity to do a full re-import)
 
* 5. Open your project in the upgraded or new Unity version.
 
* 5. Open your project in the upgraded or new Unity version.
Line 18: Line 20:
 
* 7. Hopefully at this point you will have a LoA Toolkit menu item again.
 
* 7. Hopefully at this point you will have a LoA Toolkit menu item again.
 
* 8. From LoA Toolkit Menu execute Utils -> Generate LOA Required Tags and Layers
 
* 8. From LoA Toolkit Menu execute Utils -> Generate LOA Required Tags and Layers
* 9. Restart Unity / Reload your project.
+
* 9. From your backup copy over the following files from Assets\Legends of Aria Toolkit\Scripts\Editor\Toolkit\ (ToolsData.asset, ToolkitSettings.asset, WorldStreamManageData.asset ) into the freshly installed Assets\Legends of Aria Toolkit\Scripts\Editor\Toolkit\ folder.
* 10. Ideally at this point everything will be working. You may have issues with 3rd party assets/etc that also need updates for the newer Unity version.
+
* 10. Restart Unity / Reload your project.
 +
* 11. Ideally at this point everything will be working. You may have issues with 3rd party assets/etc that also need updates for the newer Unity version.
 +
 
 +
==== Faster / Risky ====
 +
* 1. Upgrade or install another Unity to the proper version.
 +
* 2. Backup your project.
 +
* 3. Import the new toolkit bundle as from step 3 of Installation of a fresh project.
 +
* 4. Hopefully everything works, but it may not.
  
 
=== ChangeLog ===
 
=== ChangeLog ===
 +
==== 0.8.8 ====
 +
* Major release, uses Unity version 2019.1.6f1
 +
** Updates the toolkit to work with Legends of Aria client versions 0.8.7 and 0.8.8.
 +
** Updates to latest world objects, and base game maps.
 +
** Resolves material issues with Tree1Object, missing hue scripts for rocks, and fixes static collision tool.
 +
 
==== 0.8.5 ====
 
==== 0.8.5 ====
 
* Major release, uses Unity version 2018.3.4f1
 
* Major release, uses Unity version 2018.3.4f1

Latest revision as of 00:22, 18 June 2019

Installation / Fresh Project

  • 1. Create a new Unity project. Consult the Toolkit ChangeLog to see which version of Unity is supported with the given version of the toolkit.
  • 2. From the Unity Asset Store search for Standard Assets and import the Unity provided Standard Assets.
  • 3. From the Unity menu select Assets -> Import Packages -> Custom Package, select the Legends of Aria Toolkit that has been downloaded and import it completely.
  • 4. Optionally you may also wish to install post processing support.
    • Note: With Unity 2018.3 and higher the Post Processing Stack asset available via the asset store has errors and does not compile without manual changes.
    • In the file MinDrawer.cs change all references of MinAttribute to UnityEngine.PostProcessing.MinAttribute to resolve the namespace conflict.
  • 5. At this time you should now have a LoA Toolkit Menu bar item present, and you should also be able to open and run the ShardsToolkit scene without issue.

Upgrading Versions

  • Upgrading to a new version of the toolkit can be an easy or difficult process. This is in part as it means also upgrading to a new Unity version which often can cause problems. Consult the toolkit change log for any importance notices that might affect upgrading.

Slow/Safer Method

  • 1. Upgrade or install another Unity to the proper version.
  • 2. Backup your project.
  • 3. Delete the Legends of Aria Toolkit folder from your project's Assets directory. (Make sure you don't have any project specific files stored in here)
  • 4. Delete the Library folder from your project's root directory. (This will force Unity to do a full re-import)
  • 5. Open your project in the upgraded or new Unity version.
  • 6. Import the new toolkit bundle as from step 3 of Installation of a fresh project.
  • 7. Hopefully at this point you will have a LoA Toolkit menu item again.
  • 8. From LoA Toolkit Menu execute Utils -> Generate LOA Required Tags and Layers
  • 9. From your backup copy over the following files from Assets\Legends of Aria Toolkit\Scripts\Editor\Toolkit\ (ToolsData.asset, ToolkitSettings.asset, WorldStreamManageData.asset ) into the freshly installed Assets\Legends of Aria Toolkit\Scripts\Editor\Toolkit\ folder.
  • 10. Restart Unity / Reload your project.
  • 11. Ideally at this point everything will be working. You may have issues with 3rd party assets/etc that also need updates for the newer Unity version.

Faster / Risky

  • 1. Upgrade or install another Unity to the proper version.
  • 2. Backup your project.
  • 3. Import the new toolkit bundle as from step 3 of Installation of a fresh project.
  • 4. Hopefully everything works, but it may not.

ChangeLog

0.8.8

  • Major release, uses Unity version 2019.1.6f1
    • Updates the toolkit to work with Legends of Aria client versions 0.8.7 and 0.8.8.
    • Updates to latest world objects, and base game maps.
    • Resolves material issues with Tree1Object, missing hue scripts for rocks, and fixes static collision tool.

0.8.5

  • Major release, uses Unity version 2018.3.4f1
    • Updates the toolkit to work with Legends of Aria client versions 0.8.5.
    • Updates to latest world objects, and base game maps, including expanded dungeons.
    • Resolves locale issues that could result in xml data being saved out that the ShardServer can not load correctly.
    • Updates the default dungeon camera to have correct culling layers.