Skip to main content

Extract player, tribe, and server data from ARK: Survival Ascended save files

Project description

ARK: Survival Ascended Save Parser

A Python library for extracting player, tribe, and server data from ARK: Survival Ascended save files.

Features

Player Data Extraction

  • Player names (Epic Games account names)
  • Character names (in-game names)
  • Tribe membership
  • Player levels and stats

Tribe Data Extraction

  • Tribe names
  • Tribe owner information
  • Member lists with names and IDs
  • Tribe logs

Server Analytics

  • Player counts across servers
  • Tribe statistics
  • Save file metadata
  • Multi-server cluster support

What's New

Version 0.1.4

  • Bundled Default XP Table - No external JSON required! Library now includes official ASA XP thresholds
  • Enhanced Inventory Parser - Full struct array parsing for item quality, durability, custom names (when inventory present)
  • Simplified API - xp_to_level() now works out-of-the-box without providing XP table

Version 0.1.2 & 0.1.3

  • Optional XP table support to compute level from XP
  • Inventory parsing prototype (names + quantities; prefers CustomItemName)
  • Tribe dino counts (best-effort from common properties)

Installation

pip install ark-asa-parser

Quick Start

from ark_asa_parser import ArkSaveReader
from pathlib import Path

# Initialize reader with path to save directory
save_dir = Path("R:/PhoenixArk/asaserver_island/ShooterGame/Saved/SavedArks/TheIsland_WP")
reader = ArkSaveReader(save_dir)

# Get all players
players = reader.get_all_players()
for player in players:
    print(f"{player.player_name} ({player.character_name})")
    print(f"  Tribe ID: {player.tribe_id}")
    print(f"  Level: {player.level}")

# Get all tribes
tribes = reader.get_all_tribes()
for tribe in tribes:
    print(f"{tribe.tribe_name}")
    print(f"  Owner: {tribe.owner_name}")
    print(f"  Members: {tribe.member_count}")

Scanning Multiple Servers

from ark_asa_parser import scan_all_servers
from pathlib import Path

# Scan entire cluster
cluster_path = Path("R:/PhoenixArk")
servers = scan_all_servers(cluster_path)

for server_name, reader in servers.items():
    print(f"\nServer: {server_name}")
    players = reader.get_all_players()
    tribes = reader.get_all_tribes()
    print(f"  Players: {len(players)}")
    print(f"  Tribes: {len(tribes)}")

File Structure

ARK ASA saves use the following structure:

SavedArks/
├── MapName_WP/                    # Save directory
│   ├── MapName_WP.ark            # World save (SQLite database)
│   ├── <eos_id>.arkprofile       # Player profile files
│   └── <tribe_id>.arktribe       # Tribe data files

Data Classes

PlayerData

@dataclass
class PlayerData:
    eos_id: str              # Epic Online Services ID
    player_name: str         # Epic Games account name
    character_name: str      # In-game character name
    tribe_id: int           # Tribe membership ID
    level: int              # Character level
    experience: float       # Experience points

TribeData

@dataclass
class TribeData:
    tribe_id: int           # Unique tribe ID
    tribe_name: str         # Tribe name
    owner_name: str         # Tribe owner identifier
    member_count: int       # Number of members

Advanced Usage

Get Server Database Info

reader = ArkSaveReader(save_dir)
info = reader.get_database_info()

print(f"Tables: {info['tables']}")
print(f"File size: {info['file_size']} bytes")
print(f"Last modified: {info['file_modified']}")

Read Individual Files

from pathlib import Path

# Read specific player profile
player_file = Path("path/to/player.arkprofile")
player = reader.read_profile_file(player_file)

# Read specific tribe file
tribe_file = Path("path/to/tribe.arktribe")
tribe = reader.read_tribe_file(tribe_file)

How It Works

The library uses a custom binary parser to extract UE5 (Unreal Engine 5) properties from ARK's save files:

  1. World Saves (.ark): SQLite databases containing game objects and world state
  2. Player Profiles (.arkprofile): Binary files with UE5 property serialization containing player data
  3. Tribe Files (.arktribe): Binary files with UE5 property serialization containing tribe information

The parser handles:

  • Length-prefixed strings (ASCII and UTF-16)
  • Various property types (String, Integer, Array)
  • Nested property structures
  • Binary search for efficient property extraction

Requirements

  • Python 3.8+
  • No external dependencies (uses only Python standard library)

Development Status

✅ Implemented

  • Player name extraction
  • Character name extraction
  • Tribe name extraction
  • Tribe member lists
  • Basic player stats (level via field when available, tribe membership, experience parsing)
  • Multi-server scanning

🚧 In Development

  • Full player stats (health, stamina, weight, etc.) groundwork started (Float/Double parsing)
  • Dino data extraction
  • Structure data extraction
  • Inventory parsing (prototype: item names + quantities)
  • Level calculation from experience (experience now parsed; mapping next)

Contributing

Contributions are welcome! This is an open-source project to help the ARK community build tools for server management, analytics, and player tracking.

Areas for Contribution

  • Additional property type parsers (Float, Struct, Object)
  • Dino data extraction
  • Structure/building data
  • Documentation improvements
  • Example scripts and use cases

License

MIT License - See LICENSE file for details

Credits

Developed by BoldPhoenix for the ARK: Survival Ascended community.

Special thanks to the ARK modding community for reverse-engineering documentation.

Support

Example Use Cases

  • Discord bots for server statistics
  • Web dashboards for player tracking
  • Automated backup systems with metadata
  • Player activity monitoring
  • Tribe management tools
  • Server admin utilities

Version History

0.1.1 (Current)

  • Full property extraction implementation
  • Player name and character name support
  • Tribe name and member list support
  • Array property parsing
  • Multi-server cluster scanning

0.1.0

  • Initial release
  • Basic save file reading
  • SQLite database parsing
  • Player and tribe file detection

New in 0.1.2/0.1.3

  • Experience parsing via Float/Double properties; optional level from explicit fields
  • Optional XP table support to compute level from XP
  • Inventory parsing prototype (names + quantities; prefers CustomItemName)
  • Best-effort tribe dino count field when present

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ark_asa_parser-0.1.4.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ark_asa_parser-0.1.4-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file ark_asa_parser-0.1.4.tar.gz.

File metadata

  • Download URL: ark_asa_parser-0.1.4.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for ark_asa_parser-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f4655c53765c9deed7e1ec22a9de32ddb638733fd36532702e3bc0e3518d85f8
MD5 3b46069b3d7796c47111d61c77fc445b
BLAKE2b-256 721b85ef8f71718a5540ff24ab87a51dfce9469e4e53a64dfed551adf56fdb34

See more details on using hashes here.

File details

Details for the file ark_asa_parser-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ark_asa_parser-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for ark_asa_parser-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 51987c243d48c5044a1c8abcbc77ba77b24283f24ba2af890069fef83fbd3978
MD5 c8757ecd4a70b5063dd89a4169348859
BLAKE2b-256 d5953b56702d7b421514ad7d597f76870a6bfa4d130eacebf3cc63bcadfc25ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page