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
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:
- World Saves (.ark): SQLite databases containing game objects and world state
- Player Profiles (.arkprofile): Binary files with UE5 property serialization containing player data
- 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
- Issues: GitHub Issues
- Discussions: GitHub Discussions
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ark_asa_parser-0.1.2.tar.gz.
File metadata
- Download URL: ark_asa_parser-0.1.2.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea29efc93d656b15fd18c4504065ca7f9c8b77244cfdbc92b340bf06b717615f
|
|
| MD5 |
f3a32ad4a7f1a99cddd37df45d419cbe
|
|
| BLAKE2b-256 |
9bd96142fa1adc7b4c2ca79a9a695bfe5dd44f477588b15f49179d5a3c819e14
|
File details
Details for the file ark_asa_parser-0.1.2-py3-none-any.whl.
File metadata
- Download URL: ark_asa_parser-0.1.2-py3-none-any.whl
- Upload date:
- Size: 14.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d74f1c0b1bac38e208dcdff700a9fe57db84b4d0987392a0cb37c224276ad995
|
|
| MD5 |
f55c4c629adb1378f639a7fee0a1544b
|
|
| BLAKE2b-256 |
7b2b95f7ba73f893986549ec2d781d79f7cc6696d93b3d5d237de7017d46febc
|