Getting Started (ENG) - KCreator/Earth-Defence-Force-Documentation GitHub Wiki

Links

Basic Setup (New Method)
Basic setup (Old Method)
Tutorials

New Method

Basic setup

Install BlueAmulet's EDF5 ModLoader

How to:

1. Go to the "releases" page of EDFModloader

2. Download the "EDFModLoader.zip" and the "PluginX.zip" for your version of EDF

3. Open both ZIPs

4. Open your game's download directory, if you're using steam you can find by right clicking your game and going into "Properties", then "local files" and "Browse..."

5. Copy both folders' contents into your EDF directory

  1. You're done! Good job!

To install mods just move the files from the mod's folder into your "Mods" folder.

Recognizing which mods go where.

Is the mod you downloaded missing a Readme.txt file?
Are the folders not organized?
Here's how to recognize where to put each mod:

1. Does it come in a folder?

If the files come in a neat package like this
Well formatted mod.
then you don't have much to worry about,
the readme.txt should have information on where to put the files.
In this specific case, you just drag both folders into the Mods/ folder.

2. What does the mod replace?

An easy way to see where a mod will go, is by looking at what it replaces.
If it's a weapon, it will go under Mods/Weapon/
If it's a vehicle, it will go under Mods/Object/
If it's a texture, it will go under Mods/Object/
If it's a weapon texture, it will go under Mods/Weapon/
If it's a part of the menus, it will go under Mods/HUD/ or Mods/Menu/

Old Method

Before starting

To start modding EDF, it is recommended you have the following:

Step 1

Open the game's directory, for example:

C:/Program Files/Steam/Steamapps/Common/EARTH DEFENSE FORCE 5

Inside you should see the following:

SOUND
Chunk01.cpk
DX11.cpk
EDF5.exe
Root.cpk
sdkencryptedappticket64.dll
steam_api64.dll
umbra_sandlot.dll

Create a new folder, ideally called "Mods" so the directory looks like:

SOUND
Mods
Chunk01.cpk
DX11.cpk
EDF5.exe
Root.cpk
sdkencryptedappticket64.dll
steam_api64.dll
umbra_sandlot.dll

Copy Root.cpk into a folder elsewhere, and run a cpk extractor of your choice on it. We are interested in the file: "DEFAULTPACKAGE/Config.sgo". Copy that to your Mods folder and use SGOTT on that file to generate a json, we will be editing this later.

Recommended CPK Extractors:

YACpkTool: Cabable of extracting the entire archive, has no UI
CriPakTools: Has a UI

Step 2

Open EDF5.exe in a hex editor. We are looking for the unicode string "app:/DEFAULTPACKAGE/Config.sgo". Be absolutely sure your hex editor is set to override mode, and replace that string with "./Mods/Config.sgo". Fill in the rest of the string with '00' bytes. This will force the game to load the local copy you made in the Mods/ folder.

After this step, you should have something like this:

From here, you can edit this file to swap several SGO references to local copies in the Mods folder, including the weaponlist and weapontext files. Further documentation will be provided on this wiki.

Step 3:

Open the json (config.json) created in step 1. TODO: Finish documentation on loading custom weapon lists