- 1 GENERAL
- 1.1 How do I get the ARK Devkit?
- 1.2 How do I move the Editor to a new folder/drive?
- 1.3 How do I apply the Devkit "beta" update releases(Google Drive Content Diff)?
- 1.4 How do I test my mod?
- 1.5 What files do I need for a mod?
- 1.6 How do I import the source files for a mod(tutorial, project take-over, etc.)?
- 2 SCRIPTING
- 3 MAPPING
How do I get the ARK Devkit?
The only way for the initial download of the ARK Devkit is through the Epic Games Launcher. If you see the ARK Dev Kit on Steam, do NOT download that version that, it is severely outdated and unusable!
After the initial download, you can either keep it up to date through the Epic Games Launcher or manually through Github and content diff download.
- Epic Games Launcher
- + You are able to verify your devkit files in case you messed something up(much like verifying a game's files on steam).
- + Easy to use
- - Every update requires you to have as much free disk space as a full install, this is only to start the download of the update regardless of the updates actual size. This can be impossible if you have limited disk space available.
- - Updates usually take some time to arrive on the Epic Games Launcher.
- Manual Updates
- + Gets around the free disk space problem of the Epic Games Launcher.
- + Updates are available immediately.
- - No verification of the files.
How do I move the Editor to a new folder/drive?
The Launcher lacks the ability to do this natively, but it can be done still either by "tricking" it or moving it and forcing it to verify the existing files. The simplest route is using a directory junction(aka Symbolic Link) pointing from the old location to the new location.
Using a Symbolic Link
To do this make sure you've exited the launcher, then navigate to the folder that contains the Editor installation(for example C:\Program Files\Epic Games\) and you will want to either copy then delete, or just outright move the ARKDevKit folder to your desired location.
Once this is done, you will need to open Command Prompt as Admin(really just to prevent folder permission errors) and use the MKLINK command. The syntax of the command is important here, using the aforementioned path as an example, the command will look as follows(adapt to your specifics):
MKLINK /J "C:\Program Files\Epic Games\ARKDevKit" "H:\ARKDevKit"
If the link was successful, you will get a message stating as much and you're done. You can verify this by running the Epic Launcher and launching the Editor.
- The MKLINK command syntax requires arguments or switches first(the /J(Junction) switch) then it requires the link target - this is to be the folder that points to another location, after which comes the source target - this is the folder the link will point to.
- This method is the simplest, requires no extra space, has some minor risk from incorrect command usage and day-to-day caveats but they're unlikely to be encountered in normal usage.
Change the actual Installation
If you would rather just prefer to move the folder to a new location and have it register then you can do the following.
Before proceeding, you should - and actually must - back up your DevKit installation first. So wherever it is installed(eg: C:\Program Files\Epic Games\), you need to copy that elsewhere so you will need a decent chunk of free space to do this.
After you've backed it up, uninstall the Editor from within the Launcher, when it is done I would recommend restarting your machine to be safe. When ready, install the Editor again at your desired location, let it go through the process of starting the download, preferably until it hits at least 1% to be safe.
Once this happens, pause the install/download and kill the launcher in Task Manager, then either move or copy and paste the Editor backup to the new install location you chose when re-installing the Editor, start the launcher when it's done copying and let the launcher proceed to install - it may look like it's going to continue installing but it should eventually switch to Verifying.
- This has the chance to not work correctly and carries the highest risk, that is why it is recommended to copy instead of move files. This however necessitates many hundreds of gigabytes of free space to carry out the method, by way of copying the Editor twice, without the risk of being forced to completely redownload the Editor.
- If you've reformatted onto a new drive, or have recently reinstalled the launcher for one reason or another and want to reconnect the Editor to the launcher, you can perform the same process as above for moving it, just start at the new install point for the launcher and proceed from there.
How do I apply the Devkit "beta" update releases(Google Drive Content Diff)?
Such updates are provided first through a Google-drive hosted content diff archive and will be announced on the ARK Modding discord by Staff or an otherwise permitted User once the update has been vetted to be free of crash-inducing bugs. Once the update has been pushed to the Epic Launcher, the Google Drive link will be removed from the Unreal Engine forum thread.
To download the Content-Diff, click the provided drive.google.com link, either in the announcement or dedicated Unreal Engine forum thread link(one or the other will be provided), and follow the prompts to download the archive. Warning: The size of this archive can range wildly in size, anywhere from 1GB or upwards of 10GB's.
Once you have the Content diff, extract the archive over the root folder of your DevKit install (see image). When you extract, overwrite all files found in your install directory when prompted, then when complete you may launch the DevKit with the .bat file called ARKDevKit.bat and continue as normal.
NOTE: The launch .bat is required because once you update manually, and once the update makes its way to the Launcher, the only option available to you in the Launcher will be Update, you will not be able to launch it from there until you have updated via the launcher also.
How do I test my mod?
There are two ways you can do this. The first is to upload the mod to a second workshop entry - a process which will be detailed at a later date, and the second is to use the Test Mod Output Directory field. This is the one detailed below.
When you populate this field it's easier to use ...\Mods in your ARK install, when you then start the Cook, the Editor will compile a Windows-only version of the mod much faster than a full cook(it will also include extraneous files but these can be ignored for the time being). This, in turn, will create a file called 123456789.mod and a folder of the same name containing two "meta" data/info files. It will also create a folder that has the same name as the folder containing your Mod in the Editor - so for a folder in your Editor called MyMod, there will be a folder of the same name in the directory you chose to cook too. The actual files for the mod are found here and must be moved into the aforementioned 123456789 folder. If you wish to test on a server, then you must copy/upload the 123456789.mod and 123456789 folder to the server' ...\Mods folder as well.
NOTE: You must not have this field populated before cooking your mod if you wish to upload it. If you have cooked your mod with this field filled, clear it, and cook again before attempting to upload.
What files do I need for a mod?
The minimal setup for a mod is:
- PrimalGameData: - Create a child of PrimalGameDataBP
- Level: - Create a new blank level file in your mod folder
Open the level file(you will see a black screen, don't worry) and select the "World Settings" tab. If you don't have the tab up go to "Window" in the main menu bar and tick "World Settings". In the "World Settings" panel, look for the "PrimalGameData Override" and set it to the PrimalGameData in your mod folder. To get back to the TestMap, go to the Maps folder in the content browser and open it again, or go to File > Open Level... and find the TestMap in the same place.
How do I import the source files for a mod(tutorial, project take-over, etc.)?
To import the source files of a mod - remember that you cannot import the cooked/compiled files for a mod - either copy the root/base folder for the mod, or extract the root/base folder if the mod was sourced via an archive of some form(.7z, .zip, .rar, etc.), to the ...\Mods\ folder of your DevKit install with the DevKit closed. For example, I would extract the root folder of a mod' source files to "I:\ARKDevKit\Projects\ShooterGame\Content\Mods\...".
NOTE: Do NOT change any file or folder names as doing so will cause the files to lose their inheritance and reference paths when you load the DevKit next potentially making the mod unusable to you if you're unaware of what you're doing until you delete and re-do the copy/extraction process.
How do I get a "Cast" node?
You need to drag from a blue/purple pin and have the "Context sensitive" checkbox ticked to get the cast to options to show up.
Why do I only see an ocean when I load up TheIsland?
By default, the editor only loads the TheIsland persistent level to save resources. You need to load the sublevels you want to see/edit through the "Levels" tab. If you don't see the "Levels" tab go to "Window" in the main menu bar and tick "Levels". That should bring up the tab. You can then load the required sublevels by double-clicking on the name.