UltimateChristmas 4.0 Wiki

UltimateChristmas / Music & carols

Music & carols

Twenty-three note-block tracks ship in the jar: nineteen classic carols plus four originals the plugin uses as event cues. A festive radio, play-on-join, and automatic music at the right moments.

module id: music config: modules/music.yml needs: NoteBlockAPI

Playback needs NoteBlockAPI installed (soft dependency). Without it, the module stays quiet. The .nbs files live in plugins/UltimateChristmas/music/ — drop your own there and add them under tracks to use them.

Commands

/christmas music list            every track, with its length
/christmas music play <track>    play one for yourself
/christmas music radio           join/leave the festive radio
/christmas music stop            stop your playback

Permission: ultimatechristmas.music; controlling playback for other players needs ultimatechristmas.admin.music. A player's radio choice is remembered across reconnects.

Playback settings

volume: 0.7          # 0.0 to 1.0
play-on-join: ''     # a track key to start as players join (blank = none)

# The festive radio: a continuous playlist players opt into.
radio:
  enabled: true
  shuffle: true
  playlist:          # leave empty to cycle every track
    - jingle_bells
    - deck_the_halls
    - carol_of_the_bells
    - silent_night

Automatic cues

Short pieces the plugin plays by itself at specific moments. Set a cue to '' to silence just that one:

cues:
  enabled: true
  boss-spawn: uc_fanfare       # a boss appears
  boss-fight: uc_winter_siege  # looped during the fight
  advent-claim: uc_fanfare     # an advent door opens
  present-found: uc_fanfare    # a hidden present is opened
  tree-complete: uc_fanfare    # the community tree is finished

The bundled tracks

Every bundled track is an original note-block arrangement of a public-domain melody, or an original composition — free to redistribute.

KeyTrackSourceLength
angels_we_have_heard_on_highAngels We Have Heard on HighFrench traditional, "Gloria"34 s
away_in_a_mangerAway in a MangerW. J. Kirkpatrick, 189532 s
carol_of_the_bellsCarol of the BellsMykola Leontovych, 191638 s
coventry_carolCoventry CarolEnglish traditional, 153432 s
deck_the_hallsDeck the HallsWelsh traditional, "Nos Galan"30 s
ding_dong_merrily_on_highDing Dong Merrily on High"Branle de l'Official", 158829 s
god_rest_ye_merry_gentlemenGod Rest Ye Merry, GentlemenEnglish traditional, c. 176034 s
good_king_wenceslasGood King Wenceslas"Tempus Adest Floridum", 158231 s
hark_the_herald_angels_singHark! The Herald Angels SingFelix Mendelssohn, 184035 s
i_saw_three_shipsI Saw Three ShipsEnglish traditional, 17th c.21 s
jingle_bellsJingle BellsJ. L. Pierpont, 185744 s
jolly_old_saint_nicholasJolly Old Saint NicholasAmerican traditional, 186530 s
joy_to_the_worldJoy to the WorldLowell Mason / Handel, 183932 s
o_christmas_treeO Christmas TreeGerman traditional, "O Tannenbaum"33 s
o_come_all_ye_faithfulO Come, All Ye FaithfulJohn Francis Wade, c. 175149 s
silent_nightSilent NightFranz Xaver Gruber, 181842 s
the_first_noelThe First NoelEnglish traditional, Cornwall40 s
up_on_the_housetopUp on the HousetopBenjamin Hanby, 186427 s
we_wish_you_a_merry_christmasWe Wish You a Merry ChristmasEnglish traditional, West Country29 s
uc_fanfareFestive FanfareUltimateChristmas original8 s
uc_sleigh_bellsSleigh Bells (ambience)UltimateChristmas original20 s
uc_winter_siegeWinter Siege (boss theme)UltimateChristmas original11 s
uc_workshop_themeSanta's WorkshopUltimateChristmas original13 s

Adding your own tracks

tracks:
  my_song:
    file: "my_song.nbs"               # in plugins/UltimateChristmas/music/
    display_name: "&a&lMy Song"
    length_seconds: 45