defaultMetadata

const defaultMetadata: {
  album: string;
  album_track: number;
  artist: string;
  background: string;
  charter: string;
  charter_audio: string;
  charter_bass: string;
  charter_bass_6f: string;
  charter_drums: string;
  charter_elite_drums: string;
  charter_guitar: string;
  charter_guitar_6f: string;
  charter_keys: string;
  charter_lower_diff: string;
  charter_pro_bass: string;
  charter_pro_guitar: string;
  charter_pro_keys: string;
  charter_rhythm: string;
  charter_rhythm_6f: string;
  charter_venue: string;
  charter_vocals: string;
  chord_snap_threshold: number;
  clean_vocals: boolean;
  cover: string;
  covered_by: string;
  credit_album_art_designed_by: string;
  credit_arranged_by: string;
  credit_background: string;
  credit_composed_by: string;
  credit_courtesy_of: string;
  credit_engineered_by: string;
  credit_license: string;
  credit_mastered_by: string;
  credit_mixed_by: string;
  credit_other: string;
  credit_performed_by: string;
  credit_produced_by: string;
  credit_published_by: string;
  credit_written_by: string;
  date_released: string;
  delay: number;
  diff_band: number;
  diff_bass: number;
  diff_bass_real: number;
  diff_bass_real_22: number;
  diff_bassghl: number;
  diff_drums: number;
  diff_drums_real: number;
  diff_elite_drums: number;
  diff_guitar: number;
  diff_guitar_coop: number;
  diff_guitar_coop_ghl: number;
  diff_guitar_real: number;
  diff_guitar_real_22: number;
  diff_guitarghl: number;
  diff_keys: number;
  diff_keys_ghl: number;
  diff_keys_real: number;
  diff_rhythm: number;
  diff_rhythm_ghl: number;
  diff_vocals: number;
  diff_vocals_harm: number;
  eighthnote_hopo: boolean;
  end_events: boolean;
  explicit_lyrics: boolean;
  five_lane_drums: boolean;
  genre: string;
  hopo_frequency: number;
  icon: string;
  link_bandcamp: string;
  link_bluesky: string;
  link_facebook: string;
  link_instagram: string;
  link_other: string;
  link_spotify: string;
  link_twitter: string;
  link_youtube: string;
  loading_phrase: string;
  location: string;
  modchart: boolean;
  multiplier_note: number;
  name: string;
  playlist: string;
  playlist_track: number;
  preview: PreviewTimes | null;
  preview_end_time: number;
  preview_start_time: number;
  pro_drums: boolean;
  rating: number;
  song_length: number;
  sub_genre: string;
  sub_playlist: string;
  sustain_cutoff_threshold: number;
  tags: string;
  tuning_offset_cents: number;
  venue_hint: string;
  video: string;
  video_end_time: number;
  video_loop: boolean;
  video_start_time: number;
  vocal_character_hint: string;
  vocal_gender: string;
  vocal_scroll_speed: number | null;
  year: string;
};

Default values for known song.ini [Song] fields.

Type Declaration

