Installation

pip install arkgamepy

---

Getting Started

This section will help you get started using arkpy, by walking through some of the features provided by the library in a series of examples. If you're looking for API specific documentation check out the API Docs section.

Reading an .arkprofile File

Start by importing the ark module from the arkpy package

>>> from arkpy import ark

Now let's try reading .arkprofile file stored in our SavedArksLocal directory

>>> file_path = 'data/SavedArksLocal/LocalPlayer.arkprofile'
>>> profile = ark.ArkProfile(file_path)
>>> print profile
# <arkpy.ark.ArkProfile instance at 0x7f19767893f8>

Now that we've got an instance of ArkProfile we can start accessing some of the data, like the Character information.

>>> print 'Name: %s' % profile.character.name.value
# Name: Woobles
>>> print 'Level: %s' % (profile.character.level_ups.value + 1)
# Level: 1
>>> print 'Sex: %s' % ('Female' if profile.character.isFemale.value else 'Male')
# Sex: Male

You'll see when we accessed the data belonging to character.name we did so with the .value property. This is because all the data parsed from the ark files are parsed as wrappers around the Data Types rather than the python Data Types themselves. These data-types are found in the arktypes module

If we were to just print character.name itself we'd get the following.

>>> print profile.character.name
# <StrProperty> Woobles

---

Editing an .arkprofile file

When we want to change the data, we can do so with the .set() method instead of .value.

>>> profile.character.name.set('Spartacus')
>>> print 'I am %s!' % profile.character.name.value
# I am Spartacus!

Let's try leveling our character up.

>>> profile.character.level_ups.set(9)
>>> profile.character.experience.set(450)
>>> print 'Level: %s' % (profile.character.level_ups.value + 1)
# Level: 10

What good is leveling up if you don't spend any stat points?

>>> print profile.character.stat_points
# [<ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0,
#  <ByteProperty> 0]

What is that? Well, those are all of our stats, currently at 0. You can set these stats by index if you know which stat corresponds to which index.

>>> profile.character.stat_points[0].set(9)
>>> print profile.character.stat_points[0]
# <ByteProperty> 9

---

Using Enums for Index-Based Values

If you don't know the index for the value you wish to manipulate, then you can use the Enums provided by Arkpy. Let's go back to the stat point example and use the StatMap Enum instead.

>>> from arkpy.ark import StatMap
>>> profile.character.stat_points[StatMap.Health].set(5)
>>> profile.character.stat_points[StatMap.Weight].set(4)

You can also enumerate through the stats and display their values using the StatMap Enum:

>>> stats = profile.character.stat_points
>>> for stat in StatMap:
>>>     print '%s: %s' % (stat.name, stats[stat].value)
# Health: 5
# Stamina: 0
# Oxygen: 0
# Food: 0
# Water: 0
# Weight: 4
# Melee_Damage: 0
# Movement_Speed: 0
# Fortitude: 0
# Crafting_Speed: 0

Maybe our character needs an engram or two now that he's leveled up.

>>> from arkpy import arktypes
>>> campfire_path = 'BlueprintGeneratedClass /Game/PrimalEarth/CoreBlueprints/Items/Structures/Misc/PrimalItemStructure_Campfire.PrimalItemStructure_Campfire_C'
>>> campfire = ark.arktypes.ObjectProperty(campfire_path)
>>> profile.character.engrams.value.append(campfire)
>>> print profile.character.engrams

---

Using the Entities Module

Because the engrams property on the character is an ArrayProperty[ObjectProperty] there's a lot of text that goes in to adding just a single engram. Especially important is the Entity Path for the engram. An easier way to do this is to use the Enums in the entities module.

Let's redo the previous example and add the campfire engram to the character's learned engrams using the Structure Entities Enum.

from arkpy import arktypes, entities
campfire = arktypes.ObjectProperty(entities.Structure.Campfire.value)
profile.character.engrams.value.append(campfire)

---

Saving a Character

Once we've completed all of our changes we can save the profile to an .arkprofile file by calling the save_to_file() method.

# Recommended: don't overwrite the files you read in without backing them
# up as you may corrupt them in the process.
profile.save_to_file('data/SavedArksLocal/LocalPlayer.edit.arkprofile')

---

Loading the Generated Character File

First, let's take a look at how Ark loads game files into memory.

---

Ark Loading Process

1. Loads the world save, .ark file
2. Looks for a file named LocalPlayer.arkprofile, if not found, uses any other .arkprofile file it can find.
3. Copys contents of LocalPlayer.arkprofile into the .profilebak file.
4. On exit or world save, the the data is saved into the appropriate files.

Now, in the appropriate directory, simply rename the old LocalPlayer.arkprofile (or steamid.arkprofile) to something like LocalPlayer.old.arkprofile. You can rename it whatever you like; I like using .old and even .old-MO-DD-YY-TIME to differentiate between them. Once the old .arkprofile file is renamed, add in the generated file to this directory and rename it to LocalPlayer.arkprofile (or steamid.arkprofile if on a server). Boot up the game.

---

More

If you'd like to see more, you've got two options. You can read the API Documentation to learn what methods and properties are available to you. Or, you can head on over to the Tutorials to see much longer and complete examples using Arkpy.

If there's anything that is confusing and you think could be explained better, please leave an issue on Github labeled docs.