diff --git a/README.md b/README.md
index 850f12d..b1b7a3d 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ I hate fillable pdfs. I couldn't find a sharp pencil for the character sheet I p
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.
+For remote saving you will have to add your own firebase configs to `./src/config/firebase.js` and rebuild the app.
## Local Server
@@ -26,12 +26,14 @@ For remote saving you will have to add your own firebase configs to `./src/confi
### Server
-* Point your server at the repo so it opens `./dist/index.html`. That's about it...
+- 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:
+
+- 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;
@@ -42,14 +44,13 @@ If you want to take advantage of the offline mode, it's a little more complicate
}
```
-
## 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.
+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.
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.
Character Sheet. App.
An online character sheet for tabletop role-playing games, usable offline (in some browsers).
-
Designed for modern browsers, if all else fails Chrome is your best bet and Safari is your worst bet.
-
Warning: Unless you login, character data is saved to your browser's local storage. This means it can be erased if you delete browser data and will not automatically transfer between browsers even on the same computer. Please Save and Backup often (or at least at the end of every gaming session)!
+
This app is designed for modern browsers. For loading this app, Chrome is your best bet and Safari is your worst bet.
+
Warning: Unless you login, character data is saved to your browser's local storage. This means it can be erased if you delete browser data and will not automatically transfer between browsers even on the same computer. Please Save and Backup often (or at least at the end of every gaming session)!
This message will only appear until you save your first character.
@@ -64,51 +64,76 @@
Character Sheet. App.
Most importantly
-
This app only saves data to your browsers' local storage. If your browser's data is deleted, your saved characters will be deleted. Use the backup options to save character data when you make changes.
-
To save remotely, login via the "Login" button and then use the Sync option to save data remotely. Right now the only Auth is via Google.
+
This app only saves data to your browsers' local storage. If your browser's data is deleted, your saved characters will be deleted. Use the backup options to save character data when you make changes.
+
To save remotely, login via the Login button and then use the Sync option to save data remotely. Right now, the only Auth is via Google.
This app is designed for modern web browsers.
After you've loaded the app, it will work offline in Chrome, Firefox, and Safari (desktop) as well as Safari (iOS) and Chrome (Android). Chrome (iOS) does not seem to work offline, and I haven't tried any other browsers.
Actions
-
-
Save This will save the current character to local storage. If the character already exists it will update.
-
Load This will show you a list of saved characters (if you have any). Clicking on a character's name will load that character. Note: You will lose any unsaved data if you load a character without saving the one currently displayed.
-
New Character This will load up a new/blank character sheet. Note: You will lose any unsaved data if you create a new character without saving the one currently displayed.
-
File Backup This will create data in the JSON format that can be loaded into this app in another browser/device. It will either:
+
+
Save
+
+ This saves the current character to local storage. If the character already exists, it saves the updated version.
+
+
Load
+
+ This shows you a list of saved characters (if you have any). Clicking on a character's name loads that character. Note: You will lose any unsaved data if you load a character without saving the one currently displayed.
+
+
New Character
+
+ This loads a new/blank character sheet. Note: You will lose any unsaved data if you create a new character without saving the one currently displayed.
+
+
File Backup
+
+ This creates data (in the JSON format) that can be loaded into this app in another browser/device. The File Backup option either:
-
Generate a download file with the currently viewed character's backup data.
-
Pop up the currently viewed character's backup data so it can be copied and pasted somewhere else.
+
Generates a download file with the currently viewed character's backup data or
+
Displays the currently viewed character's backup data so it can be copied and pasted somewhere else.
-
-
Email Backup This will open your default email client and start a new message containing the currently viewed character's backup data as well as instructions on how to use that data.
-
Restore Backup This opens a form for uploading a file or pasting in character backup data to save that character in the current browser. If the character already exists they will be updated to match the restored data (so be careful).
-
Login Authenticate via a Google account to save data remotely.
-
Sync/Logout Download/Upload data to/from the remote database; logout.
-
+
+
Email Backup
+
+ This opens your default email client and start a new message containing the currently viewed character's backup data as well as instructions on how to use that data.
+
+
Restore Backup
+
+ This opens a form for uploading a file or pasting in character backup data to save that character in the current browser. If the character already exists, they will be updated to match the restored data (so be careful).
+
+
Login
+
+ Authenticates via a Google account to save data remotely.
+
+
Sync/Logout
+
+ Download/Upload data to/from the remote database; logout.
+
+
Character Sheet
-
Click on data or empty areas to edit. Data is NOT automatically saved; you must hit the Save button (or use the keyboard shortcut).
-
Press enter while editing any list field to add another empty field to the list. (Use Shift+Enter to add a new line.)
-
For 5e:
-
Ability, saving throw, and skill modifiers are all automatically calculated when the proficiency, ability, save, or skill fields are changed.
-
All other fields are manually changed.
-
Spell lists only appear if the corresponding spell slot is greater than 0.
-
+
Click on data or empty areas to edit. Data is NOT automatically saved; you must click or tap Save (or use the keyboard shortcut).
+
Press ENTER while editing any list field to add another empty field to the list. (Use Shift+Enter to add a new line.)
+
For 5e:
+
+
Ability, saving throw, and skill modifiers are all automatically calculated when the proficiency, ability, save, or skill fields are changed.
+
All other fields are manually changed.
+
Spell lists only appear if the corresponding spell slot is greater than 0.
+
+
Keyboard Shortcuts
-
Keys
Action
+
Key(s)
Action
-
Ctrl+Shift+ArrowDown
Save current character
-
Ctrl+Shift+ArrowLeft
Switch Tabs
-
Ctrl+Shift+ArrowUp
Toggle Load Character menu (and focus on it).
-
Esc
Close modals/dialogs.
-
ArrowRight, ArrowLeft
Navigate the action toolbar at the top.
+
Ctrl+Shift+ArrowDown
Save current character
+
Ctrl+Shift+ArrowLeft
Switch Tabs
+
Ctrl+Shift+ArrowUp
Toggle Load Character menu (and focus on it).
+
Esc
Close modals/dialogs.
+
ArrowRight, ArrowLeft
Navigate the action toolbar at the top.
@@ -146,7 +171,7 @@
Keyboard Shortcuts
Delete Characters
-
This will delete locally stored characters. If you have saved characters remotely, use the sync modal to remove the remote copies.
+
This deletes locally-stored characters. If you have saved characters remotely, use the sync modal to remove the remote copies.
@@ -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
You are signed in...
-
Sync data between the remote database and your local browser. If you are using multiple devices make sure to save and sync before switching between them. Don't forget to backup.
+
Sync data between the remote database and your local browser. If you are using multiple devices, make sure to save and sync before switching between them. Don't forget to backup.
@@ -198,7 +223,7 @@
Keyboard Shortcuts
Sync Characters with Remote
WARNING: There is currently no merge conflict resolution on the syncing. You can either download or upload but both operations will overwrite data NOT merge it. (I still need to figure out how to handle that well.)
-
If you are working with multiple devices/browsers, please be aware of this. Don't edit in both places without first saving and up/downloading.
+
If you are working with multiple devices/browsers, please be aware of this. Don't edit in both places without first saving and uploading/downloading.