README.md

autoangel - open-source C++ library (with lua and Python bindings) that simplifies working with various Angelica3D file formats. Now it supports only elements.data (using sELedit config files) and *.pck packages.

---

Warning - API is unstable, because library is under development.

---

Dependencies & Requirements

• C++14 compiler (tested on gcc-4.9.2, gcc-5, gcc-7, VS 2017+).
• Conan
• Python
• CMake 3.1+

Build

## download
cd /folder/with/your/projects
git clone https://github.com/Smertig/autoangel
cd autoangel

## configure
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..

## build
# lua module
cmake --build . --config Release --target lua_autoangel

# python module
cmake --build . --config Release --target py_autoangel

Usage

Python

Examples

Load elements.data:

# Import library
from autoangel import *

# Open and load elements.data
edata = elements.data('/path/to/elements.data')
conf = elements.load_cfgs('/path/to/configs/folder')
edata.load(conf)

# Get some info
print('elements.data version is', edata.version)
print([e.Name for e in edata[1]])

Output:

elements.data version is 12
['Мечи', 'Копья', 'Топоры/Молоты', 'Дальнобойные', 'Каст.', 'Бич', 'Инструменты мистика']

Read pck package

from autoangel import *
surf = pck.package('/path/to/surfaces.pck')
surf.load()
for path in surf.find_prefix('surfaces/iconset'):
    print('{} -> {} bytes'.format(path, len(surf.read(path))))

Output:

surfaces\iconset\iconlist_action.dds -> 32896 bytes
surfaces\iconset\iconlist_action.txt -> 565 bytes
surfaces\iconset\iconlist_faction.dds -> 8320 bytes
surfaces\iconset\iconlist_faction.txt -> 954 bytes
surfaces\iconset\iconlist_guild.dds -> 2097280 bytes
surfaces\iconset\iconlist_guild.txt -> 720 bytes
surfaces\iconset\iconlist_ivtrf.dds -> 16777344 bytes
surfaces\iconset\iconlist_ivtrf.txt -> 173300 bytes
surfaces\iconset\iconlist_ivtrm.dds -> 16777344 bytes
surfaces\iconset\iconlist_ivtrm.txt -> 173400 bytes
surfaces\iconset\iconlist_pet.dds -> 131200 bytes
surfaces\iconset\iconlist_pet.txt -> 1301 bytes
surfaces\iconset\iconlist_skill.dds -> 524416 bytes
surfaces\iconset\iconlist_skill.txt -> 7878 bytes
surfaces\iconset\iconlist_skillgrp.dds -> 32896 bytes
surfaces\iconset\iconlist_skillgrp.txt -> 602 bytes
surfaces\iconset\iconlist_state.dds -> 32896 bytes
surfaces\iconset\iconlist_state.txt -> 1632 bytes

Lua

Examples

Load elements.data:

-- Import library
require 'autoangel'

-- Open and load elements.data
edata = elements.data('/path/to/elements.data')
conf = elements.load_cfgs('/path/to/configs/folder')
edata:load(conf)

-- Get some info
print(string.format('elements.data version is %d', edata.version))
for _, e in pairs(edata[1]) do
	print(string.format('[%d] %s', e.ID, e.Name))
end

Output:

elements.data version is 12
[1] Мечи
[5] Копья
[9] Топоры/Молоты
[13] Дальнобойные
[182] Каст.
[291] Бич
[292] Инструменты мистика

Read pck package

require 'autoangel'
surf = pck.package('/path/to/surfaces.pck')
surf:load()
for _, path in pairs(surf:find_prefix('surfaces/iconset')) do
    print(string.format('%s -> %d bytes', path, #surf:read(path)))    
end

Output:

surfaces\iconset\iconlist_action.dds -> 32896 bytes
surfaces\iconset\iconlist_action.txt -> 565 bytes
surfaces\iconset\iconlist_faction.dds -> 8320 bytes
surfaces\iconset\iconlist_faction.txt -> 954 bytes
surfaces\iconset\iconlist_guild.dds -> 2097280 bytes
surfaces\iconset\iconlist_guild.txt -> 720 bytes
surfaces\iconset\iconlist_ivtrf.dds -> 16777344 bytes
surfaces\iconset\iconlist_ivtrf.txt -> 173300 bytes
surfaces\iconset\iconlist_ivtrm.dds -> 16777344 bytes
surfaces\iconset\iconlist_ivtrm.txt -> 173400 bytes
surfaces\iconset\iconlist_pet.dds -> 131200 bytes
surfaces\iconset\iconlist_pet.txt -> 1301 bytes
surfaces\iconset\iconlist_skill.dds -> 524416 bytes
surfaces\iconset\iconlist_skill.txt -> 7878 bytes
surfaces\iconset\iconlist_skillgrp.dds -> 32896 bytes
surfaces\iconset\iconlist_skillgrp.txt -> 602 bytes
surfaces\iconset\iconlist_state.dds -> 32896 bytes
surfaces\iconset\iconlist_state.txt -> 1632 bytes

TODO

• Fill TODO list
• Python API docs
• lua API docs
• pck.package for lua
• More examples
• Installation
• Make separate autoangel.a and link it to lua/python implementations
• pkx support
• Performance: mapped file