DDRCardDraw

KO | EN

gitlite — search

#php #java #python #javascript #ruby #hacktoberfest #wordpress #nodejs #shell #c-plus-plus #logging #android

★ 43 Open GitHub ↗

Card draw / randomizer for use in music game tournaments including DDR, SMX, ITG, and PIU

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DDR Tools

[![Discord](https://img.shields.io/discord/1013159796024823898?label=discord&style=flat-square)](https://discord.gg/QPyEATsbP7)
[![GitHub contributors](https://img.shields.io/github/contributors/noahm/ddrcarddraw?style=flat-square)](https://github.com/noahm/DDRCardDraw/graphs/contributors)
[![GitHub branch checks state](https://img.shields.io/github/checks-status/noahm/ddrcarddraw/main?style=flat-square)](https://github.com/noahm/DDRCardDraw/actions/workflows/pr-checks.yml)
[![GitHub last commit](https://img.shields.io/github/last-commit/noahm/ddrcarddraw?style=flat-square)](https://github.com/noahm/DDRCardDraw/commits/main/)

The official build is available at [https://ddr.tools/](https://ddr.tools/)

Read all about what the app can do [in the user manual](https://github.com/noahm/DDRCardDraw/blob/main/docs/readme.md)

## Customizing / Contributing

This app can be easily customized for novel formats a tournament might use. If you have feature requests or ideas, you're welcome reach out on our [Discord server](https://discord.gg/QPyEATsbP7), [Facebook messenger](https://m.me/noah.manneschmidt), or [on Bluesky](https://bsky.app/profile/noahm.omg.lol).

If you want to take a stab at developing on the app yourself, you will need have node.js >= 22.0.0 installed along with [yarn](https://yarnpkg.com/). Some familarity with React will also help.

Fork this repo to your account and then clone the fork to your computer. Then the following commands will be useful:

```sh
# Before running anything else, do this!
# It's a one-time local install of dependencies needed to build the app.
yarn install

# local development will start, with app running at http://localhost:8080/
# edits to the files in ./src/ will automatically reload the browser
yarn start

# if you make changes to any game/song data in ./src/songs/ this will give
# a basic sanity check on the format and contents of it
yarn validate:json

# build a zipped, standalone copy of the app that runs entirely offline,
# jacket images and all! simply unzip somewhere and open index.html
yarn build:zip
```

## Data imports

There are some other useful scripts in `scripts/` that help in maintaining data integrity and pulling in new song data. Several have top-level aliases so you can conveniently update song data: (must have node and yarn installed, and run `yarn install` once, as above)

```sh
# download latest StepManiaX song data and jackets
yarn import:smx

# download latest DDR song data and jackets (blends data from KONAMI official site, 3icecream, RemyWiki and ZIv)
yarn import:ddr

# import an ITG/StepMania song pack into card draw
yarn import:itg path/to/pack/folder some-stub-name

# import the latest Pump it Up data using a data dump found here:
# https://github.com/AnyhowStep/pump-out-sqlite3-dump/
yarn import:pump path/to/pumpout/db
```

## Deployment

As mentioned above, running `yarn build` will create a distribution of the application with static content that can be used in a production environment in a multitude of ways. The following are options for deployment

### Local

Running `yarn build:zip` produces a zip file that can be extracted anywhere on your PC. Simply open the included `index.html` to start using DDRCardDraw. That's it!

### Docker/Containers

For more advanced users, a Dockerfile has been included to produce a docker image that can be deployed in any container environment, whether it is using the docker engine directly or using an orchestration tool like docker-compose or kubernetes.

```sh
docker build -t ddrcarddraw .
docker run ddrcarddraw
```

DDRCardDraw

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README