DeckDeckGo - Gamepad

Create a PWA presentation using Web Components, Ionic components and HTML or Markdown 🚀

Cherry on the cake 🍒🎂 DeckDeckGo comes with a Progressive Web App to remote control your slides 📱

Table of contents

• Gamepad
• Getting Started
  • Using from a CDN
  • Install from NPM
  • Framework integration
• Usage
• Develop
• License

Gamepad

This project allows you to control your DeckDeckGo presentation with a Gamepad. Under the hood, it relies on @gamepad/core, a wrapper around the Web's Gamepad API. Currently, it supports Nintendo's Joy-Con, but if you'd like to see support for your favorite controller, feel free to open an issue on the Gamepad repository.

Getting Started

If you just wish to give a try, jump to the Develop chapter of this readme.

Otherwise, start first your new new presentation like described in the quick 👉 Getting Started guide 👈

Once done, install this Web Component as described in the following chapters and implement its usage as described in the Usage chapter of this readme or have a look at the provided examples in src/index.html.

Using from a CDN

It's recommended to use unpkg to use this component from a CDN. To do so, add the following include script in the main HTML file of your project:

<script src="https://unpkg.com/deckdeckgo-gamepad@latest/dist/deckdeckgo-gamepad.js"></script>

Install from NPM

Install it in your project from npm using the following command:

npm install deckdeckgo-gamepad

Framework integration

The Stencil documentation provide examples of framework integration for Angular, React, Vue and Ember.

Usage

  <deckgo-gamepad></deckgo-gamepad>

  <deckgo-deck></deckgo-deck>

Develop

To develop and run this Web Component locally, proceed as following:

git clone https://github.com/deckgo/deckdeckgo-gamepad
cd deckdeckgo-gamepad
npm install
npm run start

License

MIT © Nate Moore and David Dal Busco