Merge pull request #1242 from etternagame/develop

0.72.2 merge
etternagame · Mar 2, 2023 · d91ef98 · d91ef98
2 parents 5acb2a3 + c3be680
commit d91ef98
Show file tree

Hide file tree

Showing 262 changed files with 1,897 additions and 7,228 deletions.
diff --git a/.changelog/Release_0-72-2.md b/.changelog/Release_0-72-2.md
@@ -0,0 +1,37 @@
+# Release Changelog
+
+
+## [0.72.2] - 2023-03-01 - Hotfix
+
+### Added
+- Custom Window Config file has had some short instructions added for recommended use. No plans to move the config to a Save file, because of the nature of saving a Lua function in text - [9e92f37](../../../commit/9e92f37884f8114f9d0801fa7d5b19ab287cf7f0)
+- Lua can take advantage of new Message Broadcasts that occur when certain F2 related events occur, ReloadedScripts, ReloadedMetrics, ReloadedOverlayScreens, ReloadedTextures - [c7b68fa](../../../commit/c7b68fa2c5006e4751f424d264702ca887b9fb20)
+- Rebirth color config allows changing the title screen logo, gradient, and triangle - [5f67bb7](../../../commit/5f67bb70ab2087254e2b275afd427c4922796c6a)
+- Rebirth has a new option for Wheel Spin Speed - [f0eb69a](../../../commit/f0eb69a1b85c10e74d7ec1be8c2d1fbdf74419af)
+- Rebirth hovering your local player name has a new tooltip saying that clicking will rename your profile - [b0be391](../../../commit/b0be3912a944b5e035626ab3d11c1bf91c1b8e9e)
+- Til Death has a new Mean display added to gameplay. It defaults off. Its customization keys are `M` and `,`. You can turn it on with an option next to the Percent display - [e1e78dd](../../../commit/e1e78dd0c77d65964b95ca4ddf285baf6d9eb58c) [02ce2d8](../../../commit/02ce2d8a25126c80e578e40700b5e355e8a1feec)
+- Tooltips can have their text size changed from Lua - [4533e70](../../../commit/4533e70352e25d94486793a2eef29ce04fa44f55)
+
+### Changes
+- GetDirListing API has been changed to allow filtering to only real files. The old API will work as it already has - [71991a7](../../../commit/71991a707c6037485873bb6c79cc04182239bee5) [209837b](../../../commit/209837b22abdb5cf418cb3bfce60ac0a18752f3a)
+- Image loading should now be slightly faster in certain conditions, particularly on the D3D renderer - [#1239](../../../pull/1239)
+- Network Options is hidden from the Rebirth menus because it isn't functional right now - [f52f4b4](../../../commit/f52f4b4d34f2474da367a05636c8250855d6569b)
+- Rebirth MeasureBars option was moved to the ThemeConfig internally, which means that setting is reset for everyone - [298bec9](../../../commit/298bec9f894fab1b354651e112682edf7989e35c) [34986b9](../../../commit/34986b9bfd99a6240e0328c502a5a39c6a477204)
+- Rebirth Player Config is now loaded per profile. Profiles load from the old place in `/Save/Rebirth_settings/` unless not present, so no change is necessary for the user - [6ebb86a](../../../commit/6ebb86af507a5bf0a9a3c00fe9cc486028f7fff2) [2c53bd5](../../../commit/2c53bd5d042a768a999be7fde348ed8a417684c3)
+- Rebirth Settings allows hovering the empty space between option names and option values to select them - [b96cdba](../../../commit/b96cdbadb9f7ceef719244326d1f7d63472122e9)
+- Til Death Tooltip size reduced a bit so CDTitle hovers aren't huge - [495545f](../../../commit/495545f6d5c6736a8da134549b9be0bcd0184d76)
+
+### Fixed
+- BPMDisplay stopped showing special random/unknown BPM types because SetFromSteps didn't support it - [24bb49b](../../../commit/24bb49bf929f72a23700bc70b36cd19c55442071)
+- Crashes by abusing Rebirth ColorConfig and CustomizeGameplay functionality - [603c0bc](../../../commit/603c0bc15405939bda5106656028310f6c331330)
+- Crashes by placing random audio file in a pack folder, or by naming a folder with an audio, image, or Stepmania extension - [71991a7](../../../commit/71991a707c6037485873bb6c79cc04182239bee5) [209837b](../../../commit/209837b22abdb5cf418cb3bfce60ac0a18752f3a)
+- Crashes by finishing a download between the moment when you select a song and before entering gameplay - [40f0550](../../../commit/40f055016caf839363073b7d48ae7a8aebb066ab)
+- MacOS support for getLanguage slightly fixed for older versions. This may reduce rare crashing - [0ddd71a](../../../commit/0ddd71ad22f3276468611938b3fdac670492219a)
+- Mouse cursor froze when reloading scripts or otherwise breaking mouse overlays - [77ee5a6](../../../commit/77ee5a694c5fecf0f3698ea71ed3b3d37febaec1)
+- Rebirth Music Wheel should no longer randomly stop on files for 1 frame, causing a huge stutter - [232be6d](../../../commit/232be6dd2552ab1a93a50cb1cfd8a7ac19d401d1)
+- Rebirth Song Search would appear to do nothing if a search returned a chart that appears on multiple songs, but one of the song results was filtered out - [5fb7850](../../../commit/5fb7850c0facc856a3e07687ddec2055aa31a47f)
+- Replays with ghost taps before the beginning or ghost taps in large breaks, but close to incoming notes, would cause the rest of the replay to be offset and broken - [3f8f572](../../../commit/3f8f5728c82cd328ceec70b89dcee5e958fbf24a)
+- Replays recorded with one particular set of Song Offset and Global Offset settings were wrong when played back after changing settings - [6a75685](../../../commit/6a75685c1e2bfb413988af6946b90ed7bd5f4d48)
+- ScreenTextEntry should no longer cause the music to stop playing, breaking the visualizer - [64d23ef](../../../commit/64d23efc643457b5a321d135843744d54be846bd) [5a71afe](../../../commit/5a71afed147b1f7ce0289e6984f86f8089de9e00)
+- Til Death Evaluation showed the wrong mean if you hit a mine on a live play (not replays) - [424eba6](../../../commit/424eba6249221e339eea1a37d643fb38e02893e0)
+- Tooltip overlay shouldn't produce so many errors when reloading scripts - [4918feb](../../../commit/4918feb1390ff4b40229893f4cab3200f6eb5e37)
diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml
@@ -23,12 +23,12 @@ jobs:
 
     steps:
       - name: Checkout Etterna
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: main
 
       - name: Checkout CrashpadTools
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: etternagame/CrashpadTools
           path: tools
@@ -50,7 +50,7 @@ jobs:
 
       - name: Upload Binary
         if: ${{matrix.cfg.dist}}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: "Etterna - Linux x64"
           path: '${{github.workspace}}/main/build/*.tar.gz'
@@ -76,7 +76,7 @@ jobs:
 
       - name: Upload Symbols to action artifacts
         if: ${{matrix.cfg.dist}}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: Etterna Symbols - ${{github.sha}}
           path: '${{github.workspace}}/sym/EtternaSymbolsUploadDir'
@@ -110,12 +110,12 @@ jobs:
     steps:
 
       - name: Checkout Etterna
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: main
 
       - name: Checkout CrashpadTools
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: etternagame/CrashpadTools
           path: tools
@@ -135,7 +135,7 @@ jobs:
 
       - name: Upload Binary
         if: ${{matrix.cfg.dist}}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: "Etterna - macOS x64"
           path: '${{github.workspace}}/main/build/*.dmg'
@@ -162,7 +162,7 @@ jobs:
 
       - name: Upload Symbols to action artifacts
         if: ${{matrix.cfg.dist}}
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: Etterna Symbols - ${{github.sha}}
           path: '${{github.workspace}}/main/EtternaSymbolsUploadDir'
@@ -195,18 +195,18 @@ jobs:
     runs-on: windows-2019
     steps:
       - name: Checkout Etterna
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: main
 
       - name: Checkout CrashpadTools
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: etternagame/CrashpadTools
           path: tools
 
       - name: Checkout DirectX SDK
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: nico-abram/dxsdk
           path: dxsdk
@@ -217,7 +217,7 @@ jobs:
           echo "ETTERNA_ARCH=${{matrix.cfg.name}}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
       - name: Setup Python 2.7
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '2.7'
 
@@ -246,13 +246,13 @@ jobs:
         run: cd main/build && cpack
 
       - name: Upload Binary
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: "Etterna - Windows ${{matrix.cfg.name}}"
           path: '${{github.workspace}}/main/build/*.exe'
 
       - name: Setup Python 3
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.8'
 
@@ -265,7 +265,7 @@ jobs:
         run: cd main && python ${{github.workspace}}/main/.ci/prepare_symbols.py
 
       - name: Upload Symbols to action artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: Etterna Symbols - ${{github.sha}}
           path: '${{github.workspace}}/main/EtternaSymbolsUploadDir'

diff --git a/.github/workflows/coverity-scan.yml b/.github/workflows/coverity-scan.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Etterna
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           path: main
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 All releases of Etterna are listed in this file as well as links to files detailing all of the changes for each. All changes for each version apply in supplement to the ones below it. Changes are not in chronological order, only versions are.
 
+## [0.72.2] - 2023-03-01 - Hotfix
+
+Windows x64, Windows i386, and Mac installer release. Linux binary.
+- Fixes for replays and other stuff
+- [Notes](.changelog/Release_0-72-2.md)
+
 ## [0.72.1] - 2023-01-09 - Hotfix
 
 Windows x64, Windows i386, and Mac installer release. Linux binary.

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -19,7 +19,7 @@ set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 
 # PROJECT WIDE SETUP
 project(Etterna
-		VERSION 0.72.1
+		VERSION 0.72.2
         HOMEPAGE_URL https://github.com/etternagame/etterna/
         LANGUAGES C CXX ASM)
 

diff --git a/Data/splash.png b/Data/splash.png
diff --git a/Docs/README.md b/Docs/README.md
@@ -7,6 +7,7 @@
 ## For Developers
 
 [Contributing](Contributing.md) -- A brief overview of how to contribute to Etterna :)<br>
