Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Map Creation/Editing guidelines #10

Open
Cleptomania opened this issue Apr 26, 2022 · 0 comments
Open

Documentation: Map Creation/Editing guidelines #10

Cleptomania opened this issue Apr 26, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Cleptomania
Copy link
Member

The game uses a number of more advanced Tiled map editor features to enable some dynamic functionality in the levels. For example, there are special properties which can be used to set things about an object, or for an entire map. These things need to be documented in a way that non-programmers can read and understand how to use them in the map editor.

As an example:

An object layer named searchable in the map is special, objects within this layer will be looked at for collisions for item pickups. Objects on this layer are then expected to have an item property which corresponds to an item that is in the item-dictionary.json data file. This data on the map lets the game know what item should be picked up when that object is interacted with.

There are many more examples of the maps enabling functionality like this, so we need to go through and document everything for in maybe a markdown file or perhaps on the Github Wiki section of the project? It should be a living document that can be updated as we enable for features like this though.

@Cleptomania Cleptomania added the documentation Improvements or additions to documentation label Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant