Edge Of Eternity - Eternal Forge Modkit Wiki - User contributions [en]

Setup build upload

2018-12-21T14:00:14Z

194.16.1.10: /* Basic setup */

==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)

Main Page

2018-12-21T13:38:25Z

194.16.1.10: /* Modding guide */

Welcome to the modkit wiki for Edge of Eternity!

=[[Modding guide]]=
[[Setup_build_upload|Setup, build and upload]]

[[General modding]]

[[Specific mods]]

=[[Examples]]=

=[[API description]]=

Setup build upload

2018-12-21T08:57:31Z

194.16.1.10: /* Basic setup */

==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)

General modding

2018-12-21T08:10:02Z

194.16.1.10: /* Basics */

==Scripting basics==
===Basics===
Before you start your Journey on making script mods for Edge of Eternity, you have to understand the limitations that
come with the mod kit framework you are working with. First of all, you should always start from a template project,
which is automatically setup for modding and provide simple examples. These template projects are available from GitHub, the link is in the Official EOE Modding Guide.

Second, only one script can inherit from the IModInterface abstract class. This is because this script acts as an entrance point to all scripting logic in your mod, similar to how the Program class is usually the entrance point in C# projects. The IModInterface has several overridable methods, such as the "OnIngameUpdate" method (similar to Update), which allows you to hook logic to in game events. You can, however, have as many classes in your project as you like. And your entrance point IModInterface script can reference any of these classes.

Another limitation, one that I had trouble with initially, is that scripts attached to GameObjects in Additive scenes will NOT BE CALLED. This limitation is due to the way your mod assembly gets loaded into the game at runtime. But you can always attach a MonoBehaviour derived script to a GameObject.

You can also create a Prefab, and load it Dynamically into the game. But just like with additive scenes, scripts that were attached to the prefab won't be called when an instance is instantiated into the scene.

A temporary limitation, one that the developers hope to fix in the future, is that you can't use DLLs (Dynamically Linked Library) from the Asset Store or from other projects in your mod. All of the code in your mod must be C# Files. Be wary of this when you import Assets from the Unity Asset Store.

And lastly, you cannot create additional resources inside the "Resources" folder. This is because of the way Unity builds packages into asset bundles. It'll only understand Resources that were created from the actual game project, but not through mods that are dynamically loaded into a game. So don't try using "Resources.Load" on resources you created in your mod project. Only use this method on resources from the actual Edge of Eternity game project.

===Editor Scripts===
Just like any Unity Game, you cannot build Editor Scripts. Usually developers will put the Editor scripts in special "Editor" folders. When it's time to build a game, the compiler will ignore any scripts inside of these special folders.

The current EOE modding tools do not automatically do this for the user. So if you include any editor scripts from any assets you download from the Unity Asset Store (you'll see Editor folders in the import preview), you need to manually tell the compiler to not build these scripts.

To do this, all you need to do is open up every Editor script in a text editor, and wrap the whole script in a UnityEditor preprocessor.

//Insert this at the top of the script, above any namespaces
#if UnityEditor
//A simple Editor Script
class SampleEditorClass : UnityEditor.Editor {
//Editor Code
}
//Don't forget to add endif at the end
#endif

===Adding References===
This is a simple fix if you are have issues with default Unity References not being included in your project, such as the TextMeshPro references (TMPro). You most likely will run into these issues if you opened up a template sample project from Kaldorei's EOE modkit github page. If this is the case, you should have a ModScripts.asmdef file at the root of your assets folder. All you need to do is click on it, look at the details in the inspector, and look for References near the top.

Press on the add button, you'll see a new item appear, a missing reference. The right section of this reference is a small circle. Select it, and find the appropriate reference you need (make sure to select the editor references too). For TextMeshPro, you'll need to select two references, "Unity.TextMeshPro" and "Unity.TextMeshPro.Editor". At the bottom of the inspector, press the apply button. The references should now be included in your project, so you shouldn't have issues referencing them now in your scripts.

==Making an additive scene==
This section assumes that you successfully imported the databank and know how to view levels using the Game Scenes Viewer.

If you know how to create a model swap mod, then adding an additive level should be very straight forward. Just like with a model swap, you'll need to head over to the mod settings menu (EOE Mods Toolkit -> Mod Settings), and enter in all the appropriate information. Make sure to remember what your Mod ID is, as you'll need it for your level mod. I'd highly recommend going into the mod override manager and making sure you aren't overriding any assets you don't wish to for this level mod.

Now head on over to EOE Mods Toolkit -> Mod Scene Manager. In the Scene Handling Mode: Make sure Additive is selected (I don't think replace works properly at the moment). Then Press the Plus Button To Add a New Scene.

Source Asset Paths:
Path:
You can choose whatever levels appear from the databank or the default levels database. But for most of the game, the player will be exploring the AstryanContinent. So it would be wise to create a an additive level for this scene. Press the Builtin button, and navigate to Assets -> EOE -> GameMaps -> Chapters -> Chapter I -> AstryanContinent -> AstryanContinent.unity.
Or you can simple copy this file url below:
"Assets/EOE/GameMaps/Chapters/Chapter I/AstryanContinent/AstryanContinent.unity"
Load Method:
Choose Resources
DLC or ModID:
Leave this blank
Replacement Asset Paths:
Path:
Copy the Scene Name You Wish To Add To the Source Scene Additively. This Scene can be anywhere in your project, but make sure it is spelt correctly. Do not use any file suffexes such as ".unity".
Load Method:
Choose Asset Bundles Mod Kit
DLC or ModID:
Copy your ModID you inserted in the mod settings, and paste them into the text field.

After you are all done, make sure to press the save button and exit.

Modding guide

2018-12-20T15:43:58Z

194.16.1.10: /* Uploading */

==Basic setup==

==Building and testing==

==Uploading to steam==

==Model swap==

==Spell==

==Playable character==

==Items==

==Quests and NPCs==

==Dungeons==

==Standalone adventure==

==Dynamic events==

==Auras==

==Nodes for nodal tool==

Main Page

2018-12-20T15:43:48Z

194.16.1.10: /* Modding guide */

Welcome to the modkit wiki for Edge of Eternity!

=[[Modding guide]]=
[[Modding guide#Basic setup|Basic setup]]

[[Modding guide#Building and testing|Building and testing]]

[[Modding guide#Uploading to steam|Uploading to steam]]

[[Modding guide#Model swap|Model swap]]

[[Modding guide#Spell|Spell]]

[[Modding guide#Playable character|Playable character]]

[[Modding guide#Items|Items]]

[[Modding guide#Quests and NPCs|Quests and NPCs]]

[[Modding guide#Dungeons|Dungeons]]

[[Modding guide#Standalone adventure|Standalone adventure]]

[[Modding guide#Dynamic events|Dynamic events]]

[[Modding guide#Auras|Auras]]

[[Modding guide#Nodes for nodal tool|Nodes for nodal tool]]

=[[Examples]]=

=[[API description]]=