jussi/DotTiled
1
0
Fork 0
mirror of https://github.com/dcronqvist/DotTiled.git synced 2025-05-08 22:56:03 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Further README updates

Browse source
This commit is contained in:
Daniel Cronqvist 2024-07-27 23:53:05 +02:00
parent 30318e6194
commit 6349471a58
4 changed files with 56 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -1,26 +1,46 @@
# 📚 DotTiled
DotTiled is a simple, lightweight, and easy-to-use library for loading, saving, and managing Tiled maps and tilesets in your .NET projects. After [TiledCS](https://github.com/TheBoneJarmer/TiledCS) unfortunately became unmaintained (since 2022), I aimed to create a new library that could fill its shoes. DotTiled is the result of that effort.
<img src="https://www.mapeditor.org/img/tiled-logo-white.png" align="right" width="20%"/>
DotTiled is a simple and easy-to-use library for loading, saving, and managing [Tiled maps and tilesets](https://mapeditor.org) in your .NET projects. After [TiledCS](https://github.com/TheBoneJarmer/TiledCS) unfortunately became unmaintained (since 2022), I aimed to create a new library that could fill its shoes. DotTiled is the result of that effort.
Other similar libraries exist, and you may want to consider them as well:
| Library | Active | Formats | Docs | License | Benchmark* Rank |
| --- | --- | --- | --- | --- | --- |
| **DotTiled** | ✅ | `.tmx`, `.tsx` | Usage, API, XML docs | MIT | 1 |
| [TiledLib](https://github.com/Ragath/TiledLib.Net) | ✅ | | | | |
| [TiledCSPlus](https://github.com/nolemretaWxd/TiledCSPlus) | ✅ | | | | |
| [TiledSharp](https://github.com/marshallward/TiledSharp) | ❌ | | | | |
| [TiledCS](https://github.com/TheBoneJarmer/TiledCS) | ❌ | | | | |
| [TiledNet](https://github.com/napen123/Tiled.Net) | ❌ | | | | |
## Quickstart
### Loading a map with external tilesets
Here are a few examples to get you started with DotTiled.
### Loading a `.tmx` map
```csharp
using DotTiled;
var tmxSerializer = new TmxSerializer();
TmxSerializer tmxSerializer;
// Tiled can store tilesets in external files or in a map itself
// When they are stored externally, you need to provide a way
// to resolve them given their source path
// A map may or may not contain tilesets that are stored in external
// files. To deserialize a map, you must provide a way to resolve such
// tilesets.
Func<string, Tileset> externalTilesetResolver = (string path) =>
{
// Load the tileset from however you want
var tilesetXml = fileSystem.ReadAllText(path);
var xmlStringReader = new StringReader(tilesetXml);
var xmlReader = XmlReader.Create(xmlStringReader);
var tmxSerializer = tmxSerializer.DeserializeTileset(xmlReader);
string tilesetXml = fileSystem.ReadAllText(path);
return tmxSerializer.DeserializeTileset(tilesetXml);
};
string mapXml = fileSystem.ReadAllText("path/to/map.tmx");
Map map = tmxSerializer.DeserializeMap(mapXml, externalTilesetResolver);
```
### Loading a `.tsx` tileset
```csharp
var tmxSerializer = new TmxSerializer();
string tilesetXml = fileSystem.ReadAllText("path/to/tileset.tsx");
Tileset tileset = tmxSerializer.DeserializeTileset(tilesetXml);
```