Welcome to ArkFrame

An “ARK: Survival Evolved” DevKit extension framework

ArkFrame is an extension to the functionality built into the ARK Developer Kit. Sort of a library... framework... kind of system. The ArkFrame source files act like having header files and the ArkFrame Workshop mod acts like a DLL.

The Purpose of ArkFrame is to give a common communication point and additional functionality for developers while providing user friendly integration for players.

In this documentation both developers and players should be able to find the information they need to make the most of the system.

The latest build of the ArkFrame workshop mod can be found at: http://steamcommunity.com/sharedfiles/filedetails/?id=1110051106

The ArkFrame source files can be at: https://git.arkframe.com/ArkFrameDev/ArkFrame

And the Discord group where notifications of updates and community discussion is most like to occur can be joined with this link: https://discord.gg/m2HcFNH

For Developers:

• Getting Started
  • Obtaining the ARK DevKit
  • Obtaining the source files for ArkFrame
  • Setting up a new ArkFrame project
  • Working with the ArkFrame_ModData_BP
    • ModName
    • ModID
    • ModDescription
    • bIsLiveEventTracingEnabled
    • ConfigSaveClass
    • ClassRegistry
    • ResourceClassDefinitions
    • AddItemToInventory
    • AdditionalHarvestResources
    • AdditionalMobDrops
    • KeybindDefinitions
    • LogicExpansions
• Event Tracing and Debugging
  • Creating an event
  • Enabling Event Tracing
  • Viewing the Event Logs
• Remappable Keybinds
  • Summary
  • Setting up a new keybind
    • Keybind Action String
    • Preferred Keybind
      • PrimaryKey
      • Modifier bools
  • Graph Events
    • Event Keybind Pressed
    • Event Recieved Player Command
• Mod Configs
  • Setting up a new mod config
    • Declaring displayable settings
    • Declaring persistant variables
    • Exposing variables to ArkFrame
  • Accessing the mod config
  • Saving mod config values
• Logic Expansion System
  • Creating a Logic Expansion
  • Graph Events
  • MultiUse Support
• License