arkparse 0.0.1__tar.gz

arkparse-0.0.1/.gitignore

@@ -0,0 +1,173 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+test.py
+out/*
+*.json
+*.bin
+*.arkprofile
+*.ark
+/*.arkprofile
+/*.ark
+test_saves/*
+temp

arkparse-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 VincentHenauGithub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

arkparse-0.0.1/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: arkparse
+Version: 0.0.1
+Summary: A package to parse and modify ark save files
+Project-URL: Homepage, https://github.com/VincentHenauGithub/ark-save-parser
+Author-email: Vincent Heneau <vincent.henau.github@gmail.com>
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# ArkParse: A Python Library for Reading and Modifying ARK Save Files
+
+**ArkParse** is a Python library designed for **ARK: Survival Ascended** players, server administrators, and modders. This library enables you to read, analyze, and modify ARK save files with an intuitive API. With ArkParse, you can access detailed information about players, structures, equipment, dinosaurs, and more, enabling powerful tools for automation, analysis, and customization.
+
+## Introduction
+Hi everyone,
+
+I originally created this package to manage a private ARK server I started with a few friends. What began as a small project quickly grew into something much bigger than I expected!
+
+The foundation for this work was built on the awesome efforts of [Kakoen](https://github.com/Kakoen) and their contributors, whose Java-based save file property parsing tools were a fantastic starting point. You can check out their work here: [Kakoen's ark-sa-save-tools](https://github.com/Kakoen/ark-sa-save-tools). However, since I'm more comfortable with Python, I decided to start my own package and expand on it significantly.
+
+The package has grown to a pretty expansive set of tools that can be used to retrieve nearly everything in the save files, in a simple object oriented way.
+
+I mainly use this package for server management tasks. Some highlights include:
+
+ - Automatically changing server passwords to control when players can log in.
+ - A voting system to reveal dino and base locations.
+ - Sending random stats of the server to the chat
+ - Monitoring player activity like when people log off and on and such
+ - Randomly spawning bases with random loot for my friends to raid; probably my favorite feature (and the most complicated)
+If you're curious or want to explore the features yourself, you can find the project here: [ark-server-manager](https://github.com/VincentHenauGithub/ark-server-manager).
+
+Hope you find it useful or inspiring or both! 😊
+
+## Disclaimer
+I'm not a professional Python programmer, so if you come across anything that could be done better, please bear with me, or, feel free to contribute! 😉
+
+Secondly, the package is not fully complete, with some elements missing, such as blueprints in the Classes section, formulas for calculating coordinates for other maps than Abberation, and more. However, I hope the package is designed in a way that makes it relatively easy for you to add your own needs to it.
+
+Last, I've never made an open source package like this so if I'm doing something wrong or don't know some general rules of thumb, feel free to tell me!
+I just hope it's usefull for someone!
+
+---
+## Features
+
+- **Player API**: Retrieve player and tribe data, including inventory details.
+- **Structure API**: Analyze and filter structures by location, owner, and other criteria, create heatmaps and more...
+- **Equipment API**: Explore equipment, armor, and saddles. Retrieve blueprints or create and insert custom items.
+- **Dino API**: Analyze dino data, generate heatmaps, find specific dinos, or track stats like mutations and levels.
+- **Base API**: Export and import entire bases for custom scenarios.
+- **Stackable API**: Simple API for parsing basic resources, ammo, structure items and such...
+- **General Tools**: Create custom save file content or perform bulk modifications.
+
+---
+## Installation
+
+Install via pip (not yet):
+
+```bash
+pip install arkparse
+```
+
+Or install locally on your PC so you can add modifications
+First clone the repo and then run the following in repo directory:
+```bash
+pip install -e .
+```
+---
+
+### 4. **Quickstart**
+
+There are quite a few examples under the examples folder, organized by api. These should help you on your way for most of the package functionalities, some of them are listed below already.
+
+#### a. **Player API: Retrieve Player and Inventory Information**
+
+```markdown
+### Player API: Retrieve Player and Inventory Information
+
+```python
+from arkparse import AsaSave
+from arkparse.enums import ArkMap
+from arkparse.ftp.ark_ftp_client import ArkFtpClient
+from arkparse.api.player_api import PlayerApi
+from arkparse.object_model.misc.inventory import Inventory
+
+player_api = PlayerApi('../../ftp_config.json', ArkMap.ABERRATION)
+save = AsaSave(contents=ArkFtpClient.from_config('../../ftp_config.json', ArkMap.ABERRATION).download_save_file())
+
+for player in player_api.players:
+    inventory: Inventory = player_api.get_player_inventory(player, save)
+    print(player)
+    print(f"{player.name}'s inventory:")
+    print(inventory)
+    print("\n")
+```
+---
+
+#### b. **Structure API: Analyze Structures and Generate Heatmaps**
+
+```markdown
+### Structure API: Analyze Structures and Generate Heatmaps
+
+Retrieve and filter structures by owner, location, or type. Generate heatmaps for visualization and analysis.
+### Equipment API: Manage Equipment and Blueprints
+
+```python
+from pathlib import Path
+from uuid import UUID
+from typing import Dict
+
+from arkparse.object_model.equipment.weapon import Weapon
+from arkparse.saves.asa_save import AsaSave
+from arkparse.ftp.ark_ftp_client import ArkFtpClient, ArkMap
+from arkparse.api.equipment_api import EquipmentApi
+from arkparse.classes.equipment import Weapons
+
+# Retrieve save file
+save_path = ArkFtpClient.from_config(Path("../../ftp_config.json"), ArkMap.ABERRATION).download_save_file(Path.cwd())
+save = AsaSave(save_path)
+
+equipment_api = EquipmentApi(save)
+
+# Get all longneck blueprints
+weapons: Dict[UUID, Weapon] = equipment_api.get_filtered(
+    EquipmentApi.Classes.WEAPON,
+    classes=[Weapons.advanced.longneck],
+    only_blueprints=True
+)
+
+highest_dmg_bp = max(weapons.values(), key=lambda x: x.damage)
+print(f"Highest damage on longneck bp: {highest_dmg_bp.damage}")
+```
+
+---
+
+#### d. **Dino API: Analyze and Find Dinosaurs**
+
+```markdown
+### Dino API: Analyze and Find Dinosaurs
+
+```python
+from pathlib import Path
+
+from arkparse.api.dino_api import DinoApi
+from arkparse.enums import ArkMap
+from arkparse.saves.asa_save import AsaSave
+from arkparse.object_model.dinos.tamed_dino import TamedDino
+
+save_path = Path.cwd() / "Aberration_WP.ark"  # Replace with path to your save file
+save = AsaSave(save_path)
+dino_api = DinoApi(save)
+
+dinos = dino_api.get_all_tamed()
+
+if dinos is None:
+    print("No tamed dinos found")
+    exit()
+
+most_mutations: TamedDino = None
+for dino in dinos.values():
+    dino: TamedDino = dino
+    curr = 0 if most_mutations is None else most_mutations.stats.get_total_mutations()
+    if most_mutations is None or (dino.stats.get_total_mutations() > curr):
+        most_mutations = dino
+
+print(f"The dino with the most mutations is a {most_mutations.get_short_name()} with {int(most_mutations.stats.get_total_mutations())} mutations")
+print(f"Location: {most_mutations.location.as_map_coords(ArkMap.ABERRATION)}")
+print(f"Level: {most_mutations.stats.current_level}")
+print(f"Owner: {most_mutations.owner}")
+```
+## Contributing
+
+I welcome contributions! If you have updates to this library that you would like to share, feel free!
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+## Feedback & Support
+
+- **Issues or Feature Requests**: Open an issue on the repo!
+- **Help**: If you need help for something specific, you can always messageme, I will try to help you out
+
+## Donation
+
+If you really really love this package you can [donate here](https://www.paypal.com/donate/?hosted_button_id=BV63CTDUW7PKQ)
+There is no need, but I also won't say no 😊
+
+

arkparse-0.0.1/README.md

@@ -0,0 +1,182 @@
+# ArkParse: A Python Library for Reading and Modifying ARK Save Files
+
+**ArkParse** is a Python library designed for **ARK: Survival Ascended** players, server administrators, and modders. This library enables you to read, analyze, and modify ARK save files with an intuitive API. With ArkParse, you can access detailed information about players, structures, equipment, dinosaurs, and more, enabling powerful tools for automation, analysis, and customization.
+
+## Introduction
+Hi everyone,
+
+I originally created this package to manage a private ARK server I started with a few friends. What began as a small project quickly grew into something much bigger than I expected!
+
+The foundation for this work was built on the awesome efforts of [Kakoen](https://github.com/Kakoen) and their contributors, whose Java-based save file property parsing tools were a fantastic starting point. You can check out their work here: [Kakoen's ark-sa-save-tools](https://github.com/Kakoen/ark-sa-save-tools). However, since I'm more comfortable with Python, I decided to start my own package and expand on it significantly.
+
+The package has grown to a pretty expansive set of tools that can be used to retrieve nearly everything in the save files, in a simple object oriented way.
+
+I mainly use this package for server management tasks. Some highlights include:
+
+ - Automatically changing server passwords to control when players can log in.
+ - A voting system to reveal dino and base locations.
+ - Sending random stats of the server to the chat
+ - Monitoring player activity like when people log off and on and such
+ - Randomly spawning bases with random loot for my friends to raid; probably my favorite feature (and the most complicated)
+If you're curious or want to explore the features yourself, you can find the project here: [ark-server-manager](https://github.com/VincentHenauGithub/ark-server-manager).
+
+Hope you find it useful or inspiring or both! 😊
+
+## Disclaimer
+I'm not a professional Python programmer, so if you come across anything that could be done better, please bear with me, or, feel free to contribute! 😉
+
+Secondly, the package is not fully complete, with some elements missing, such as blueprints in the Classes section, formulas for calculating coordinates for other maps than Abberation, and more. However, I hope the package is designed in a way that makes it relatively easy for you to add your own needs to it.
+
+Last, I've never made an open source package like this so if I'm doing something wrong or don't know some general rules of thumb, feel free to tell me!
+I just hope it's usefull for someone!
+
+---
+## Features
+
+- **Player API**: Retrieve player and tribe data, including inventory details.
+- **Structure API**: Analyze and filter structures by location, owner, and other criteria, create heatmaps and more...
+- **Equipment API**: Explore equipment, armor, and saddles. Retrieve blueprints or create and insert custom items.
+- **Dino API**: Analyze dino data, generate heatmaps, find specific dinos, or track stats like mutations and levels.
+- **Base API**: Export and import entire bases for custom scenarios.
+- **Stackable API**: Simple API for parsing basic resources, ammo, structure items and such...
+- **General Tools**: Create custom save file content or perform bulk modifications.
+
+---
+## Installation
+
+Install via pip (not yet):
+
+```bash
+pip install arkparse
+```
+
+Or install locally on your PC so you can add modifications
+First clone the repo and then run the following in repo directory:
+```bash
+pip install -e .
+```
+---
+
+### 4. **Quickstart**
+
+There are quite a few examples under the examples folder, organized by api. These should help you on your way for most of the package functionalities, some of them are listed below already.
+
+#### a. **Player API: Retrieve Player and Inventory Information**
+
+```markdown
+### Player API: Retrieve Player and Inventory Information
+
+```python
+from arkparse import AsaSave
+from arkparse.enums import ArkMap
+from arkparse.ftp.ark_ftp_client import ArkFtpClient
+from arkparse.api.player_api import PlayerApi
+from arkparse.object_model.misc.inventory import Inventory
+
+player_api = PlayerApi('../../ftp_config.json', ArkMap.ABERRATION)
+save = AsaSave(contents=ArkFtpClient.from_config('../../ftp_config.json', ArkMap.ABERRATION).download_save_file())
+
+for player in player_api.players:
+    inventory: Inventory = player_api.get_player_inventory(player, save)
+    print(player)
+    print(f"{player.name}'s inventory:")
+    print(inventory)
+    print("\n")
+```
+---
+
+#### b. **Structure API: Analyze Structures and Generate Heatmaps**
+
+```markdown
+### Structure API: Analyze Structures and Generate Heatmaps
+
+Retrieve and filter structures by owner, location, or type. Generate heatmaps for visualization and analysis.
+### Equipment API: Manage Equipment and Blueprints
+
+```python
+from pathlib import Path
+from uuid import UUID
+from typing import Dict
+
+from arkparse.object_model.equipment.weapon import Weapon
+from arkparse.saves.asa_save import AsaSave
+from arkparse.ftp.ark_ftp_client import ArkFtpClient, ArkMap
+from arkparse.api.equipment_api import EquipmentApi
+from arkparse.classes.equipment import Weapons
+
+# Retrieve save file
+save_path = ArkFtpClient.from_config(Path("../../ftp_config.json"), ArkMap.ABERRATION).download_save_file(Path.cwd())
+save = AsaSave(save_path)
+
+equipment_api = EquipmentApi(save)
+
+# Get all longneck blueprints
+weapons: Dict[UUID, Weapon] = equipment_api.get_filtered(
+    EquipmentApi.Classes.WEAPON,
+    classes=[Weapons.advanced.longneck],
+    only_blueprints=True
+)
+
+highest_dmg_bp = max(weapons.values(), key=lambda x: x.damage)
+print(f"Highest damage on longneck bp: {highest_dmg_bp.damage}")
+```
+
+---
+
+#### d. **Dino API: Analyze and Find Dinosaurs**
+
+```markdown
+### Dino API: Analyze and Find Dinosaurs
+
+```python
+from pathlib import Path
+
+from arkparse.api.dino_api import DinoApi
+from arkparse.enums import ArkMap
+from arkparse.saves.asa_save import AsaSave
+from arkparse.object_model.dinos.tamed_dino import TamedDino
+
+save_path = Path.cwd() / "Aberration_WP.ark"  # Replace with path to your save file
+save = AsaSave(save_path)
+dino_api = DinoApi(save)
+
+dinos = dino_api.get_all_tamed()
+
+if dinos is None:
+    print("No tamed dinos found")
+    exit()
+
+most_mutations: TamedDino = None
+for dino in dinos.values():
+    dino: TamedDino = dino
+    curr = 0 if most_mutations is None else most_mutations.stats.get_total_mutations()
+    if most_mutations is None or (dino.stats.get_total_mutations() > curr):
+        most_mutations = dino
+
+print(f"The dino with the most mutations is a {most_mutations.get_short_name()} with {int(most_mutations.stats.get_total_mutations())} mutations")
+print(f"Location: {most_mutations.location.as_map_coords(ArkMap.ABERRATION)}")
+print(f"Level: {most_mutations.stats.current_level}")
+print(f"Owner: {most_mutations.owner}")
+```
+## Contributing
+
+I welcome contributions! If you have updates to this library that you would like to share, feel free!
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+## Feedback & Support
+
+- **Issues or Feature Requests**: Open an issue on the repo!
+- **Help**: If you need help for something specific, you can always messageme, I will try to help you out
+
+## Donation
+
+If you really really love this package you can [donate here](https://www.paypal.com/donate/?hosted_button_id=BV63CTDUW7PKQ)
+There is no need, but I also won't say no 😊
+
+

arkparse-0.0.1/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "arkparse"
+version = "0.0.1"
+dependencies = [
+    # List your dependencies here
+]
+authors = [
+  { name = "Vincent Heneau", email = "vincent.henau.github@gmail.com" },
+]
+description = "A package to parse and modify ark save files"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    # Add additional classifiers as needed
+]
+
+[project.urls]
+Homepage = "https://github.com/VincentHenauGithub/ark-save-parser"
+
+[tool.hatch.build]
+include = [
+    "src/arkparse/assets/**",  # Include all assets
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/arkparse"]