Upstream

.github/dependabot.yml

@@ -14,3 +14,11 @@ updates:
         dependency-type: "production"
       development-dependencies:
         dependency-type: "development"
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Look for GitHub Actions workflows in the `root` directory
+    directory: "/"
+    # Check the for updates once a week
+    schedule:
+      interval: "weekly"

.github/workflows/pr-checks.yml

@@ -1,24 +1,55 @@
-name: PR Checks
+name: Checks
 
 on:
   pull_request:
     branches: [main]
 
 jobs:
   validate:
-    name: Validate & Build
+    name: Validate Song Data
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: "yarn"
       - run: yarn --immutable
       - run: yarn validate:json
-        name: Validate Song Data
+
+  typecheck:
+    name: Typecheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "yarn"
+      - run: yarn --immutable
       - run: yarn validate:ts
-        name: Validate Types
-      - run: yarn webpack
-        name: Build App
+
+  formatting:
+    name: Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "yarn"
+      - run: yarn --immutable
+      - run: yarn validate:format
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "yarn"
+      - run: yarn --immutable
+      - name: Build App
+        run: yarn webpack

.gitignore

@@ -9,3 +9,4 @@
 dist
 node_modules
 /*.zip
+scripts/scraping/textage/**

.prettierignore

@@ -0,0 +1,2 @@
+src/assets/jackets/*
+tsconfig.json

.tool-versions

@@ -1 +1,3 @@
 nodejs 20
+# pinned to an older version see: https://github.com/twuni/asdf-yarn/issues/33#issuecomment-1821442812
+yarn 1.22.19

.yarn/patches/@types-papaparse-npm-5.3.14-864eddd3a0.patch

@@ -0,0 +1,36 @@
+diff --git a/index.d.ts b/index.d.ts
+index 9c9fd674e1ac8eebbce1bfcfa0ea3d6cf07835cf..908b60f84f0ccfe723937feda37f02e494a57881 100644
+--- a/index.d.ts
++++ b/index.d.ts
+@@ -1,6 +1,3 @@
+-/// <reference types="node" />
+-
+-import { Duplex } from "stream";
+
+ export as namespace Papa;
+
+@@ -58,15 +55,6 @@ export function parse<T>(
+             | ParseRemoteConfig<T>
+         ),
+ ): void;
+-/**
+- * Parse in a node streaming style
+- * @param stream `NODE_STREAM_INPUT`
+- * @param config a config object.
+- * @returns a node duplex stream.
+- *
+- * @see https://github.com/mholt/PapaParse#papa-parse-for-node
+- */
+-export function parse(stream: typeof NODE_STREAM_INPUT, config?: ParseConfig): Duplex;
+
+ /**
+  * Unparses javascript data objects and returns a csv string
+@@ -121,7 +109,7 @@ export let RemoteChunkSize: number;
+ export let DefaultDelimiter: string;
+
+ /** File object */
+-export type LocalFile = File | NodeJS.ReadableStream;
++export type LocalFile = File;
+
+ /**
+  * On Papa there are actually more classes exposed

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.0.2.cjs
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

README.md

@@ -1,16 +1,19 @@
 # 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) ![GitHub branch checks state](https://img.shields.io/github/checks-status/noahm/ddrcarddraw/main?style=flat-square) ![GitHub last commit](https://img.shields.io/github/last-commit/noahm/ddrcarddraw?style=flat-square) ![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/noahm/DDRCardDraw?style=flat-square)
+[![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/).
+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)
+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 any format a tournament might use, including adding song data for other games. If you have 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 the fediverse](https://mastodon.content.town/@noahm).
+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 the fediverse](https://mastodon.content.town/@noahm).
 
-If you want to take a stab at developing features yourself, you will need have node.js >= 18.0.0 installed along with [yarn](https://yarnpkg.com/) and some familarity with React probably helps.
+If you want to take a stab at developing on the app yourself, you will need have node.js >= 18.0.0 installed along with [yarn](https://yarnpkg.com/). Some familarity with React will also help.
 
 Clone this repo to your computer. Then the following commands will be useful:
 
@@ -50,5 +53,3 @@ yarn import:itg path/to/pack/folder some-stub-name
 # https://github.com/AnyhowStep/pump-out-sqlite3-dump/
 yarn import:pump path/to/pumpout/db
 ```
-
-Ideas for future develoment are now being tracked as issues on this repo. Feel free to jump in if you want to help build out something new!

docs/readme.md

@@ -34,11 +34,23 @@ Some of the less self-explanatory settings are described below.
 ![Screenshot of the settings drawer](images/settings-drawer.png)
 
 <dl>
+<dt>Free picks
+<dd>Adds extra empty placeholder cards to the beginning of each draw which can be replaced with player picks.
+
 <dt>Reorder by pick/ban
 <dd>Moves charts to the beginning or end of the set when charts are protected or vetoed.
 
-<dt>Pocket picks must match draw options
-<dd>Limits charts selected in a pocket pick action to those that match current draw settings
+<dt>Picks must match draw options
+<dd>Limits charts selected in a free/pocket pick action to those that match current draw settings.
+
+<dt>Sort by chart level
+<dd>Sorts the drawn charts by difficulty level, from lowest on the left, to highest on the right. When not enabled the chart order is randomized.
+
+<dt>Use granular levels
+<dd>Some game data (DDR A3) has additional, more granular comunity-provided difficulty level available for use. (SanbaiIceCream Tiers) When this setting is enabled "Lvl Min" and "Lvl Max" can be set to sub-level values, and sub-level buckets are available within the Weighted Distribution settings.
+
+<dt>Hide vetoed charts
+<dd>When players take a veto action on a chart, hide from view it completely, rather than simply marking it as vetoed.
 </dl>
 
 ### Weighted Distributions
@@ -70,8 +82,8 @@ The weighted distribution options allows you to replace the natrual chances of s
 <dt>Force Expected Distribution
 <dd>Reduces randomness by preventing any outlier draws that contain more than the expected number of charts of each difficulty level. (e.g. For the above example, this would limit a 3 card draw to either zero or one level 22 chart.)
 
-<dt>Group Top End Charts
-<dd>Allows grouping charts of multiple levels into a single "bucket". This helps when you want a higher probability of hard stuff, but your game of choice has a very limited number of charts at the highest levels.
+<dt>Group cards into this many buckets
+<dd>A very versatile setting. At lower numbers it will combinine charts across multiple levels into fewer "difficulty buckets" that span several levels, or at higher numbers (when combined with "Use granular levels") can divide individual levels down into sub-level ranges that can be weighted differently.
 </dl>
 
 ## Actions
@@ -118,12 +130,16 @@ Once enabled, labels appear above each drawn set of cards. Players and round nam
 
 ## Preview Eligible Charts
 
-A toggle to "Show eligible charts" is included at the top (in the settings drawer for mobile devices) and can be useful for multiple reasons. First and foremost, it allows easy review of the current song data and helps catch issues. Any special song categories like "Unlockable songs" can be shown separately to confirm the appropriate categorization.
+A toggle to "Show eligible charts" is included at the top (in the settings drawer for mobile devices) which lists all charts that _could be drawn_ by current settings along with a histogram chart to provide a quick summary of the overall difficulty pool. First and foremost, it allows easy review of the current song data and helps catch issues. Any special song categories like "Unlockable songs" can be shown separately to confirm the appropriate categorization.
 
-Second, a color-coded histogram is displayed at the top to provide a quick summary of the over-all difficulty pool included by the current settings. This can also be handy to summarize an entire game's song library by using the settings to include all charts.
+Second, it can also be handy to summarize an entire game's song library by using the settings to include all charts, or to view the subset of a game's charts that are used according to specific tournament settings.
 
 ![Screenshot of eligible charts toggle enabled](images/eligible-charts.png)
 
+### Export Chart Data
+
+While viewing the list of eligible charts, the "Export Chart Data" button (icon only for mobile devices) will save the current list of charts as a CSV file for future reference or data processing.
+
 ## Save as Image
 
 Each drawn set has a camera icon in the top right. This saves an image of the current set with a transparent background suitable for use in stream layouts and other such designs. Resize your browser window to adjust the aspect ratio of the generated image.
@@ -140,7 +156,13 @@ The app is aware of when it is loaded into an OBS Browser Source and will automa
 
 ## SM5/ITG imports
 
-Custom builds with data files based on ITG song packs are trivial to prepare. The only requirements are a working installation of `node.js` and `yarn`, and a copy of this project.
+Running card draw based on local ITG song packs are trivial to prepare. Simply drag and drop the pack folder into the browser window to begin. Local data imports only last until your browser tab is closed or reloaded.
+
+![Screenshot of a dialog confirming a local data import](images/local-import-dialog.png)
+
+The app has special support for tiered packs as used in some tournaments where each song title includes a tier tag `[T01] Song Name`. When importing in tiered mode, the draw settings will allow you to draw charts based on the given tier rather than the chart difficulty levels.
+
+You can also make a persistent import of local data using a local development copy of the project.
 
 In a terminal:
 
@@ -155,6 +177,9 @@ yarn
 # providing a stub name without spaces
 yarn import:itg path/to/pack/folder some-stub-name
 
+# OR, if importing a tiered pack
+yarn import:itg path/to/pack/folder some-stub-name tiered
+
 # then you have a choice of either of the following:
 
 # start a local development server.
@@ -166,8 +191,6 @@ yarn start
 yarn build
 ```
 
-The app also has special support for "tiered" packs used in tournaments where songs of different groups are organized by tier using prefixes of the form `[T01] Song Name`. When importing packs of this style, add `tiered` as an additional import arg after your stub name.
-
 # Contact
 
 DDR Tools is primarily developed by me, Noah Manneschmidt, aka Cathadan. I'm open to contact on a variety of platforms: