react-ludum-dare

Display Ludum Dare Game Jam results in React

Usage no npm install needed!

<script type="module">
  import reactLudumDare from 'https://cdn.skypack.dev/react-ludum-dare';
</script>

README

React Ludum Dare

img img img img img

Display Ludum Dare Game Jam results in React.

Live Demo

Note: This project is community made and not endorsed by the offical Ludum Dare creator(s).

img

Installation

Yarn

yarn add react-ludum-dare

npm

npm install react-ludum-dare

Usage

import React from 'react'
import Widget from 'react-ludum-dare'

const App = () => (
  <Widget game="44/alien-e-x-p-a-n-s-i-o-n"
          showIcons={true}
          usePlaceholder={false}
  />
)

Simply add the game widget to the React application using JSX.

Props

Game

The namespace of the game on the ldjam site Required

game requires both the Ludum Dare number and the game title (eg. 44/alien-e-x-p-a-n-s-i-o-n for Ludum Dare 44)

Show Icons

showIcons indicates if icons are shown. Default: false

If un-set no icon will be placed beside any category.

Use Placeholder

usePlaceholder indicates if placeholder content should be used when loading. Default: false

If un-set the component will simply be hidden until data is loaded from the Ludum Dare API.