mapeditor / tiled

Flexible level editor
https://www.mapeditor.org/
Other
11.05k stars 1.75k forks source link

Updated documentation? #3484

Open reworks-org opened 1 year ago

reworks-org commented 1 year ago

Is there a source for better and updated documentation regarding what each program does?

Can't seem to find any docs for tmxrasterizer or what it is, same for tmxviewer, quicktiled and terraingenerator.

bjorn commented 1 year ago

tmxrasterizer renders a map (or a world) to an image. It prints its documentation to the command-line when executed, but it would be good to mention it in the manual.

tmxviewer is a simple map viewer, I'm not sure it needs documentation though I guess it could be worth a mention.

quicktiled (or tiledquick, actually) is experimental and not part of a default build, so I wonder a bit how you came across it. It's currently also just a map viewer, but implemented in Qt Quick. In its current state it makes no sense to document it.

terraingenerator is a bit more involved and could use its own page in the manual. It can combine terrains from different tilesets into a single tileset, even generating new tiles by stacking transitions to empty on top of each other.

reworks-org commented 1 year ago

@bjorn

Does tmxviewer render the same view as the map editor? I.e. animations, terrain, etc?

bjorn commented 1 year ago

Does tmxviewer render the same view as the map editor? I.e. animations, terrain, etc?

Terrain does not need special rendering, because in the end that's just a tool for placing tiles. I don't think the tmxviewer currently plays animations, though it would be a nice feature to add.

eishiya commented 1 year ago

tmxrasterizer has a time offset argument so you can use it for animations, but actually getting a useful animation using that is a hassle. Would be much nicer if you could set it to output multiple frames based on a time step, and had some way to automatically generate the time step (e.g. using the lowest common factor of all the used tile frames as the time step). An option that makes looping animations (i.e. possibly generates a lot of frames to allow the whole thing to loop smoothly) would be fantastic.

ISSOtm commented 1 month ago

Note also that the manual pages (in man/) are not up to date with e.g. the changes from 1.11. tmxrasterizer --help prints more options than man tmxrasterizer.