SFTtech/openage

Parse nyan API objects in converter instead of hardcoding them

Open

#1,313 opened on Sep 7, 2020

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Python (12,130 stars) (1,135 forks)batch import
area: assetsgood first issuelang: cythonlang: python

Description

Required skills: Python, Cython, nyan, maybe C++

Difficulty: Medium

Currently, the asset converter stores the openage nyan API as hardcoded nyan objects. It would be much better if the converter could read the API objects from the filesystem with a parser. There would be two ways to do this. Either we implement a new Python parser for nyan or we extend libnyan's already existing C++ parser with a Python interface (related issue in nyan repository).

Further reading:

Contributor guide

Tech stack
pythoncpp
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonC++openage converter architecturenyan API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by studying the current hardcoded API objects in openage/convert/service/read/nyan api loader.py. Then review the converter architecture documentation at doc/code/converter/architecture overview.md to understand how the converter loads nyan objects. Next, consider the two approaches: either implement a Python parser for nyan or extend libnyan's C++ parser with a Python interface, referencing the related nyan issue #64. The chosen approach should be discussed with maintainers before implementation.