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

Clarifications for the PF2e Stat Block example #11

Open
Bluetopia opened this issue May 11, 2024 · 1 comment
Open

Clarifications for the PF2e Stat Block example #11

Bluetopia opened this issue May 11, 2024 · 1 comment

Comments

@Bluetopia
Copy link

Scope

Page in documentation: https://plugins.javalent.com/statblock/layouts/integrated/pf2e

Purpose: Clarify use of template statblock

Discovery

Action icons

The PF2e action icons (1,2,3 action, free action, reaction) seem to use characters that are outside what a normal keyboard can generate. (⬻, ⬺, ?, ?, ⬲) where ? indicates a character that no example was available for.

The documentation should contain information about these special characters so that they can be copied/pasted by users.

Alternatively or in addition to the above, adding some comments to the template may also be useful:

# Character for 1-action: ⬻
# Character for 2-action: ⬺
# Character for 3-action: TBD
# Character for reaction: ⬲
# Character for free action: TBD
...

Validate

In addition, having a page that clearly directs where to post issues with the documentation would be helpful. The documentation has a "Github Issue" page that doesn't link to where documentation issues should be posted, it just explains what an issue is.

I'm hoping that I'm posting this in the correct project; this is where documentation issues in GitHub directed me. :)

@Bluetopia
Copy link
Author

This is the minimum I'd need to work with this. A better solution would be to have some sort of string that could be put in place of the special characters as it's very difficult to differentiate between 1 and 2 actions at the scale I'm using, though that's a coding change and better suited to the plugin project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant