\n
\n
\n\n\n
\n\nK-Scaffold
\n\n\nA PUG, JS, and SCSS framework for building custom Roll20 character sheet templates.\n\n\nView Documentation · Report Bug · Request Feature\n
\n\n
\n\n\n## About The Project\n\nThis framework simplifies the task of writing code for Roll20 character sheets. It aims to provide an easier interface between the html and sheetworkers with some minor css templates.\n\n\n### Built With\n- PUG\n- JS\n- SCSS\n\n\n\n## Getting Started\n### K-scaffold PUG\nTo use the K-scaffold to write the html of your sheet, you will write normal PUG, but using a comprehensive library of components that are frequently used on character sheets. These range from simple mixin versions of standard html elements inputs, textareas, and selects to more complex constructions that generate Roll20 elements or workarounds for limitations of Roll20 character sheets. For full information on the scaffold, read the [pug library documentation](https://kurohyou-studios.github.io/k-scaffold/pug).\n\n\n### K-scaffold Javascript\nTo use the K-scaffold to write your sheetworkers, you will write normal sheetworkers, but using a library of utility functions and sheetworker aliases to supercharge the standard sheetworkers. For full information on the scaffold, read the [sheetworker library documentation](https://kurohyou-studios.github.io/k-scaffold/sheetworkers).\n\n\n### Prerequisites\nCreating and using a custom character sheet requires a Roll20 pro subscription. If you want to utilize the included testing framework, you will also need to install [vitest](https://vitest.dev/);\n### Installation\nInstall the scaffold via NPM:\n```\nnpm i @kurohyou/k-scaffold\n```\n\n\n\n\n## Usage\n\nThe scaffold simplifies many of the common tasks of creating a Roll20 character sheet and provides constructs to easily create everything from fill to left radio groups to textareas that grow based on the content of their associated Roll20 attribute. To generate a K-scaffold sheet, you will need a pug file, and an scss file.\n\n### Pug\n\nYour main pug file should start with:\n```jade\ninclude k-scaffold\n//- Your code starts here\n```\nThis will give your pug file(s) access to the K-scaffold mixins and local variables.\n\n### SCSS\n\nAny scss file that you want to use the K-scaffold's mixins in needs to start with:\n```scss\n@use \"k-scaffold\" as k;\n```\n\n### Build your sheet\n\nTo build your sheet, simply run the following command:\n```shell\n> k-build\n```\nAlternatively, you can build in watch mode so that the sheet is updated as you make code changes.\n```shell\n> k-build --watch\nOR\n> k-build --w\n```\nThis is useful when using the [Roll20 Autocode chrome extension](https://chrome.google.com/webstore/detail/roll20-api-and-sheet-auto/hboggmcfmaakkifgifjbccnpfmnegick) to automatically update the Roll20 sandbox.\n\n\n\n## Roadmap\nSee the [open issues](https://github.com/Kurohyou-Studios/k-scaffold/issues) for a full list of proposed features (and known issues).\n\n\n\n## Contributing\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n### Tests\nThe K-scaffold and sheets written with it use the [Vitest testing framework](https://vitest.dev/).\n\nUnit tests are currently written for the following:\n- The html, testFramework, and translation generation code\n- Parts of the CSS generation generation code\n- The K-scaffold's pug helper functions\n- All sheetworker utility functions except for the repeating section ordering functions.\n\nTests for the uncovered sections of code will be written as work progresses. If you wish to contribute, please ensure that no changes break these tests.\n\n\n\n## License\nDistributed under the mit License. See [LICENSE.txt](https://github.com/Kurohyou-Studios/k-scaffold/LICENSE.txt) for more information.\n\n\n\n## Changelog\n\n[View the Changelog](https://github.com/Kurohyou-Studios/k-scaffold/CHANGELOG.md)\n\n## Contact\n\n[Scott Casey](https://kurohyou.github.io/) - [@Kurohyoustudios](https://twitter.com/Kurohyoustudios)\n\nProject Link: [https://github.com/Kurohyou-Studios/k-scaffold](https://github.com/Kurohyou-Studios/k-scaffold)\n\n\n\n## Acknowledgments\n\n- [Riernar](https://github.com/Riernar) has supercharged the efforts to properly organize and pacakage the K-scaffold.\n- Thank you to [Keith Curtis](http://www.kacurtis.com/index.html) for the excellent logo assets.\n\nThis readme template adapted from the [Best-README-Template](https://github.com/othneildrew/Best-README-Template/blob/master/BLANK_README.md) by [Othneil Drew](https://github.com/othneildrew). Readme generated by [Genme! by Scott Casey](https://github.com/Kurohyou/genme-SC).\n\n\n\n\n\n[contributors-shield]: https://img.shields.io/github/contributors/Kurohyou-Studios/k-scaffold.svg?style=flat\n[contributors-url]: https://github.com/Kurohyou-Studios/k-scaffold/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/Kurohyou-Studios/k-scaffold.svg?style=flat\n[forks-url]: https://github.com/Kurohyou-Studios/k-scaffold/network/members\n[stars-shield]: https://img.shields.io/github/stars/Kurohyou-Studios/k-scaffold.svg?style=flat\n[stars-url]: https://github.com/Kurohyou-Studios/k-scaffold/stargazers\n[issues-shield]: https://img.shields.io/github/issues/Kurohyou-Studios/k-scaffold.svg?style=flat\n[issues-url]: https://github.com/Kurohyou-Studios/k-scaffold/issues\n[license-shield]: https://img.shields.io/github/license/Kurohyou-Studios/k-scaffold.svg?style=flat\n[license-url]: https://github.com/Kurohyou-Studios/k-scaffold/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat&logo=linkedin&colorB=555\n[linkedin-url]: https://linkedin.com/in/scott-casey-20210398\n[patreon-shield]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dkurohyoustudios%26type%3Dpatrons&style=flat\n[patreon-url]: https://patreon.com/Kurohyoustudios\n[product-screenshot]: assets/images/screenshot.png\n","readmeFilename":"README.md","homepage":"https://github.com/Kurohyou-Studios/k-scaffold#readme","repository":{"type":"git","url":"git+https://github.com/Kurohyou-Studios/k-scaffold.git"},"bugs":{"url":"https://github.com/Kurohyou-Studios/k-scaffold/issues"}}Table of Contents
\n- \n
- \nAbout The Project\n
- \n
- Built With \n
\n - \nGetting Started\n\n \n
- \n Usage\n \n
- Roadmap \n
- Contributing \n
- Tests \n
- License \n
- Contact \n
- Acknowledgments \n
- \n