120 lines
No EOL
5.1 KiB
HTML
120 lines
No EOL
5.1 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Home</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Home</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3> </h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article><h1>XIV Character Cards</h1>
|
|
<p><img src="https://img.shields.io/npm/v/xiv-character-cards" alt="npm Version">
|
|
<a href="https://xivapi.github.io/XIV-Character-Cards/"><img src="https://img.shields.io/badge/docs-JSDoc-orange" alt="Documentation"></a></p>
|
|
<p>Library and API to create fancy cards for FFXIV characters based on their Lodestone data, powered by <a href="https://xivapi.com/">xivapi.com</a> and hosted at <a href="https://ffxiv-character-cards.herokuapp.com">https://ffxiv-character-cards.herokuapp.com</a>.</p>
|
|
<p><img src="https://ffxiv-character-cards.herokuapp.com/characters/id/9575452.png" alt="Demo image"></p>
|
|
<h2>API</h2>
|
|
<p>All API calls support the <code>lang</code> query parameter to create a character card with information in the specified language. The supported languages are the same as <a href="https://xivapi.com/docs/Common-Features#language">xivapi.com</a>, which are English (en), Japanese (ja), German (de) and French (fr).</p>
|
|
<p>E.g. a request for a german character card would look like this: <code>https://ffxiv-character-cards.herokuapp.com/characters/id/<LODESTONE ID>.png?lang=de</code></p>
|
|
<h3>Getting a card for a character by its Lodestone ID</h3>
|
|
<p><code>GET https://ffxiv-character-cards.herokuapp.com/characters/id/<LODESTONE ID>.png</code></p>
|
|
<h3>Getting card for a character by its world and name</h3>
|
|
<p><code>GET https://ffxiv-character-cards.herokuapp.com/characters/name/<WORLD>/<CHARACTER NAME>.png</code>
|
|
<br><strong>Note:</strong> This is considerably slower than the creation by ID, since the character has to be looked up in the Lodestone first.</p>
|
|
<br>
|
|
<p>If you are using this API together with an application that requires the API to respond very quickly, like Discord, you may need to ask it to "prepare" the card image for a character beforehand. The API will reply with its status, and in case of success, the URL to the final image.
|
|
<code>{"status":"ok","url":"/characters/id/123456789.png"}</code></p>
|
|
<h3>Requesting a card to be cached for a character by its Lodestone ID</h3>
|
|
<p><code>GET https://ffxiv-character-cards.herokuapp.com/prepare/id/<LODESTONE ID></code></p>
|
|
<h3>Requesting a card to be cached for a character by its world and name</h3>
|
|
<p><code>GET https://ffxiv-character-cards.herokuapp.com/prepare/name/<WORLD>/<CHARACTER NAME></code></p>
|
|
<h2>Library</h2>
|
|
<p>To use the card creator as a library in your Node.JS application, first install it as a dependency with:</p>
|
|
<pre class="prettyprint source lang-sh"><code>yarn add xiv-character-cards
|
|
# or
|
|
npm i xiv-character-cards
|
|
</code></pre>
|
|
<p>You can then instantiate the class <code>CardCreator</code> from the library, call the asynchronous <code>insureInit()</code> function to make sure all resources are loaded and then use the asynchronous <code>createCard()</code> function with your characters Lodestone ID. You will receive a promise that resolves to a <code>Buffer</code> of the PNG image of your card, that you can use in your bot or application.</p>
|
|
<p>Check the <a href="https://xivapi.github.io/XIV-Character-Cards/">library documentation</a> for more details.</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> The API server is not published as an NPM package, so if you want to host it yourself, clone the <a href="https://github.com/xivapi/XIV-Character-Cards">Github repository</a> and put the Express.JS webserver defined in the <code>server.js</code> file behind a reverse proxy.</p>
|
|
</blockquote>
|
|
<h3>Library example</h3>
|
|
<pre class="prettyprint source lang-js"><code>const { CardCreator } = require("xiv-character-cards");
|
|
const { writeFileSync } = require("fs");
|
|
|
|
const creator = new CardCreator();
|
|
const lodestoneId = "13821878";
|
|
|
|
async function example() {
|
|
await creator.ensureInit();
|
|
return creator.createCard(lodestoneId);
|
|
}
|
|
|
|
example()
|
|
.then(card => {
|
|
writeFileSync(`./${lodestoneId}.png`, card);
|
|
})
|
|
.catch(error => {
|
|
console.error('Creator initialization or card creation failed!');
|
|
console.error(error);
|
|
});
|
|
</code></pre></article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CardCreator.html">CardCreator</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Oct 17 2022 22:31:23 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html> |