SFTtech/openage

Parse nyan API objects in converter instead of hardcoding them

Open

#1.313 geöffnet am 7. Sept. 2020

Auf GitHub ansehen
 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.135 Forks)batch import
area: assetsgood first issuelang: cythonlang: python

Repository-Metriken

Stars
 (12.130 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 23h) (1 gemergte PR in 30 T)

Beschreibung

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

Research-Richtung
Beginnen Sie mit dem Studium der aktuellen hartcodierten API Objekte in openage/convert/service/read/nyan api loader.py. Überprüfen Sie dann die Konverter Architekturdokumentation unter doc/code/converter/architecture overview.md, um zu verstehen, wie der Konverter nyan Objekte lädt. Erwägen Sie als Nächstes die beiden Ansätze: Entweder einen Python Parser für nyan implementieren oder den C++ Parser von libnyan um eine Python Schnittstelle erweitern, wobei auf das verwandte nyan Issue #64 verwiesen wird. Der gewählte Ansatz sollte vor der Implementierung mit den Maintainern besprochen werden.
Tech Stack
pythoncpp
Domain
backendtoolingdeveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonC++
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35