Nighthawk/roll20-character-sheets
1
0
Fork 0
mirror of https://github.com/Nighthawk42/roll20-character-sheets.git synced 2026-08-30 03:40:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to mention new section on sheet.json + adding few hyperlinks

Browse Source
This commit is contained in:
Andreas Johansson
2021-04-17 15:02:18 +03:00
parent 9f48a2c96c
commit 661eb41eb2
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -6
View File
@@ -32,16 +32,17 @@ If you would like to contribute a new sheet for the community to use, just clone
**Creating a sheet.json File**
When you are ready to submit your template for **public use**, create a `sheet.json` file in your sheet's folder (see the kitchensink folder for an example sheet.json file). This file is required to be named `sheet.json`. The file has the following fields:
When you are ready to submit your template for **public use**, create a `sheet.json` file in your sheet's folder (see the [kitchensink](https://github.com/Roll20/roll20-character-sheets/tree/master/kitchensink) folder for an example [sheet.json](https://github.com/Roll20/roll20-character-sheets/blob/master/kitchensink/sheet.json) file). This file is required to be named `sheet.json`. The file has the following fields:
* `html`: The **exact** name, including capitzation, of the HTML file for the sheet (e.g. `kitchensink.html`).
* `css`: The **exact** name, including capitzation, of the CSS file for the sheet (e.g. `kitchensink.css`).
* `authors`: A simple string telling who contributed toward the sheet (e.g. `Riley Dutton`)
* `authors`: A simple string telling who contributed toward the sheet (e.g. `Riley Dutton` or `Riley Dutton, John Doe`)
* `roll20userid`: A simple string telling the Roll20 User ID's of the authors (e.g. `1` or `45672,145678`). Just used so we know who to credit internally, won't be shown publicly on the site.
* `patreon`: Place the URL for a Patreon campaign here, and it will appear under your sheet's description when selected. (e.g. `"https://www.patreon.com/<name>"`)
* `tipeee`: Place the URL for a Tipeee here, and it will appear under your sheet's description when selected. (e.g. `"https://www.tipeee.com/<name>"`)
* `patreon`: *(optional)* Place the URL for a Patreon campaign here, and it will appear under your sheet's description when selected. (e.g. `"https://www.patreon.com/<name>"`)
* `tipeee`: *(optional)* Place the URL for a Tipeee here, and it will appear under your sheet's description when selected. (e.g. `"https://www.tipeee.com/<name>"`)
* `preview`: The **exact** name, including capitzation, of an image file which included in your sheet folder showing a preview/screenshot of the sheet (will be displayed in-app at 500x500 resolution) (e.g. `kitchensink.png`).
* `instructions`: Markdown-formatted instructions for using the sheet. If there are any particular setup steps, special rolls you want to make the player aware of, etc., this is the place to put that info. Try to be succinct.
* `instructions`: Markdown-formatted instructions for using the sheet. If there are any particular setup steps, special rolls you want to make the player aware of, etc., this is the place to put that info. Try to be succinct. If you have sheet instructions elsewhere, it can be a good idea to provide a link here (e.g. `full sheet instructions in the [Readme](https://github.com/Roll20/roll20-character-sheets/blob/master/kitchensink/README.md)` or `Sheet instuctions, Roll20 Wiki: [Example PRG](https://wiki.roll20.net/ExampleRPG)`)
* `legacy` : set to either `true` or `false`. If the sheet code have been updated to work with the [Character Sheet Enhancement](https://wiki.roll20.net/Character_Sheet_Enhancement)-update (released [March 2021](https://app.roll20.net/forum/permalink/9883156/)), set it to `false`. Otherwise, set it to `true`.
After we have reviewed your sheet if we approve it we will add it to the `approved.yaml` file in the root directory which will cause it to be available to everyone on the main Roll20 site. If we reject your sheet, we will comment on your Github commit and let you know what changes need to be made before it can be accepted.
@@ -56,4 +57,4 @@ The former guidelines found here have been moved and expanded on in the [Roll20
License
=======
All of the code (HTML/CSS) of the sheets in this repository is released under the MIT license (see LICENSE file for details). If you contribute a new sheet or help improve an existing sheet, you agree that your contribution is released under the MIT License as well.
All of the code (HTML/CSS) of the sheets in this repository is released under the MIT license (see [LICENSE](https://github.com/Roll20/roll20-character-sheets/blob/master/LICENSE) file for details). If you contribute a new sheet or help improve an existing sheet, you agree that your contribution is released under the MIT License as well.