Name	Type	Default value	Description
`album`	`string`	`'Unknown Album'`	-
`album_track`	`number`	`16000`	-
`artist`	`string`	`'Unknown Artist'`	-
`background`	`string`	`''`	-
`charter`	`string`	`'Unknown Charter'`	-
`charter_audio`	`string`	`''`	-
`charter_bass`	`string`	`''`	-
`charter_bass_6f`	`string`	`''`	-
`charter_drums`	`string`	`''`	-
`charter_elite_drums`	`string`	`''`	-
`charter_guitar`	`string`	`''`	-
`charter_guitar_6f`	`string`	`''`	-
`charter_keys`	`string`	`''`	-
`charter_lower_diff`	`string`	`''`	-
`charter_pro_bass`	`string`	`''`	-
`charter_pro_guitar`	`string`	`''`	-
`charter_pro_keys`	`string`	`''`	-
`charter_rhythm`	`string`	`''`	-
`charter_rhythm_6f`	`string`	`''`	-
`charter_venue`	`string`	`''`	-
`charter_vocals`	`string`	`''`	-
`chord_snap_threshold`	`number`	`0`	-
`clean_vocals`	`boolean`	`false`	-
`cover`	`string`	`''`	-
`covered_by`	`string`	`''`	-
`credit_album_art_designed_by`	`string`	`''`	-
`credit_arranged_by`	`string`	`''`	-
`credit_background`	`string`	`''`	-
`credit_composed_by`	`string`	`''`	-
`credit_courtesy_of`	`string`	`''`	-
`credit_engineered_by`	`string`	`''`	-
`credit_license`	`string`	`''`	-
`credit_mastered_by`	`string`	`''`	-
`credit_mixed_by`	`string`	`''`	-
`credit_other`	`string`	`''`	-
`credit_performed_by`	`string`	`''`	-
`credit_produced_by`	`string`	`''`	-
`credit_published_by`	`string`	`''`	-
`credit_written_by`	`string`	`''`	-
`date_released`	`string`	`''`	`yyyy-MM-dd` or `yyyy-MM`, as written.
`delay`	`number`	`0`	Units of ms
`diff_band`	`number`	`-1`	-
`diff_bass`	`number`	`-1`	-
`diff_bass_real`	`number`	`-1`	-
`diff_bass_real_22`	`number`	`-1`	-
`diff_bassghl`	`number`	`-1`	-
`diff_drums`	`number`	`-1`	-
`diff_drums_real`	`number`	`-1`	-
`diff_elite_drums`	`number`	`-1`	-
`diff_guitar`	`number`	`-1`	-
`diff_guitar_coop`	`number`	`-1`	-
`diff_guitar_coop_ghl`	`number`	`-1`	-
`diff_guitar_real`	`number`	`-1`	-
`diff_guitar_real_22`	`number`	`-1`	-
`diff_guitarghl`	`number`	`-1`	-
`diff_keys`	`number`	`-1`	-
`diff_keys_ghl`	`number`	`-1`	-
`diff_keys_real`	`number`	`-1`	-
`diff_rhythm`	`number`	`-1`	-
`diff_rhythm_ghl`	`number`	`-1`	-
`diff_vocals`	`number`	`-1`	-
`diff_vocals_harm`	`number`	`-1`	-
`eighthnote_hopo`	`boolean`	`false`	-
`end_events`	`boolean`	`true`	-
`explicit_lyrics`	`boolean`	`false`	-
`five_lane_drums`	`boolean`	`false`	-
`genre`	`string`	`'Unknown Genre'`	-
`hopo_frequency`	`number`	`0`	-
`icon`	`string`	`''`	-
`link_bandcamp`	`string`	`''`	-
`link_bluesky`	`string`	`''`	-
`link_facebook`	`string`	`''`	-
`link_instagram`	`string`	`''`	-
`link_other`	`string`	`''`	-
`link_spotify`	`string`	`''`	-
`link_twitter`	`string`	`''`	-
`link_youtube`	`string`	`''`	-
`loading_phrase`	`string`	`''`	-
`location`	`string`	`''`	-
`modchart`	`boolean`	`false`	-
`multiplier_note`	`number`	`0`	-
`name`	`string`	`'Unknown Name'`	-
`playlist`	`string`	`''`	-
`playlist_track`	`number`	`16000`	-
`preview`	`PreviewTimes` \| `null`	-	Units of ms: both preview times, written `<start> <end>`. YARG reads it over `preview_start_time` and `preview_end_time`.
`preview_end_time`	`number`	`-1`	Units of ms
`preview_start_time`	`number`	`-1`	Units of ms
`pro_drums`	`boolean`	`false`	-
`rating`	`number`	`0`	1 Family Friendly, 2 Supervision Recommended, 3 Mature, 4 No Rating, 5 Sensitive Content; 0 isn’t set.
`song_length`	`number`	`0`	Units of ms
`sub_genre`	`string`	`''`	-
`sub_playlist`	`string`	`''`	-
`sustain_cutoff_threshold`	`number`	`-1`	-
`tags`	`string`	`''`	`cover` marks a cover.
`tuning_offset_cents`	`number`	`0`	-
`venue_hint`	`string`	`''`	-
`video`	`string`	`''`	-
`video_end_time`	`number`	`-1`	Units of ms
`video_loop`	`boolean`	`false`	-
`video_start_time`	`number`	`0`	-
`vocal_character_hint`	`string`	`''`	-
`vocal_gender`	`string`	`''`	0 to 3 or a name: female, male, nonbinary or other.
`vocal_scroll_speed`	`number` \| `null`	-	A percentage, or `null` when it isn’t set.
`year`	`string`	`'Unknown Year'`	-

scan-chart

scan-chart API

scan-chart/competitive API

Type Declaration