Waytale Tilesets

A collection of ready-to-use tilesets for the Tiled map editor to build Waytale spaces.

To keep things orderly, tilesets are stored in the tsx directory and image files in a src/<author>/<project>, together with other files.

In particular, every tileset source file must have proper author attribution and must be published under a suitable license. See the section on crediting sources below for more information.

How to use

An official tutorial is planned. When ready, details will appear here.

Repository structure and file dependencies

With the Tiled editor you create maps (tmx files) based on tilesets (tsx files). Tilesets hold are based on one image file (usually a png file) that holds the visual information, and they usally contain other meta-information like which tile you can collide with for example. Map files are XML-based and contain path-based references to the tilesets used. In turn, tilesets are also XML-based and contain path-based references to image files.

Any tileset in this repository only references image files also be stored here. For this to work properly for other people, the tsx file needs to meet two requirements (see examples below):

1. Each <image> tag needs to have a source attribute with a relative path.
2. Relative paths must not go beyond the root of this repository.

In practice for tilesets in this repository the above means: Path must start with "../src/".

Tiled is usually pretty good at storing path information in tilesets so that those two requirements are satisfied. However, it is good practise to double-check the path within tiled or by opening the tsx file and making corrections if needed.

Examples for <image> specifications

In the following god example the <image> tag is okay, as it specifies its source as a relative path, that only goes "up" one level in the file hierarchy.

<image source="../src/waytale/residential/residential.png" width="2624" height="2560"/>

The following are bad examples, as they each violate one of the requirements above. The first example has absolute paths and the second makes assumptions about the directory structure outside this repository. Don't do that.

<image source="/home/me/waytale/tilesets/images/BAD_EXAMPLE.png" width="2624" height="2560"/>
<image source="../../tilesets/src/artist/project/BAD_EXAMPLE.png" width="2624" height="2560"/>

Crediting sources

When you release art, you should always release it with a license that specifies what others can or cannot do with it. For example, the Creative Commons family of licenses are frequently used for artistic works. There are useful tools that help you choosing a license suitable for your use case.

As an example, an attribution template file to credit sources can be found below. Frequently tilesets include the works of other artists or are in entirety composed of only other work. In that case all of the artists need to be properly credited if the license of the used work requires so.

Attribution template

The original author(s) of tileset sources should be properly credited, especially if the license requires it. Each directory src/<author>/<project>/ should contain a text file holding author attribution. The intended target audience is human, no over-strict formalism required.

Sometimes tilesets need small changes or extensions. Those should be clearly marked either in the attribution text file or in the png file itself.

Below is a template that can be copied and filled out for that purpose. The "project" could also be a distribution of artwork or other logical grouping, or maybe not apply at all, adapt where suitable. Links should be formatted as [text](url). Calling the file README.md allows for neat rendering when checking out the repository online.

# Source attribution

## About the author

- name of author(s):
- how to reach the author(s):
  - e.g. [link to homepage](https://example.com/)
  - e.g. [link to social media profile](https://mastodon.social/@example)

## About the project

- name of project:
- date of publication:
- published under license:
- project homepage(s):
  - e.g. [link to homepage](https://example.com/)
  - e.g. [link to social media profile](https://mastodon.social/@example)

## Applied changes

- (if applicable)