https://github.com/kockaadmiralac/tiled-datamaps

Adapts Tiled maps for use by the DataMaps MediaWiki extension.
https://github.com/kockaadmiralac/tiled-datamaps

Last synced: about 6 hours ago
JSON representation

Adapts Tiled maps for use by the DataMaps MediaWiki extension.

• Host: GitHub
• URL: https://github.com/kockaadmiralac/tiled-datamaps
• Owner: KockaAdmiralac
• Created: 2024-08-14T03:30:12.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-10-28T02:05:50.000Z (11 days ago)
• Last Synced: 2024-10-28T05:58:41.302Z (11 days ago)
• Language: Python
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tiled-datamaps

Converts [Tiled](https://mapeditor.org/) maps into maps recognized by the

[DataMaps](https://support.wiki.gg/wiki/DataMaps) MediaWiki extension, to the

best of its ability. Currently still in WIP, but suitable for use on the

[Undertale Yellow Wiki](https://undertaleyellow.wiki.gg/).

## Setup

### Prerequisites

- [Git](https://git-scm.com/)

- [Git LFS](https://git-lfs.com/)

- [Python](https://www.python.org/)

- [Tiled](https://www.mapeditor.org/)

On the wiki that you are editing, you need to have the

[DataMaps](https://www.mediawiki.org/wiki/Extension:DataMaps) extension

installed.

### Set up repository

```bash

git clone https://github.com/KockaAdmiralac/tiled-datamaps.git

git lfs pull

cd tiled-datamaps

python -m venv .venv

source .venv/bin/activate

# Or the Windows equivalent:

# .venv\Scripts\activate.bat

pip install -r requirements.txt

```

## Usage

### Map editor

This is how features of Tiled map to DataMaps:

- Every image layer on the map maps to a an image background in DataMaps.

- All points on the map are used as map markers in DataMaps.

- Rectangles, polylines and polygons are used as background overlays in

  DataMaps.

- Every object layer on the map is used as a marker group name.

    - Every point in that object layer is treated as a marker with the group

      name set to the layer name.

- Every group layer on the map is used as a category name for markers within

  that group.

    - Every point in an object layer inside a group layer is treated as a marker

      with the group name set to the object layer name, and categories set to

      names of all parent group layers.

- Tile layers are not supported yet.

- Layer offsets are (mostly) supported.

#### Custom properties

Modifying certain aspects of DataMaps is only possible through custom properties

in Tiled:

- Custom project properties are used to tell the script where to publish the

  maps:

    - `wiki` (string): Wiki URL

        - For example, `undertaleyellow.wiki.gg`

    - `scriptPath` (string): Wiki's script path

- Custom map properties are used for map-wide configuration:

    - `disclaimer` (string): Disclaimer displayed below the legend in DataMaps

    - `include` (string): Newline-separated list of strings that describe which

      pages should be included as fragments

        - This is intended for including map fragments that define the groups

          and categories used in the map

- Custom point properties are used for marker information:

    - `description` (string): Description of the marker

    - `page` (string): Where should the "Read more" link lead

    - `plain` (boolean): Whether the description should *not* be interpreted as

      wikitext

- Custom rectangle properties:

    - `fill` (color): Rectangle fill color

    - `border` (color): Rectangle border color

- Custom polyline and polygon properties:

    - `color` (color): Polyline color

    - `thickness` (float): Polyline thickness

### Conversion

To convert all maps in the project and publish them to the wiki, you can run

`convert.py`. It takes three optional arguments:

- `--project`: Folder name of the project in the `maps` directory. If there is

  only one directory, you don't need to specify this.

- `--map`: Which map in the project do you want to publish. If you leave this

  out, all maps in the project are published.

- `--log_level`: `info`, `error`, `debug`, all the standard Python logging

  levels.

On the first run, the script will ask you for three pieces of information to log

you in. You need to go to Special:BotPasswords on the wiki you want to edit,

grant it the ability for high-volume editing as well as editing existent pages,

and the page will tell you your username is `Username@BotPasswordName` and your

token is `Token`. In the script, you will input these separately: first

`Username`, then `BotPasswordName`, and finally `Token`.