Comments (3)
This is a GREAT idea, and definitely needs some design/attention.
What are the use cases here?
I would anticipate that a large 1 time export is more likely than a smaller single-item on-demand export.
This pushes me towards desigining a bulk export feature rather than a new resource.
And if we're doing a bulk export, why not do that at build-time?
That being said, there are some simple use cases that would be one-time exports. The one I have in mind is a button on a monster that's basically "send to Homebrewery" that converts the current item into homebrewery-friendly markdown and pushes it over there. I already have that here though:
open5e/open5e#395
from open5e-api.
And if we're doing a bulk export, why not do that at build-time?
I've been experimenting with this. I create separate json files for each creature during build and host them from the web server as static files. Test is live on https://5e.spetland.no/monsters/a-mi-kuk . Clicking on JSON format at the bottom navigates to the correct json file. Supporting more export formats could be done by converting and storing that format as another option.
This does require you to host over a thousand static assets just for the monsters, but so far I've not run into any issues with it. Might need a CDN in the future
from open5e-api.
Here's my preferred approach for this:
- Only export v2 data.
- Have the tabular data match 1 to 1 with the tables. - I'm pretty sure this can be done on our build agents because they have the sqlite3 cli.
- Have the data available as an Asset in the release link on github.
- Have the data automatically added to a given Release.
I'm not sure I know enough about github and releases to automatically do this, but the commands to export should be pretty simple.
from open5e-api.
Related Issues (20)
- A5e Missing Resources HOT 2
- v2 export command edits v1 json files HOT 3
- Way to compare if a v1 data item has not been converted to v2 HOT 1
- Spell markdown breaks due to base_url placeholders
- Search allow for post/head/options verbs HOT 1
- Document the primary key conventions HOT 1
- Create a german SRD source file in json format to be able to later use the API in german HOT 2
- Add hit dice to sizes model
- v2 feature: equivalents
- v2 Lookup by key
- Add Monster filter for 'habitat' similar to 'cr'. HOT 2
- V2 search breaks when searching for "ring" HOT 1
- Deprecate v1 search
- Clean up and upgrade dependencies
- v2 Distance and/or speed solutions. HOT 2
- Some NPCs messed up in the A5e Menagerie v1 HOT 1
- Add Monsters from Kobold Press's Black Flag HOT 3
- A5e Spells missing areas
- V2 - items are immune to damage types.
- v2 Consider _all as a suffix not a prefix on fields
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from open5e-api.