mapeditor/tiled

Document how to use the Python plugin

Open

#1760 opened on Sep 26, 2017

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

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

Tech stack
pythoncpp
Domain
documentation
Issue type
documentation
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
Basic knowledge of PythonAccess to Tiled editor
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Start by examining the tiledbinding.py file to understand the Python plugin API. Check if any documentation already exists in the repository's docs folder. Review the two comments on the issue for additional hints. The task is to document script storage locations and auto reloading, and to generate API docs from the bindings.