Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Boilerplate Template for Popcorn.js Project

branch: master
README.md

Popcorn.js Boilerplate

This is the simplest imaginable collection of files needed to get started with Popcorn.js.

Who is this for?

  • Beginner coders who want to learn to write Popcorn plugins and build interactive videos
  • Advanced coders who like to do everything from scratch, except a few repetitive bits

What's included

  • A boilerplate index.html file with room for a style sheet and references to the minimal necessary scripts
  • A blank script.js file. This is where you put your page logic
  • The latest release version of Popcorn.js
  • A few plugin boilerplate scripts. Use these as a starting point to write your Popcorn plugins (popcorn.baseTemplate.js is my favorite)
  • popcorn-base - a plugin wrapper designed to make it much, much easier to write great plugins

Examples

One very simple example is included that uses the very basic Words plugin. Words is intended as an example of how to build a simple, flexible and reusable Popcorn plugin.

Resources

Popcorn API Documentation

http://popcornjs.org/documentation

Popcorn.js source code (fork it!)

https://github.com/mozilla/popcorn-js/

Popcorn-Base

Plugin wrapper utility to make it much easier to build robust, reusable plugins

https://github.com/brianchirls/popcorn-base/

Popcorn Maker

A graphical interface to Popcorn.js

http://mozillapopcorn.org/popcorn-maker/

Popcorn Community

Need help? Wanna show off something you made? Check out the mailing list or chat on IRC. The community is friendly and helpful.

http://popcornjs.org/community

License

Seriously.js is made available under the MIT License.

Individual plugins may be licensed differently. Check source code comments.

Credits

Popcorn Boilerplate is created and maintained by Brian Chirls

Popcorn.js is the work of many dedicated developers and is supported by:

Mozilla

Something went wrong with that request. Please try again.