Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kfields/tyled
CLI utility for generating Tiled Tilesets
https://github.com/kfields/tyled
python tiled tiled-map-editor
Last synced: 3 days ago
JSON representation
CLI utility for generating Tiled Tilesets
- Host: GitHub
- URL: https://github.com/kfields/tyled
- Owner: kfields
- License: mit
- Created: 2020-04-14T06:14:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T00:55:28.000Z (about 1 year ago)
- Last Synced: 2024-11-02T00:35:31.206Z (19 days ago)
- Topics: python, tiled, tiled-map-editor
- Language: Python
- Homepage:
- Size: 2.29 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tyled :butterfly:
CLI utility for generating [Tiled](https://www.mapeditor.org/) Tilesets
:notebook: [Documentation](https://tyled.readthedocs.io/en/latest/)
:package: [Package](https://pypi.org/project/tyled/)
## Installation
### From PyPI
#### TLDR - do this at your own risk
pip install tyled
#### Recommended - pipX
If you don't already have it installed go to https://pypi.org/project/pipx/ for instructions
pipx install tyled
### From GitHub
Clone the repository
git clone https://github.com/kfields/tyled.git
Navigate to the new directory which contains the repository
cd tyled
Create a Python 3 virtual environment called `env`
python3 -m venv env
Activate the environment
source env/bin/activate
Install required packages
pip install -r requirements.txt
## Commands
### Bake
tyled bake mytileset.toml [--save/--no-save][--show/--no-show][--rotation/--no-rotation]
#### Options
Default options are --save, --no-show, --no-rotation
## Projects
Tyled Projects are defined using TOML files.
All Projects must at least have a name and type
```toml
name = 'mytileset'
type = 'collection'
```
### Options
Options may be defined within the project file. Any options defined here will override the command line options
```toml
[options]
rotation = true
```
## Tilesets
Tyled currently supports three different kinds of Tilesets:
### Collection Tileset
A Collection Tileset is composed of tiles with images stored in separate files
```toml
name = 'mytileset'
type = 'collection'
firstgid = 1
source = 'sticker-knight/map'
```
This example will generate mytileset.tsx in the current working directory
### Orthogonal Tileset
An Orthogonal Tileset is composed of tiles that have the same dimensions in one image file
```toml
name = 'mytileset'
type = 'orthogonal'
firstgid = 1
source = 'platformer/tiles'
tilewidth = 128
tileheight = 128
spacing = 0
margin = 0
columns = 12
```
This example will generate mytileset.tsx and mytileset.png in the current working directory
### Atlas Tileset
An Atlas Tileset is composed of tiles that do not have the same dimensions in one image file
```toml
name = 'mytileset'
type = 'atlas'
firstgid = 0
source = 'sticker-knight/map'
width = 1024
height = 1024
spacing = 0
margin = 0
```
This example will generate mytileset.tsx and mytileset.png in the current working directory