TiledSharp 技术文档

本文档将详细介绍如何安装、使用以及通过API操作 TiledSharp，这是一个.NET C#库，用于导入 Tiled 生成的 TMX 地图和 TSX 瓷砖集。

1. 安装指南

TiledSharp 可以直接集成到您的 C# 项目中。以下是安装步骤：

• 下载 TiledSharp 的源代码或预编译 DLL 文件。
• 如果下载源代码，将其添加到您的项目中，并编译。
• 如果下载 DLL 文件，将其添加到您的项目的引用中。

2. 项目的使用说明

以下是如何在您的 C# 应用程序中导入 TMX 文件的步骤：

• 首先，确保已将 TiledSharp 添加到项目中，并引用其命名空间（可选）：

  using TiledSharp;
  

• 使用构造函数创建一个 Map 对象：

  var map = new TmxMap("someMap.tmx");
  

  TiledSharp 支持资源名称和文件路径。更多细节请参考项目 Wiki。

• 使用 Map 字段访问 TMX 数据。主要类可以通过名称或索引访问：

  var version = map.Version;
  var myTileset = map.Tilesets["myTileset"];
  var myLayer = map.Layers[2];
  var hiddenChest = map.ObjectGroups["Chests"].Objects["hiddenChest"];
  

  Map 数据字段与 TMX 文件结构紧密对应。有关完整列表，请参阅文档。

3. 项目API使用文档

以下是 TiledSharp 的一些主要 API 的使用方法：

• TmxMap(string tmxFilePath)：构造函数用于加载 TMX 文件。
• Version：获取 TMX 文件的版本信息。
• Tilesets：获取瓷砖集的集合。
• Layers：获取图层的集合。
• ObjectGroups：获取对象组的集合。

例如，若要获取特定瓷砖集，可以使用：

var myTileset = map.Tilesets["myTileset"];

4. 项目安装方式

TiledSharp 可以通过以下两种方式安装到您的项目中：

• 手动下载源代码或预编译的 DLL 文件，然后添加到项目中。
• 使用 NuGet 包管理器搜索并安装 TiledSharp 包。

以上步骤涵盖了安装、使用和操作 TiledSharp 的基础知识。更多高级功能和详细信息，请参考项目 Wiki 文档。

注意： 本文档使用 Apache 2.0 许可证发布。在使用或修改 TiledSharp 时，请遵守许可证要求。