SFTtech / SFTtech/openage

Parse nyan API objects in converter instead of hardcoding them

Open
#1,313 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: assets good first issue lang: cython lang: python
Dominant language
Python
Stars
14.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

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

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with openage/convert/service/read/nyan_api_loader.py and read the converter architecture and workflow documents. Compare implementing a Python nyan parser with exposing libnyan's existing C++ parser through Python, including the related nyan issue. Done means the converter reads API objects from the filesystem instead of relying on hardcoded objects.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.