+[Documentation Overview](documentation/README.md) -- An overview of how Etterna's documentation works and how to contribute to it.<br>
 [Building](Building.md) -- How to build the game from source<br>
 [Crashpad](Crashpad.md) -- An explanation of the crashdump system Etterna uses<br>
 [Doxygen](doxygen/html/index.html) -- Etterna C++ function and class documentation<br>

diff --git a/Docs/_config.yml b/Docs/_config.yml
@@ -1,4 +1,12 @@
 #Jekyll config file for Etterna documentation CI
 remote_theme: just-the-docs/just-the-docs
+color_scheme: etterna
+nav_external_links:
+  - title: Etterna C++ Documentation
+    url: doxygen/html/index.html
+    hide_icon: false
+  - title: Etterna Lua Documentation
+    url: ldoc/index.html
+    hide_icon: false
 
 include: Contributing.md # No clue why this is needed explicitly
diff --git a/Docs/_sass/color_schemes/etterna.scss b/Docs/_sass/color_schemes/etterna.scss
@@ -0,0 +1,5 @@
+//See: https://github.com/just-the-docs/just-the-docs/blob/main/_sass/support/_variables.scss
+//     https://just-the-docs.github.io/just-the-docs/docs/customization/#define-a-custom-scheme
+
+$purple-000: #614080;
+$link-color: $purple-000; // Cascade update down (this isn't automatic)
diff --git a/Docs/documentation/README.md b/Docs/documentation/README.md
@@ -0,0 +1,6 @@
+---
+has_children: true
+title: Etterna Documentation Overview
+---
+
+[Editing Site](editing_site.md) -- A brief overview of how this site is generated and how it can be configured.
diff --git a/Docs/documentation/editing_site.md b/Docs/documentation/editing_site.md
@@ -0,0 +1,59 @@
+---
+parent: Etterna Documentation Overview
+---
+# Editing the Etterna Documentation Site
+
+The Etterna documentation site you're reading right now is automatically generated by a GitHub Actions workflow.
+
+## The GHA workflow
+
+The GitHub actions workflow actually generating this entire website can be viewed [in the Etterna repository](https://github.com/etternagame/etterna/blob/develop/.github/workflows/documentation.yml).
+
+The workflow runs a series of steps to achieve three primary goals:
+
+1. Rendering the markdown files present in the repository into nicely formatted html.
+
+   This is done using Jekyll alongside a custom theme; details can be seen [here](#jekyll-and-the-site-theme)
+
+   We do this because raw Markdown is ... not pretty to look at.
+
+2. Automatically generating documentation for Etterna's C++.
+
+    This is done using Doxygen; details can be seen [here](#c-documentation-and-doxygen)
+
+3. Automatically generating documentation for Etterna's Lua.
+
+    This is done using LDoc; details can be seen [here](#lua-documentation-and-ldoc)
+
+
+
+
+## Jekyll and the Site Theme
+
+Markdown files are converted into html using a GHA workflow.
+
+To apply styling making the site actually look nice (and granting functionality like the nav bar and search bar), we use the theme [just-the-docs](https://github.com/just-the-docs/just-the-docs).
+
+The site can be configured at various levels:
+
+Jekyll itself can be configured by editing the file [Docs/_config.yml](https://github.com/etternagame/etterna/blob/develop/Docs/_config.yml).  
+Details of what configuration options are available can be seen [in Jekyll's documentation](https://jekyllrb.com/docs/configuration/).  
+This configuration is used for big-scale things like what files should be included/excluded from the rendering and what theme is being used.
+
+The particular theme we're using, [just-the-docs](https://github.com/just-the-docs/just-the-docs), also has a substantial amount of configuration options available.  
+The full list can be seen in [their documentation](https://just-the-docs.github.io/just-the-docs/).  
+Some configuration of just-the-docs is done by editing [Docs/_config.yml](https://github.com/etternagame/etterna/blob/develop/Docs/_config.yml), some by adding yml to the top of markdown files (e.g. as seen in [Keymaps_ini_format.md](https://github.com/etternagame/etterna/blob/develop/Docs/legacy/Userdocs/Keymaps_ini_format.md)), and some by editing other configuration files such as the CSS-styling file [Docs/_sass/color_schemes/etterna.scss](https://github.com/etternagame/etterna/blob/develop/Docs/_sass/color_schemes/etterna.scss)
+
+## C++ Documentation and Doxygen
+
+C++ documentation is automatically generated from C++ source files using Doxygen.  
+The configuration file used by doxygen is generated via Etterna's CMake operating on the file [Docs/Doxyfile.in](https://github.com/etternagame/etterna/blob/develop/Docs/Doxyfile.in)
+
+Various configuration options can be changed for Doxygen to modify its produced output; a list can be seen [in Doxygen's documentation](https://www.doxygen.nl/manual/config.html).
+
+## Lua Documentation and LDoc
+
+Lua documentation is automatically generated from Lua source files and written documentation using LDoc.  
+The configuration file used by LDoc is generated via Etterna's CMake operating on the file [Docs/LDoc.in](https://github.com/etternagame/etterna/blob/develop/Docs/LDoc.in)
+
+Various configuration options can be changed for LDoc to modify its produced output; a list can be seen [in LDoc's documentation](https://stevedonovan.github.io/ldoc/manual/doc.md.html#Fields_allowed_in__config_ld_).
diff --git a/Docs/favicon.ico b/Docs/favicon.ico
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2016-2021 Etterna <[email protected]>.
+Copyright (c) 2016-2023 Etterna <[email protected]>.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Themes/Rebirth/BGAnimations/ScreenSelectMusic decorations/generalPages/profile.lua b/Themes/Rebirth/BGAnimations/ScreenSelectMusic decorations/generalPages/profile.lua
@@ -127,6 +127,7 @@ local translations = {
     ViewRecentScores = THEME:GetString("ScreenSelectMusic Profile", "ViewRecentScores"),
     ShowingLocalScores = THEME:GetString("ScreenSelectMusic Profile", "ShowingLocalScores"),
     ShowingOnlineScores = THEME:GetString("ScreenSelectMusic Profile", "ShowingOnlineScores"),
+    SetPlayerName = THEME:GetString("ScreenSelectMusic Profile", "SetPlayerName"),
 }
 
 -- the page names in the order they go
@@ -1064,20 +1065,30 @@ local function createList()
                     else
                         self:settext(pname)
                     end
+                    if self:IsInvisible() then return end
+                    if isOver(self) then
+                        TOOLTIP:SetText(translations["SetPlayerName"])
+                        TOOLTIP:Show()
+                    end
                 end,
                 ProfileRenamedMessageCommand = function(self)
                     pname = profile:GetDisplayName()
                     self:playcommand("Set")
                 end,
                 MouseOverCommand = function(self)
                     self:diffusealpha(buttonHoverAlpha)
+                    if self:IsInvisible() then return end
+                    TOOLTIP:SetText(translations["SetPlayerName"])
+                    TOOLTIP:Show()
                 end,
                 MouseOutCommand = function(self)
                     self:diffusealpha(1)
+                    TOOLTIP:Hide()
                 end,
                 MouseDownCommand = function(self, params)
                     if self:IsInvisible() then return end
                     if params.event == "DeviceButton_left mouse button" then
+                        TOOLTIP:Hide()
                         renameProfileDialogue(profile)
                     end
                 end,

diff --git a/Themes/Rebirth/BGAnimations/ScreenTitleMenu underlay.lua b/Themes/Rebirth/BGAnimations/ScreenTitleMenu underlay.lua
@@ -86,10 +86,20 @@ t[#t+1] = Def.ActorFrame {
 
     Def.Sprite {
         Name = "LeftBG",
+        Texture = THEME:GetPathG("", "title-solid"),
+        InitCommand = function(self)
+            self:halign(0):valign(0)
+            self:zoomto(gradientwidth, gradientheight)
+            registerActorToColorConfigElement(self, "title", "GradientColor1")
+        end
+    },
+    Def.Sprite {
+        Name = "LeftBGGradient",
         Texture = THEME:GetPathG("", "title-gradient"),
         InitCommand = function(self)
             self:halign(0):valign(0)
             self:zoomto(gradientwidth, gradientheight)
+            registerActorToColorConfigElement(self, "title", "GradientColor2")
         end
     },
     Def.Quad {
@@ -124,16 +134,28 @@ t[#t+1] = Def.ActorFrame {
             self:xy(logoFrameLeftGap, logoFrameUpperGap)
         end,
 
-        UIElements.SpriteButton(100, 1, THEME:GetPathG("", "Logo")) .. {
+        Def.Sprite {
+            Name = "LogoTriangle",
+            Texture = THEME:GetPathG("", "Logo-Triangle"),
+            InitCommand = function(self)
+                self:halign(0):valign(0)
+                self:zoomto(logoW, logoH)
+                registerActorToColorConfigElement(self, "title", "LogoTriangle")
+            end,
+        },
+        UIElements.SpriteButton(100, 1, THEME:GetPathG("", "Logo-E")) .. {
             Name = "Logo",
             InitCommand = function(self)
                 self:halign(0):valign(0)
                 self:zoomto(logoW, logoH)
+                registerActorToColorConfigElement(self, "title", "LogoE")
             end,
             MouseOverCommand = function(self)
+                self:GetParent():GetChild("LogoTriangle"):diffusealpha(buttonHoverAlpha)
                 self:diffusealpha(buttonHoverAlpha)
             end,
             MouseOutCommand = function(self)
+                self:GetParent():GetChild("LogoTriangle"):diffusealpha(1)
                 self:diffusealpha(1)
             end,
             MouseDownCommand = function(self, params)
@@ -339,6 +361,8 @@ t[#t+1] = Def.ActorFrame {
             self:x(-selectorHeight)
             self:halign(0)
             self:zoomto(selectorHeight, selectorHeight)
+            self:diffuse(color("#805faf"))
+            registerActorToColorConfigElement(self, "title", "ItemTriangle")
         end
     }
 }