mapeditor/tiled

Provide an up to date xml schema for all xml formats

Open

#2,876 opened on Jul 29, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C++ (10,413 stars) (1,708 forks)batch import
help wanted

Description

Hi,

I'm now at a phase where I can start writing some custom map conversion tools. I was looking at the bundled Java library but unfortunately that one is really out of date. Then I looked at the schema's in de doc directory to just make my own parser. But they are also out of date.

Ideally the schema should serve as the single source of truth for:

  • Tiled's own xml handling code
  • Any parser library (including the bundled one)
  • Documentation

This also forces you to have an up to date XSD at all times.

For now I think I can use TiledReader. But I think it would be really useful to provide up to date xml schemas for writing tooling around tiled.

Contributor guide

Tech stack
None
Domain
documentationdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Understanding of XML Schema (XSD)Familiarity with Tiled's XML formatsBasic knowledge of C++ (for bundled Java library)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the existing XML schema files in the 'doc' directory of the repository, as well as the TiledReader.cpp source file to understand how XML is currently parsed. Check the bundled Java library (if still present) to see its outdated state. Discuss with maintainers via the issue comments to clarify which XML formats need schemas and any specific requirements. Review the links in the issue for additional context.