mapeditor/tiled

Document how to use the Python plugin

Open

#1,760 建立於 2017年9月26日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)C++ (10,413 star) (1,708 fork)batch import
documentationhelp wanted

描述

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).

貢獻者指南

技術棧
pythoncpp
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of PythonAccess to Tiled editor
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
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.
Document how to use the Python plugin · mapeditor/tiled#1760 | Good First Issue