Skip to content
Flipnote.js

Get Started

Installation

There are multiple options for installing flipnote.js, depending on your use-case and familiarity with JavaScript. Once you’ve installed the library, check out the Recipes page for some quick usage tips.

From a CDN (web)

This is the most straightforward way to embed the library in your web project, since you don’t have to host the script yourself and you will automatically receive updates until the next major version. To use this, drop the following snippet into the <head></head> of your page’s HTML:

<script src="https://cdn.jsdelivr.net/npm/flipnote.js@6"></script>

When including the library this way, all of the global exports will be available on window.flipnote.

Self-host (web)

You can also download the latest version of the library and self-host it on your own server if you prefer. You will have to manage updates yourself this way.

Development version
Uncompressed, with source comments included. Intended for debugging.

Production version
Minified and optimized version.

When including the library this way, all of the global exports will be available on window.flipnote.

From NPM (web, node)

Flipnote.js is also available as a package on NPM. For this, you’ll need to have a NodeJS environment and access to a command line.

To use this method on the web, you should run your code through a bundler like Vite, Parcel, Rollup, or Webpack.

Then you can import the library via an ES6 import:

import flipnote from 'flipnote.js';

Or via the old require() way:

const flipnote = require('flipnote.js');

When using the library this way, all of the global exports will be available as the default import.