Skip to content

Commit

Permalink
update readme & settings
Browse files Browse the repository at this point in the history
  • Loading branch information
@eastcw
eastcw committed Oct 16, 2023
1 parent b82e2ba commit 78dc2fd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
39 changes: 21 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Shamelessly taking ideas (and some code) from both the [DnDBeyond character shee

## Installation

Search the Foundry mosule repository for 'Compact DnDBeyond 5e Character Sheet' or copy the module.json link from below.

Module JSON:

```
Expand Down Expand Up @@ -55,32 +57,33 @@ Got rid of the spell school to make room for the more compressed table area. I c
| **Name** | Description |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Use Expanded Sheet as Limited** | Uses the expanded sheet for the limited view. |
| **Enable Lockable Sheets** | A GM-visible-only toggle that enables or disabled locking the character sheet entirely. All sheets will need to be closed and re-opened for this to take effect. |
| **Colour Scheme** | Allows you to choose between the standard Foundry colour scheme similar to the default character sheet, or an in-built dark mode. NB, this dark mode will only affect the character sheet, not the rest of the software. |
| **Show spell slot bubbles** | Shows a set of checkboxes to show you how many levelled spell slots are left at each level, a la DnDBeyond. |
| **Show full currency names** | Shows the full currency names (Gold, Silver, etc) instead of the abbreviated names (GP, SP, etc). |
| **Show Spell Slot Bubbles** | Shows a set of checkboxes to show you how many levelled spell slots are left at each level, a la DnDBeyond. |
| **Show Full Currency Names** | Shows the full currency names (Gold, Silver, etc) instead of the abbreviated names (GP, SP, etc). |

This sheet respects the 5e System setting: "Disable Experience Tracking"

### Compatibility

I'm honestly not sure how well this will play with modules that affect character sheets, I'll try to test as many as possible but if something is obviously breaking please create and issue here and I'll see what I can do.

| **Name** | Works | Notes |
| ------------------------------------------------------------------------------------------------ | :----------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Ready Set Roll 5e](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e) | :heavy_check_mark: | Direct replacement for Better Rolls 5e, seems to work well |
| [Better Rolls 5e](https://github.com/RedReign/FoundryVTT-BetterRolls5e) | :x: | Deprecated in favour of Ready Set Roll 5e |
| [Midi-QOL](https://gitlab.com/tposney/midi-qol) | :heavy_check_mark: | Integrated with 0.7.x, Everything seems normal. |
| [Minor QOL](https://gitlab.com/tposney/minor-qol) | :x: | Deprecated in favor of Midi-QOL. Won't Support. |
| [5e-Sheet Resources Plus](https://github.com/ardittristan/5eSheet-resourcesPlus) | :heavy_check_mark: | Resources area scrolls independently. Uses CSS Grid |
| [Variant Encumbrance](https://github.com/VanirDev/VariantEncumbrance) | :x: | Default encumberance bar removed, Speed css overrides will break things. |
| [FoundryVTT Magic Items](https://gitlab.com/riccisi/foundryvtt-magic-items) | :heavy_check_mark: | List of Spells is Appended to more or less correctly, but new abilities are not added to the Actions Tab. |
| [D&D5e Dark Mode](https://github.com/Stryxin/dnd5edark-foundryvtt) | :heavy_check_mark: | Made tweaks to make foundry-wide dark mode "usable." |
| [Favourite Item Tab](https://github.com/syl3r86/favtab) | :heavy_check_mark: | Works as expected, a few things on the UI are cramped but definitely usable. |
| [Inventory+](https://github.com/syl3r86/inventory-plus) | :shrug: | Inventory Tab Features interfere with how we generate the Actions Tab. If Inventory+ is on, the actions tab will not display items. |
| [Illandril's Character Sheet Lockdown](https://github.com/illandril/FoundryVTT-sheet5e-lockdown) | :x: | With their 4.0.0 release character sheets other than the default 5e sheet are no longer supported. I am looking at implementing a similar feature to replace it. |
| [Crash's 5e Downtime Tracking](https://github.com/crash1115/5e-training) | :heavy_check_mark: | Works well in limited space. |
| [Ethck's 5e Downtime Tracking](https://github.com/Ethck/Ethck-s-Downtime-Tracking) | :heavy_check_mark: | Works well in limited space. |
| [Skill Customization for D&D5E](https://github.com/schultzcole/FVTT-Skill-Customization-5e) | :heavy_check_mark: | user might want to expand their sheet horizontally a little to accommodate the needed extra space. |
| **Name** | Works | Notes |
| ------------------------------------------------------------------------------------------------ | :----------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Ready Set Roll 5e](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e) | :heavy_check_mark: | Direct replacement for Better Rolls 5e, seems to work well |
| [Better Rolls 5e](https://github.com/RedReign/FoundryVTT-BetterRolls5e) | :x: | Deprecated in favour of Ready Set Roll 5e |
| [Midi-QOL](https://gitlab.com/tposney/midi-qol) | :heavy_check_mark: | Integrated with 0.7.x, Everything seems normal. |
| [Minor QOL](https://gitlab.com/tposney/minor-qol) | :x: | Deprecated in favor of Midi-QOL. Won't Support. |
| [5e-Sheet Resources Plus](https://github.com/ardittristan/5eSheet-resourcesPlus) | :heavy_check_mark: | Resources area scrolls independently. Uses CSS Grid |
| [Variant Encumbrance](https://github.com/VanirDev/VariantEncumbrance) | :x: | Default encumberance bar removed, Speed css overrides will break things. |
| [FoundryVTT Magic Items](https://gitlab.com/riccisi/foundryvtt-magic-items) | :heavy_check_mark: | List of Spells is Appended to more or less correctly, but new abilities are not added to the Actions Tab. |
| [D&D5e Dark Mode](https://github.com/Stryxin/dnd5edark-foundryvtt) | :heavy_check_mark: | Made tweaks to make foundry-wide dark mode "usable." |
| [Favourite Item Tab](https://github.com/syl3r86/favtab) | :heavy_check_mark: | Works as expected, a few things on the UI are cramped but definitely usable. |
| [Inventory+](https://github.com/syl3r86/inventory-plus) | :shrug: | Inventory Tab Features interfere with how we generate the Actions Tab. If Inventory+ is on, the actions tab will not display items. |
| [Illandril's Character Sheet Lockdown](https://github.com/illandril/FoundryVTT-sheet5e-lockdown) | :x: | With their 4.0.0 release character sheets other than the default 5e sheet are no longer supported. The sheet itself now supports a basic locking fundtionality instead. |
| [Crash's 5e Downtime Tracking](https://github.com/crash1115/5e-training) | :heavy_check_mark: | Works well in limited space. |
| [Ethck's 5e Downtime Tracking](https://github.com/Ethck/Ethck-s-Downtime-Tracking) | :heavy_check_mark: | Works well in limited space. |
| [Skill Customization for D&D5E](https://github.com/schultzcole/FVTT-Skill-Customization-5e) | :heavy_check_mark: | user might want to expand their sheet horizontally a little to accommodate the needed extra space. |

## Known Issues

Expand Down
6 changes: 3 additions & 3 deletions src/lang/en.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@
"Hint": "Show the full character sheet for users who have the Limited permission for a given Actor."
},
"showFullCurrencyNames": {
"Label": "Show full currency names",
"Label": "Show Full Currency Names",
"Hint": "Show the full currency names (Gold, Silver, Platinum) instead of the abbreviated names (GP, SP, PP). You will need to close and reopen the character sheet for this setting to take effect."
},
"showSpellSlotBubbles": {
"Label": "Show spell slot bubbles",
"Label": "Show Spell Slot Bubbles",
"Hint": "Shows remaining spell slots as full or empty squares, a la DnDBeyond. You will need to close and reopen the character sheet for this setting to take effect."
},
"lockSheets": {
"Label": "Enable lockable sheets",
"Label": "Enable Lockable Sheets",
"Hint": "Toggling this setting ON will lock character sheets by default. Players and GMs must click Unlock in order to make changes to the following fields: Name, Actor Size, Ability Scores, Ability Score Proficiencies, and Skill Proficiencies. This is only meant as a basic preventative measure. This setting is only available to GMs. All currently open sheets will need to be closed and reopened for this setting to take effect."
}
}
Expand Down

0 comments on commit 78dc2fd

Please sign in to comment.