mapeditor/tiled

Document how to use the Python plugin

Open

#1,760 opened on Sep 26, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (1,708 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (10,413 stars)
PR merge metrics
 (Avg merge 14d 4h) (17 merged PRs in 30d)

Description

This should include information about where to save your scripts so that Tiled will find them, and mention the auto-reloading functionality when scripts are changed.

It should also include an API documentation, ideally generated from the bindings (tiledbinding.py).

Contributor guide

Research direction
Explore the Python plugin's existing code and the tiledbinding.py file to understand the API. Then create a guide covering script location and auto reload, and generate API docs.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Tiled basicsPython scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85