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

Document tilesets #771

Merged
merged 9 commits into from
Dec 24, 2021
Merged

Document tilesets #771

merged 9 commits into from
Dec 24, 2021

Conversation

lmoureaux
Copy link
Contributor

@lmoureaux lmoureaux commented Dec 12, 2021

This PR aims at drastically improving the documentation of tilesets by tackling the first two chapters of #774:

  • Bootstraping the tutorial: this includes locating the data path, creating the new tileset and selecting it in the menu.
  • Adding a new unit. This sounds like a good intro to the mechanics in use: interaction with the ruleset, spec files, grids

@lmoureaux lmoureaux added the documentation Improvements or additions to documentation label Dec 12, 2021
@lmoureaux lmoureaux requested a review from jwrober December 12, 2021 04:39
@lmoureaux lmoureaux marked this pull request as draft December 12, 2021 04:41
Copy link
Collaborator

@jwrober jwrober left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few misspellings to fix.

docs/Modding/Tilesets/Tutorial/02_units.rst Outdated Show resolved Hide resolved
tileset. To do this, open ``tutorial.tilespec`` and find the line with ``files =`` (around the half of the
file). Insert the new ``spec`` file at the top of the list:

.. code-block:: py
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't this be ini instead of py?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

py looks better in this case... I agree it's weird

docs/Modding/Tilesets/Tutorial/02_units.rst Outdated Show resolved Hide resolved
docs/Modding/Tilesets/Tutorial/02_units.rst Outdated Show resolved Hide resolved
docs/Modding/Tilesets/tutorial.rst Show resolved Hide resolved
client/helpdata.cpp Outdated Show resolved Hide resolved
This will allow better grouping of the chapters in the table of contents.
This required some restructuring, but I think the folder structure is good now.

See longturn#774.
It describes how to get started with a new tileset by copying amplio2.

See longturn#774.
@lmoureaux lmoureaux marked this pull request as ready for review December 23, 2021 02:22
@lmoureaux
Copy link
Contributor Author

lmoureaux commented Dec 23, 2021

Fixed typos and added chapter 1. The tutorial should now be self-consistent (if short) so I think this can be merged after one more review.
[Edit: the clang-format failure is unrelated and likely transient.]

The Explorer shows the extension until the file is opened, after which it may
disappear if an editor is registered. Make the statement about Windows Explorer
not showing the file extension more vague to accomodate this behavior.
@lmoureaux lmoureaux requested a review from jwrober December 23, 2021 02:36
@lmoureaux
Copy link
Contributor Author

clang-format failure tackled in #784

@lmoureaux lmoureaux merged commit 6c24c3b into longturn:master Dec 24, 2021
@lmoureaux lmoureaux deleted the docs/tilesets branch December 24, 2021 01:38
lmoureaux added a commit that referenced this pull request Dec 24, 2021
Spotted by jwrober in #771.
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

Successfully merging this pull request may close these issues.

2 participants