hergaiety/my_spells

Your personal D&D 5e Spellbook.

My Spells

My Spells is an open source web-based application to elegantly view spells and save them to your local spellbook.

License

Open Game License v1.0a Copyright 2000, Wizards of the Coast, Inc.

App contains content from the SRD and is restricted and covered by the OGL. You can find the OGL 1.0a at ogl.html in this app's repo, or online here. When using said data, please make sure to conform appropriately with the proper licenses and whatnot.

Credit

• ephe's grimoire spell list converted json by vorpalhex and cleaned up to meet OGL license standards labeled under srd_spells
• Built on Vue.js and the Quasar Framework
• Logo magic wand icon by David from the Noun Project

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:8080
$ npm run dev_web

# build for production with minification
$ npm run build_web # or build_app

# build cordova (android, iOS potentially in future) release
$ npm run build_app_cordova
# sign apk with android studio or jarsigner
# install on device
$ adp install cordova/platforms/android/build/apk/<BUILT-FILE.apk>

# lint code
$ npm run lint

my_spells's Issues

Search Improvements - By Level, By Class, By Tag

Currently search only searches through the names of spells. Ideally it could also search by level, class, and search through tags. (Descriptions keywords?)

Autocomplete may be half of the solution to guide users.

3 Characters Needed before Searching Works

Pagination is Lame for Browsability - Long Live Infinite Scrolling

Swap out pagination for infinite scrolling.

Confirm going "back" in the browser takes you where you expect to be.

Confirm speedy loads even when loading the whole list.

Break out query.js into npm module

query.js can be a standalone npm module. Should be extracted.

Antilife Shell spell is duplicated

Issue stems from source https://github.com/vorpalhex/srd_spells

Long Descriptions make spell card no longer fit on large screen

Such as on Animate Objects

Proposed Solution: Remove vertical centering nonsense, go with what works on small devices for larger ones as well.

Search Suggestions

Example: ani can autocomplete to animal

Probably relies on #12

Enlarge/Reduce spell page broken

Likely due to the name having a slash in it.

Android Native Release

Leverage Quasar's Play App functionality to launch app on the Play Store.

http://quasar-framework.org/guide/quasar-play-app.html

Page Title doesn't reflect current page

Should display Spell Name, useful for browsing history and when using the app with multiple tabs open.

Search Doesn't Reset Page

Repro

1. Paginate ahead (ex: page 4)
2. Filter with a search (ex: "fire")

Observe
User remains on page 4 instead of being brought to their results on page 1.

After Searching, Sort Goes Blank

1. Search
2. Clear Search

Expected Result: Sorting returns to what it was prior to searching.
Actual Result: Sorting looks empty.

Sort and Search difficult to reach when scrolled down.

Proposed solution: Back to Top fab button when not at top of page.

Right Click -> New Tab for spells?

Would be great if the spells link behaved more like a link that could be opened in a new tab.

Sorting By Level is Wrong

Cantrips show last. Should be 0, 1, 2 etc.

Filter by Class

Useful feature?

Likely! Previous version of the app allowed for this.

Write a new reverse index creation script

Android Native - Lag in All Spells with 1 or more chosen spells.