Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle looping music, Indicate song with seamless loops in docs, automatic pre-releases #411

Draft
wants to merge 19 commits into
base: develop
Choose a base branch
from

Conversation

ViMaSter
Copy link
Member

@ViMaSter ViMaSter commented Jan 14, 2024

DRAFT PR UNTIL DYNAMIC ASSET LOAD SOFTLOCK IS RESOLVED

Summary

  • Implements Handle looping music #390
  • Extends the docs_generator to indicate which songs have seamless loops (🔁)
  • Updates the build pipeline to automatically create a pre-release whenever something is pushed to develop

I'd recommend looking at the PR with these filters to focus on the important stuff:
image

Before/after screenshots and/or animated gif

Songs previously only looped from start to finish. Composers can now specify loop-information: intros, loop-sections and outros.

If a song provided by the composers contains loop information, it is highlighted in the documentation:
image

Also changes the GitHub Release behavior to automatically create pre-releases whenever a build succeeds on develop.

Testing instructions

Find a song with loop markers embedded into the .ogg file. Play it and notice that the intro only is played once. Also a new GitHub pre-release should appear around 45 minutes after this is integrated into develop.

Additional information

@codecov-commenter
Copy link

codecov-commenter commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.98%. Comparing base (4e52fd1) to head (8bc0c1e).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #411      +/-   ##
===========================================
+ Coverage    81.38%   81.98%   +0.60%     
===========================================
  Files           91       92       +1     
  Lines         3046     3148     +102     
===========================================
+ Hits          2479     2581     +102     
  Misses         567      567              
Flag Coverage Δ
EditModeTests_Suites_Core 14.83% <0.96%> (-0.93%) ⬇️
EditModeTests_Suites_TextDecoder 16.04% <0.00%> (-0.54%) ⬇️
PlayModeTests_Suites_Playthrough 61.30% <100.00%> (+1.29%) ⬆️
PlayModeTests_Suites_Scenes 59.37% <100.00%> (+1.36%) ⬆️
PlayModeTests_Suites_Scripts 63.97% <100.00%> (+1.20%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ViMaSter ViMaSter force-pushed the loopDemo branch 2 times, most recently from 4abefcd to dbb2085 Compare January 20, 2024 23:07
@ViMaSter
Copy link
Member Author

ViMaSter commented Jan 20, 2024

If anyone wants to review it already:

Just need to hook the Script into the ObjectPreloader and make this an active PR. 👀

@ViMaSter ViMaSter changed the title loopdemo Handle looping music Jan 20, 2024
@ViMaSter ViMaSter force-pushed the loopDemo branch 2 times, most recently from c2313ac to 316404a Compare August 31, 2024 18:53
@ViMaSter ViMaSter marked this pull request as ready for review August 31, 2024 20:20
@ViMaSter ViMaSter force-pushed the loopDemo branch 9 times, most recently from 258ec85 to a027af4 Compare September 1, 2024 14:09
@ViMaSter ViMaSter changed the title Handle looping music Handle looping music, Indicate song with seamless loops in docs, automatic pre-releases Sep 1, 2024
@ViMaSter ViMaSter force-pushed the loopDemo branch 2 times, most recently from a029141 to c3ddd8b Compare September 1, 2024 21:49
Comment on lines +35 to +40
echo "version_number=$(date +'%Y.%m.%d')-$(echo $GITHUB_RUN_ID)" >> $GITHUB_OUTPUT
if [[ '${{ github.event.inputs.createRelease }}' == 'true' ]]; then
echo "version_name="Release v${{ needs.setVersionNumber.outputs.version_number }}" >> $GITHUB_OUTPUT
else
echo "version_name="Pre-release v${{ needs.setVersionNumber.outputs.version_number }}" >> $GITHUB_OUTPUT
fi
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous automation would've required us to set the version in Unity; now we just use a timestamp + GitHub Actions's unique run ID.

@ViMaSter ViMaSter marked this pull request as draft September 17, 2024 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Handle looping music Automatically create pre-release versions of the game whenever develop is updated
2 participants