aly/XIV-Character-Cards
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
API to create fancy cards for FFXIV characters based on their Lodestone data, hosted at https://ffxiv-character-cards.herokuapp.com.
22 commits 4 branches 0 tags 6.6 MiB
JavaScript 100%
Find a file
karashiiro 54e7f62273
Add .npmignore for NPM package uploads (#2) 
This excludes index.js and test.js from being uploaded to NPM, which are not needed when this is used as a library.
2021-05-26 10:45:22 -07:00
cj/1 Add files via upload 2021-05-25 15:22:08 -04:00
.gitignore Add 4-hour caching for all generated images 2021-05-26 16:41:51 +02:00
.npmignore Add .npmignore for NPM package uploads (#2) 2021-05-26 10:45:22 -07:00
chara.png Add files via upload 2021-05-25 15:22:08 -04:00
chara_n.png Add express server, cleanup 2021-05-25 23:54:48 +02:00
create-card.js Cleanup crest drawing 2021-05-26 18:35:16 +02:00
index.js Add /prepare endpoint 2021-05-26 18:15:23 +02:00
minion.png Add mounts & minions 2021-05-26 01:03:30 +02:00
mount.png Add mounts & minions 2021-05-26 01:03:30 +02:00
package-lock.json Add 4-hour caching for all generated images 2021-05-26 16:41:51 +02:00
package.json Add 4-hour caching for all generated images 2021-05-26 16:41:51 +02:00
readme.md Update readme.md 2021-05-26 19:05:18 +02:00
SourceSansPro-Regular.ttf Add express server, cleanup 2021-05-25 23:54:48 +02:00
SourceSansPro-SemiBold.ttf Add express server, cleanup 2021-05-25 23:54:48 +02:00
test.js Add express server, cleanup 2021-05-25 23:54:48 +02:00

readme.md

XIV Character Cards

API to create fancy cards for FFXIV characters based on their Lodestone data, hosted at https://ffxiv-character-cards.herokuapp.com.

Demo image

Endpoints

Getting images

https://ffxiv-character-cards.herokuapp.com/characters/id/<LODESTONE ID>.png
Get the PNG for a character by its Lodestone ID.


https://ffxiv-character-cards.herokuapp.com/characters/name/<WORLD>/<CHARACTER NAME>.png
Get the PNG for a character by its world and name.

Requesting images to be cached

If you are using this API together with an application that requires the API to respond very quickly, like Discord, you need to ask it to "prepare" the image for a character beforehand.

https://ffxiv-character-cards.herokuapp.com/prepare/id/<LODESTONE ID>
Request a character image to be cached by its Lodestone ID.


https://ffxiv-character-cards.herokuapp.com/prepare/name/<WORLD>/<CHARACTER NAME>
Request a character image to be cached by its world and name.

The API will reply with its status, and in case of success, the URL to the final image. {"status":"ok","url":"/characters/id/123456789.png"}

Using in your application

You can use the create-card.js file in any NodeJS project. It will return a PNG-buffer for you to use in your bot or application.
Check index.js for usage examples.