From 682eb39babad6b1929be9878a1ee097053606fda Mon Sep 17 00:00:00 2001
From: stuebinm <stuebinm@disroot.org>
Date: Tue, 7 Dec 2021 19:45:33 +0100
Subject: [PATCH] better documentation for licenses
(also fix an error; tileset copyright goes into `tilesetCopyright`, not
`copyright`)
---
docs/maps.en.md | 10 ++++++++--
docs/maps.md | 5 ++++-
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/docs/maps.en.md b/docs/maps.en.md
index 4e27d63..b9b7139 100644
--- a/docs/maps.en.md
+++ b/docs/maps.en.md
@@ -149,6 +149,8 @@ Tiles can also be transparent, and are saved in the PNG format.
* Check the license of the tiles!
* We will not actively check the licenses of your tiles, but react to
violations on a "takedown on notice" principle!
+ * Document the license of your tiles via the custom property
+ `tilesetCopyright` (type string) on the tileset.
* [Shared Tiles Repo](https://tiles.rc3.world/)
### How to design / "pixel" tiles
@@ -212,6 +214,10 @@ in the TSX format is not possible. (This does not mean that the image data itsel
will be embedded. PNG must be included in the repository as seperate files as
well.)
+Please pay attention to the licenses of the tiles you use, and document their
+copyright by setting the `tilesetCopyright` custom property (type string) on each
+tileset.
+
### Additional functionality per layer
#### Start layer
@@ -351,8 +357,8 @@ To do so just untick the "infinite" tick box, then save.
## Licenses
Please pay attention to the licenses and copyright of your tilesets. You must (!)
-set those via the `copyright` property directly on the tilesets within your map
-json! (just add a custom property to the tileset in Tiled).
+set those via the `tilesetCopyright` property directly on the tilesets within
+your map json! (just add a custom property to the tileset in Tiled).
The same applies to your entire map: document its licence / copyright by setting
the property `mapCopyright` (type string) on the map (not on a layer / tileset!).
diff --git a/docs/maps.md b/docs/maps.md
index 41f88bd..a9a179d 100644
--- a/docs/maps.md
+++ b/docs/maps.md
@@ -158,6 +158,7 @@ Tiles können Transparenz beinhalten und liegen im png-Format vor.
* Achtet auf die Lizenz der Tilesets
* wir werden nicht aktiv prüfen, unter welcher Lizenz eure Tiles stehen,
allerdings nach dem Prinzip "takedown on notice" auf Verstöße reagieren.
+ * tragt die Lizenz eurer Tilesets in die custom property `tilesetCopyright` ein
* [Shared Tiles Repo](https://tiles.rc3.world/)
@@ -227,6 +228,8 @@ Tilesets im TSX Format ist nicht möglich. (Das heißt nicht, dass die Bilddatei
mit eingebunden sind. Die PNG-Dateien müssen ebenfalls auf den Server geladen
werden bzw. in eurem Repository vorhanden sein.)
+Achtet bitte auf die Lizenzen der verwendeten Tiles und tragt deren Copyright in
+die custom property `tilesetCopyright` ein.
### Zusatzfunktionen für Layer
@@ -377,7 +380,7 @@ speichern.
## Lizenzen
Achtet bitte bei euren Tilesets auf deren Lizenzen bzw. Copyright. Diese
-müsst (!) ihr via der `"copyright"` Property direkt in eurem Map json für die
+müsst (!) ihr via der `tilesetCopyright` Property direkt in eurem Map json für die
jeweiligen Tilesets setzen.
Ebenso müsst (!) ihr für eure gesamte Map Lizenz bzw. Copyright in der custom
--
GitLab