Modding guide - Revision history

Virror at 20:24, 20 December 2018

2018-12-20T20:24:57Z

Virror at 20:24, 20 December 2018

2018-12-20T20:24:37Z

Virror at 20:13, 20 December 2018

2018-12-20T20:13:51Z

Virror: Replaced content with "== Setup, build and upload== ==General modding ==Specific mods=="

2018-12-20T20:13:44Z

Replaced content with "== Setup, build and upload== ==General modding ==Specific mods=="

Virror at 20:09, 20 December 2018

2018-12-20T20:09:43Z

Kyundra: replaced the missing screenshot of the mod directory path with the correct path

2018-12-20T19:58:57Z

replaced the missing screenshot of the mod directory path with the correct path

Virror: /* Uploading to steam */

2018-12-20T16:35:11Z

‎Uploading to steam

Virror: /* Uploading to steam */

2018-12-20T16:33:54Z

‎Uploading to steam

Jason'Faendra: /* Basic setup */

2018-12-20T16:13:26Z

‎Basic setup

Virror: /* Basic setup */

2018-12-20T16:04:20Z

‎Basic setup

@@ Line 1: / Line 1: @@
 ==[[Setup build upload| Setup, build and upload]]==
 [[Setup build upload#Basic setup|Basic setup]]
 [[Setup build upload#Building and testing|Building and testing]]
 [[Setup build upload#Uploading to steam|Uploading to steam]]
 ==[[General modding]]==
 [[General modding#Scripting basics|Scripting basics]]
 [[General modding#Making an additive scene|Making an additive scene]]
 ==[[Specific mods]]==
 [[Specific mods#Model swap|Model swap]]
 [[Specific mods#Spell|Spell]]
 [[Specific mods#Playable character|Playable character]]
 [[Specific mods#Items|Items]]
 [[Specific mods#Quests and NPCs|Quests and NPCs]]
 [[Specific mods#Dungeons|Dungeons]]
 [[Specific mods#Standalone adventure|Standalone adventure]]
 [[Specific mods#Dynamic events|Dynamic events]]
 [[Specific mods#Auras|Auras]]
 [[Specific mods#Nodes for nodal tool|Nodes for nodal tool]]

@@ Line 1: / Line 1: @@
 ==[[Setup build upload| Setup, build and upload]]==
 ==[[General modding]]==
 ==[[Specific mods]]==

@@ Line 1: / Line 1: @@
 ==[[Setup build upload| Setup, build and upload]]==
-==[[General modding]]
+==[[General modding]]==
 ==[[Specific mods]]==

← Older revision		Revision as of 20:13, 20 December 2018
Line 1:		Line 1:
		+	==[[Setup build upload\| Setup, build and upload]]==

		+	==[[General modding]]

−	==~~Model swap==~~	+	==[[Specific mods]]==
−	~~1. Import your rigged FBX model in your Unity Project.~~
−
−	~~2. Set the rig type to humanoid and ensure that the T-Pose is correctly matched with the humanoid~~
−
−	~~3. Drag and drop the model on the scene~~
−
−	~~4. Scale it correctly using the reference model provided (neutral model) that is the scale of Daryon for reference~~
−
−	~~5. Remove the Animator component, add the component SetCustomAnimationAvatar and put the animation avatar of your character in the~~
−
−	~~avatar slot of the SetCustomAnimationAvatar component~~
−
−	~~6. Choose an unique name for your GameObject and create a prefab in the project from it~~
−
−	~~7. Open the Asset Override Manager located in the "EOE Mods Toolkit -> Asset Override Manager" menu~~
−
−	~~8. Add a new entry and choose the entity that you want to override in the source entry "builtin" dropdown~~
−
−	~~9. In the replacement path enter the unique name of your GameObject that you prefabed~~
−
−	~~(without the path, just the name of the Prefab), then in the Asset Load Method for the replacement choose~~
−
−	~~"Asset Bundles Mod Kit" and finally in the DLC or Mod ID enter the unique mod ID that you put in the Mod Settings Window~~
−
−	~~10. You are now ready to build and test your mod using the procedure described in the "Build Mod Locally" section of the guide~~
−
−	~~==Spell==~~
−
−	~~==Playable character==~~
−
−	~~==Items==~~
−
−	~~==Quests and NPCs==~~
−
−	~~==Dungeons==~~
−
−	~~==Standalone adventure==~~
−
−	~~==Dynamic events==~~
−
−	~~==Auras==~~
−
−	~~==Nodes for nodal tool~~==

← Older revision		Revision as of 20:09, 20 December 2018
Line 1:		Line 1:
−	~~==Basic setup==~~
−	~~1. First you have to download and install Unity 2018.2.x (the version will change as the game will progress further,~~

−	~~we’ll update this guide and notify that we changed the Unity version)~~
−
−	~~https://unity3d.com/get-unity/update~~
−
−
−	~~2. Download the modkit content and modkit samples on GitHub (you can download directly using the clone or download~~
−
−	~~option then download as a zip but it’s highly suggested to use TortoiseGit to be able to quickly upgrade the modkit afterward)~~
−
−	~~https://github.com/zelerj/eoemodworks/~~
−
−
−	~~3. You can now open any of the sample Unity projects included in the modkit content or you can start from the empty~~
−
−	~~project but it’s better at first to start from a sample template.~~
−
−
−	~~4. Install the databank (allow you to reuse objects of the game in custom levels or in levels modifications)(Optional Step)~~
−
−	~~First you need to download and install the databank from the steam workshop here:~~
−
−	~~https://steamcommunity.com/sharedfiles/filedetails/?id=1285627706~~
−
−	~~The databank doesn't appear in the Edge of Eternity Game Folder. So you need to go into your default Steam installation.~~
−
−	Navigate into your workshop content folder: steamapps\workshop\content\269190\1285627706. You need to copy the 4 files inside and past them to the Databank folder you will create at the root of your project (for exemple mine is F:\Logiciel\Edge of eternity modkit\eoemodworks-master\SampleMods\1_Model_Swap\Assets\Databank).
−
−	~~Back in your Unity Project, at the top, select EOE Mods Toolkit -> Import Databank.~~
−
−	~~Press the Import button at the bottom. Now inside of the Databank folder you created, there should be a new eoe folder,~~
−
−	~~with all the necessary prefabs inside. You can use any of these in your mods, and any mod you upload to the workshop will~~
−
−	~~require users to download the Databank workshop item.~~
−
−
−	~~5. Install the levelkit (allow you to see in the editor the actual game levels for precise (Optional Step)~~
−
−	~~placement of elements during level modifications)~~
−
−	~~https://drive.google.com/file/d/1z9kyO33xjoSRw6LtAowpOV7fhS9H--c_/view?usp=sharing~~
−
−	~~Unzip the folder at the root of the Unity project that contains your mod (not in the Assets directory in the parent directory)~~
−	~~===How to setup mod settings===~~
−	~~1. Open the mod settings window by going into the menu "EOE Mods Toolkit -> Mod Settings" on the menu bar ontop of the screen~~
−
−	~~2. Create a unique Mod Identifier for your mod (warning : if two mods share the same Mod Identifier they will not be compatible~~
−
−	~~together, with the Mod Identifier you'll be able to cross-reference mods)~~
−
−	~~3. Fill the mods metadata like the miniature, mod name, mod description, those will be used for the ingame display of the mod~~
−
−	~~(not the workshop), the standalone adventure checkbox allow you to override the beginning of the adventure and set another map~~
−
−	~~as the default map ingame so you can create another adventure from scratch with the Edge Of Eternity Modkit using the rules~~
−
−	~~of the game or you custom ones using the scripting engine (the user will get a choice when trying to start the game he will~~
−
−	~~be able to choose between the normal game or the custom adventures mods)~~
−
−	~~==Building and testing==~~
−	~~1. Open the local mod build window by going into the menu "EOE Mods Toolkit -> Build Mod" on the menu bar ontop of the screen~~
−
−	~~2. Fill the mod directory from your game path on Steam (Steam\steamapps\common\Edge Of Eternity\EdgeOfEternity_Data\StreamingAssets\Mods)~~
−
−	~~3. Ensure that auto-tag assets is checked and click the build button~~
−
−	~~4. Launch your game, the mod is ready to be tested, you'll be able to find it in the mod window of the game~~
−
−	~~(in the main menu click on the mods button)~~
−
−	~~==Uploading to steam==~~
−	~~1. Open the Steam Workshop upload window by going into the menu "EOE Mods Toolkit -> Upload to Steam Workshop" on the menu bar on top of the screen~~
−
−	~~[[File:Modkit_workshop.jpg\|thumb]]~~
−
−	~~2. Fill the metadatas (key image, screenshots, name, description, tags, etc...) and then click create mod (if you are updating an existing one the~~
−
−	~~case will be update mod and if you loose the link to your mod you can reattach it in the manage my workshop section)~~
−
−	~~3. Click upload to the workshop and it will be visible a few minutes afterward in the Steam Workshop (please test your mods locally before uploading them to the workshop)~~

	==Model swap==		==Model swap==

@@ Line 65: / Line 65: @@
 . Open the local mod build window by going into the menu "EOE Mods Toolkit -> Build Mod" on the menu bar ontop of the screen
-. Fill the mod directory from your game path on Steam like in the example screenshots below
+. Fill the mod directory from your game path on Steam (Steam\steamapps\common\Edge Of Eternity\EdgeOfEternity_Data\StreamingAssets\Mods)
 . Ensure that auto-tag assets is checked and click the build button

@@ Line 76: / Line 76: @@
 . Open the Steam Workshop upload window by going into the menu "EOE Mods Toolkit -> Upload to Steam Workshop" on the menu bar on top of the screen
-[[File:Modkituto workshop.jpg|thumb]]
+[[File:Modkit_workshop.jpg|thumb]]
 . Fill the metadatas (key image, screenshots, name, description, tags, etc...) and then click create mod (if you are updating an existing one the

@@ Line 27: / Line 27: @@
 The databank doesn't appear in the Edge of Eternity Game Folder. So you need to go into your default Steam installation.
-Navigate into your workshop content folder: steamapps->workshop->content. You need to locate the correct mod which can be a
+Navigate into your workshop content folder: steamapps\workshop\content\269190\1285627706. You need to copy the 4 files inside and past them to the Databank folder you will create at the root of your project (for exemple mine is F:\Logiciel\Edge of eternity modkit\eoemodworks-master\SampleMods\1_Model_Swap\Assets\Databank).
-bit tricky, but the correct one has 4 files inside with names referencing Databank.
+Back in your Unity Project, at the top, select EOE Mods Toolkit -> Import Databank.
 Press the Import button at the bottom. Now inside of the Databank folder you created, there should be a new eoe folder,

← Older revision		Revision as of 16:04, 20 December 2018
Line 21:		Line 21:
	4. Install the databank (allow you to reuse objects of the game in custom levels or in levels modifications)(Optional Step)		4. Install the databank (allow you to reuse objects of the game in custom levels or in levels modifications)(Optional Step)

−	~~(Link~~ and ~~procedure coming soon)~~	+	First you need to download and install the databank from the steam workshop here:
		+
		+	https://steamcommunity.com/sharedfiles/filedetails/?id=1285627706
		+
		+	The databank doesn't appear in the Edge of Eternity Game Folder. So you need to go into your default Steam installation.
		+
		+	Navigate into your workshop content folder: steamapps->workshop->content. You need to locate the correct mod which can be a
		+
		+	bit tricky, but the correct one has 4 files inside with names referencing Databank.
		+
		+	Back in your Unity Project, in your root Assets Folder, Create a Folder called Databank. Inside of the Databank folder,
		+
		+	drag all four workshop files into this empty folder. Now at the top, select EOE Mods Toolkit -> Import Databank.
		+
		+	Press the Import button at the bottom. Now inside of the Databank folder you created, there should be a new eoe folder,
		+
		+	with all the necessary prefabs inside. You can use any of these in your mods, and any mod you upload to the workshop will
		+
		+	require users to download the Databank workshop item.