Monstrology

Visual flair that displays an icon or icon font next to a monster name based on its type.

Table of Contents

1. About The Project
2. Usage
3. Roadmap
4. Contributing
5. License
6. Acknowledgments

About The Project

Monstrology is a project that aims to add some visual flair to the names of monsters in various games and media. It uses an icon or icon font to represent the type of the monster, such as dragon, zombie, alien, etc. This way, you can easily identify the monster’s characteristics and abilities at a glance. Monstrology is a fun and creative way to enhance your gaming experience and immerse yourself in the world of monsters.

(back to top)

Usage

For each alignment, element, or monster type that you want to display, use the syntax `Key:Type` in your text, where Key is either ali, ele, or mon. Type is one of the supporting words you want to display

Suggestion

on a new line entering ` follow by a letter will show a list of icons for that given letter.

(back to top)

Roadmap

• Add Changelog
• Add more monster types
• Add element Support
  • sub elements (posion, etc)
• Finish settings
• Make it more standardized with Dice Roller and Pf2-Actions
• Additonal Features
  • Change the icon's color
  • Change the icon's size
  • Suggest icons
  • Support icon-linking

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Thank you for your interest in this project.

If you want to improve this project, you can fork the repo and create a pull request with your changes. You can also open an issue with the label "enhancement" to share your feedback or ideas. Please show your support by giving the project a star! I appreciate your collaboration!

To contribute to this project, follow these steps:

1. Fork the repo

2. Create a new branch on your local machine

   git checkout -b Development/Monstrology

3. Make your changes and commit them

   git commit -m 'Added some Feature'

4. Push your branch to GitHub

   git push origin Development/Monstrology

5. Create a pull request and wait for review

(back to top)

License

See LICENSE.txt for more information.

(back to top)

Acknowledgments

Credit to

• 
• 
• 
• 
• 

(back to top)