From d38a1e0774426ed6001720ee4ea0d263edfc013d Mon Sep 17 00:00:00 2001 From: OneRadRedDad <119024055+OneRadRedDad@users.noreply.github.com> Date: Sat, 9 Mar 2024 12:28:27 -0500 Subject: [PATCH 1/6] Update README.md --- README.md | 56 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 850f12d..9e26cc9 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,8 @@ -# Character Sheet. App. +# Character Sheet. App. (Semi-) Automatic. -A responsive, online/offline web app to act as a character sheet for tabletop roleplaying games. Right now supporting a limited number of games (mostly D&D 5e), but coded so more can be added. +This project is a fork of [`derikb/character-sheet-app`](https://github.com/derikb/character-sheet-app), which is a responsive online/offline web app to act as a character sheet for tabletop roleplaying games (mostly D&D 5e). This fork will focus on styling changes and automating field completion based on a user's selections. ## Synopsis -If you just want to use the app, I am running a copy of it here: https://charsheet.derikbadman.com Try it out. Check out the "Help" link in the footer for some instructions. +In-progress by an amateur dev and git user. Stay tuned for updates to README.md and all the important bits mentioned above. -If you want to run the app on your own server, assist in development, or fork your own, continue on... - -## Motivation - -I hate fillable pdfs. I couldn't find a sharp pencil for the character sheet I printed out. I wanted to use my new iPad. I wanted to try out a bunch of modern browser features without worrying about backwards compatibility. I thought maybe someone else would want these things too. - -## Installation - -You'll need a local server running, or to put the code on a remote server. - -For remote saving you will have to add your own firebase configs to `./src/config/firebase.js` and rebuild the app. - -## Local Server - -**If you aren't doing development**, an easy way to get a server running is via `http-server`. Assuming you have npm installed you can: `npm i -g http-server`. Then from the repository of this app you can run `http-server ./dist/ -a localhost` and you should then be able to see/run the app at `http://localhost:8080` in your browser. - -**If you are doing development**, then you you can `npm install` in the repo and `npm run start` to start the esbuild dev server/build. By default that will run the app at `http://localhost:8080` - -### Server - -* Point your server at the repo so it opens `./dist/index.html`. That's about it... - -If you want to take advantage of the offline mode, it's a little more complicated: -* you'll need to use a HTTPS connection (Let's Encrypt is fairly easy to set-up to get a free SSL cert) -* You'll want to set the main server directory to the `dist` directory of the code, that way the server won't serve any of the other files. -* Make sure files are set to not cache (the service worker will handle that). In nginx I added the following to my server block: -``` - index index.html; - gzip on; - gzip_types text/css application/javascript image/svg+xml; - - location / { - expires -1; - } -``` - - -## Tests - -No tests yet, as I am not sure how to best go about that. - -## Contributors - -I'd be happy to accept feature requests (including other games to support), bug reports, and pull requests via the github repository. There is an eslint config file for javascript style, which your IDE should pick up. Run ```npm run start``` to run the dev server and `npm run build` to build the files. - -Conventional Changelog is installed for commit messages. Standard Version is used for releases, changelogs, etc. - -## License - -GNU GENERAL PUBLIC LICENSE, Version 3 From 03942ca4f353c899383b74b207395b7bfe174d09 Mon Sep 17 00:00:00 2001 From: OneRadRedDad <119024055+OneRadRedDad@users.noreply.github.com> Date: Tue, 12 Mar 2024 18:58:12 -0400 Subject: [PATCH 2/6] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e26cc9..f7479bd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,36 @@ # Character Sheet. App. (Semi-) Automatic. -This project is a fork of [`derikb/character-sheet-app`](https://github.com/derikb/character-sheet-app), which is a responsive online/offline web app to act as a character sheet for tabletop roleplaying games (mostly D&D 5e). This fork will focus on styling changes and automating field completion based on a user's selections. - ## Synopsis -In-progress by an amateur dev and git user. Stay tuned for updates to README.md and all the important bits mentioned above. +This project is a fork of [`derikb/character-sheet-app`](https://github.com/derikb/character-sheet-app), which is a responsive online/offline web app to act as a character sheet for tabletop roleplaying games (mostly D&D 5e). This fork focuses on expanding the features of the original project and making the app friendlier to TTRPG newbs. + +## Planned Features + +I plan to add the following features (in no particular order): + +* Automated sheet population (such as populating your Saving Throws area based on your class) +* Support for homebrew races/classes/items/etc. (by default, the app will only support SRD content from DnD 5e). +* Inclusion of derikb's manual controls. While automatic sheet population will be nice, sometimes you need to make manual adjustments beyond the vanilla settings. +* Support for more platforms. I like the idea of an app like this being a standalone thing on one's desktop or phone, or in a docker image, or embedded wherever else. This one's a big stretch goal, though, because I have NO idea what I'm doing there. +* More/better organization for new players to be able to navigate and read it easier +* Theme support? + +## Motivation + +I had a lot of the same motivations as derikb, with a few others. I thought maybe someone else would want these things too. + +## Contributors + +I'm happy to accept feature requests, bug reports, and pull requests via the github repository. There is an eslint config file for javascript style, which your IDE should pick up. + +Conventional Changelog is installed for commit messages. Standard Version is used for releases, changelogs, etc. + +## Miscellaneous Disclaimers + +This project and everything about it is a work in-progress by an amateur dev and git user. This project is not my job, I don't have an unlimited amount of free time to work on it, and I'm not very good at programming. This project will have bugs. It will not be completed quickly. It may not ever be completed. + +Stay tuned for updates to README.md and any other file I get my grubby hands on. + +## License +GNU GENERAL PUBLIC LICENSE, Version 3 From 91f980e154c628513e71a5962f17e4f9525a5adc Mon Sep 17 00:00:00 2001 From: OneRadRedDad <119024055+OneRadRedDad@users.noreply.github.com> Date: Tue, 12 Mar 2024 19:44:54 -0400 Subject: [PATCH 3/6] Update README.md --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f7479bd..e3e7102 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ ## Synopsis -This project is a fork of [`derikb/character-sheet-app`](https://github.com/derikb/character-sheet-app), which is a responsive online/offline web app to act as a character sheet for tabletop roleplaying games (mostly D&D 5e). This fork focuses on expanding the features of the original project and making the app friendlier to TTRPG newbs. +This project is a fork of [`derikb/character-sheet-app`](https://github.com/derikb/character-sheet-app), which is a responsive online/offline web app to act as a character sheet for tabletop roleplaying games (mostly D&D 5e). +This fork focuses on expanding the features of the original project and making the app friendlier to TTRPG newbs. ## Planned Features -I plan to add the following features (in no particular order): +I plan to add the following features (in no order whatsoever): * Automated sheet population (such as populating your Saving Throws area based on your class) * Support for homebrew races/classes/items/etc. (by default, the app will only support SRD content from DnD 5e). @@ -17,20 +18,36 @@ I plan to add the following features (in no particular order): ## Motivation -I had a lot of the same motivations as derikb, with a few others. I thought maybe someone else would want these things too. +I had a lot of the same motivations as derikb. I wanted something electronic that new players could efficiently use and easily fill out and read. I wanted something free that did less than VTTs, but more than the billion fillable documents out there. I thought other people might want these things too. -## Contributors +## Contributions -I'm happy to accept feature requests, bug reports, and pull requests via the github repository. There is an eslint config file for javascript style, which your IDE should pick up. +I'm happy to accept feature requests, bug reports, and pull requests via the github repository. I cannot guarantee quick turnarounds with any of those things, however. Conventional Changelog is installed for commit messages. Standard Version is used for releases, changelogs, etc. ## Miscellaneous Disclaimers -This project and everything about it is a work in-progress by an amateur dev and git user. This project is not my job, I don't have an unlimited amount of free time to work on it, and I'm not very good at programming. This project will have bugs. It will not be completed quickly. It may not ever be completed. +This project and everything about it is a work in-progress by an amateur dev and git user. This project is not my job, I don't have an unlimited amount of free time to work on it, and I'm not very good at programming. -Stay tuned for updates to README.md and any other file I get my grubby hands on. +This project will have bugs. It will not be completed quickly. It may not ever be completed. + +Stay tuned for updates to README.md and every other file I get my grubby hands on. + +## Credits + +This project would not be possible without: + +* derikb and all the contributors to character-sheet-app, which this project is based on. +* 5etools for file organization inspiration + +This work includes material taken from the System Reference Document 5.1 (“SRD 5.1”) by Wizards of +the Coast LLC and available at https://dnd.wizards.com/resources/systems-reference-document. The +SRD 5.1 is licensed under the Creative Commons Attribution 4.0 International License available at +https://creativecommons.org/licenses/by/4.0/legalcode. ## License +This project is released under the following license: + GNU GENERAL PUBLIC LICENSE, Version 3 From 815085fe0369ea670cf79df61cbe845f4d55f40b Mon Sep 17 00:00:00 2001 From: OneRadRedDad <119024055+OneRadRedDad@users.noreply.github.com> Date: Tue, 12 Mar 2024 20:31:05 -0400 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e3e7102..e743b78 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,6 @@ https://creativecommons.org/licenses/by/4.0/legalcode. ## License -This project is released under the following license: +This project (excepting included licensed content from Wizards of the Coast) is released under the following license: GNU GENERAL PUBLIC LICENSE, Version 3 From 7145eb1784cb8d4218ed90399b79530d14833195 Mon Sep 17 00:00:00 2001 From: OneRadRedDad <119024055+OneRadRedDad@users.noreply.github.com> Date: Thu, 1 Jan 2026 23:24:01 -0500 Subject: [PATCH 5/6] Updates to index.html General grammar changes; fixed nested list in help window's Character Sheet section; replaced ol in help window's Action section with a dl; added a link to Google's Firebase Firestore; added some b tags when referencing buttons in the app --- dist/index.html | 95 +++++++++++++++++++++++++++++++------------------ 1 file changed, 60 insertions(+), 35 deletions(-) diff --git a/dist/index.html b/dist/index.html index 230bbc5..69870f7 100644 --- a/dist/index.html +++ b/dist/index.html @@ -1,5 +1,5 @@ - + @@ -55,8 +55,8 @@

Character Sheet. App.

@@ -146,7 +171,7 @@

Keyboard Shortcuts

@@ -176,7 +201,7 @@

Keyboard Shortcuts

Sign-in

By signing in, you can save data remotely, and then access your characters from any browser/device.

-

Your auth credentials are saved for use with Google's Firebase Firestore. I get access to very little information about you, other than email and some other publicly available profile data.

+

Your auth credentials are saved for use with Google's Firebase Firestore. I get access to very little information about you, other than email and some other publicly-available profile data.

@@ -184,7 +209,7 @@

Keyboard Shortcuts