https://github.com/woofers/ludum-dare-badges

🏆 SVG & PNG badges for Ludum Dare Game Jam results
https://github.com/woofers/ludum-dare-badges

api badge component ludum-dare png react reactjs svg widget

Last synced: about 22 hours ago
JSON representation

🏆 SVG & PNG badges for Ludum Dare Game Jam results

• Host: GitHub
• URL: https://github.com/woofers/ludum-dare-badges
• Owner: woofers
• License: mit
• Created: 2019-08-10T22:10:49.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T17:33:14.000Z (7 months ago)
• Last Synced: 2024-09-21T15:30:55.224Z (6 days ago)
• Topics: api, badge, component, ludum-dare, png, react, reactjs, svg, widget
• Language: TypeScript
• Homepage: https://badges.jaxs.onl
• Size: 3.58 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# @ludum-dare-badges

[![img](https://github.com/woofers/ludum-dare-badges/workflows/build/badge.svg)](https://github.com/woofers/ludum-dare-badges/actions)

API used to dynamically generate SVG and PNG Ludum Dare results badges in real-time.

**[Live Demo](https://badges.jaxs.onl)**

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

# Examples

**SVG Badge:**

![img](https://badges.jaxs.onl/44/alien-e-x-p-a-n-s-i-o-n/badge.svg "SVG Badge")

**PNG Badge:**

![img](https://badges.jaxs.onl/44/alien-e-x-p-a-n-s-i-o-n/badge.png "PNG Badge")

# Usage

Simply form the API query using your game's Ludum Dare entry page path.

The path is in the form `:event/:game/badge.` where:

-   `event` - Ludum Dare event number (eg. `44` for Ludum Dare 44)

-   `game` - Game title in the URL of the Ludum Dare entry page.

-   `type` - File type.  Can be either `svg` or `png`.  `svg` is recommenced if it is supported.

For example the SVG badge for [ALIEN, e x p a n s i o n .](https://ldjam.com/events/ludum-dare/44/alien-e-x-p-a-n-s-i-o-n)

the path would be `44/alien-e-x-p-a-n-s-i-o-n/badge.svg`

You can also think of it as adding `/badge.svg` to the existing Ludum Dare path:

![img](./screenshots/url.png "URL Path")

## Hosted

This path can be appended to the domain of `badges.vandoorn.ca` to form the image URL:

```cmd

badges.jaxs.onl/44/alien-e-x-p-a-n-s-i-o-n/badge.svg

```

Or more generalized:

```cmd

badges.jaxs.onl/:id/:game/badge.

```

## Self Hosting

Self hosting can done easily though [Vercel](https://vercel.com/home)'s serverless platform.

[![img](https://vercel.com/button "Deploy to Vercel")](https://vercel.com/import/project?template=woofers/ludum-dare-badges)

Simply install the [Vercel CLI](https://vercel.com/cli) with:

**Yarn**

```yarn

yarn global add vercel

```

**npm**

```npm

npm install -g vercel

```

and type `vercel` in the root of the monorepo.

To form the API query follow the steps above with and replace the domain

with the domain of your self hosted instance:

```cmd

/:id/:game/badge.

```