Merge pull request #1086 from etternagame/develop

0.71.0 merge

.changelog/Release_0-02.md

@@ -5,6 +5,8 @@
 
 Binary only release to replace Stepmania.exe.
 
+### Added
+- Usable but hidden Jumpstream generators - [c5b3d03](../../../commit/c5b3d031c021d8de0015dc51d9156f0cfe63f8b4)
 ### Changed
 - For Windows, use D3DX instead of RageMath for some calculations - [2d4c053](../../../commit/2d4c0538a683da87c0a09ac68304f953b04542fa)
 - FPS with Holds on screen improved by 37%

.changelog/Release_0-51.md

@@ -9,7 +9,7 @@ Windows installer release.
 - DivideByZero Noteskin Rolls - [6f19852](../../../commit/6f198526182c78ac6f6c8cce55d276e55b91a86f)
 - Grades based on Wife Percent - [e97836d](../../../commit/e97836da3a71ae3636669a66058e330f9ac3c535)
 - Player SSR (Score Specific Rating) recalculator functions - [a1f4df8](../../../commit/a1f4df86aa00dc9d5f57f96b0873de741e212aaf) [8edfc38](../../../commit/8edfc3824cf40031f130a9a1fe649ad75bc9c805) [1a0339b](../../../commit/1a0339b8a69c4dba45b164deff3fa980f0e0a7ea) [1741687](../../../commit/1741687ee9834bf98fdcde9c9b0a562eb7cfada6)
-- Song rates up to 2.5x - [9543b49](../../../commiT/9543B499774d672f038ff1666e2a28e30cb29a54)
+- Song rates up to 2.5x - [9543b49](../../../commit/9543B499774d672f038ff1666e2a28e30cb29a54)
 - Song Search - [4795319](../../../commit/4795319b309d8af2370ce6fbf7afe81a3bd57bae) [4f64c6b](../../../commit/4f64c6bbb84278c331c2d0bb1f400288ed56fbc5) [5a65b28](../../../commit/5a65b28338a3782b96726963eac41f06d8b6f5a5)
 ### Changed
 - Installer won't overwrite preexisting files & won't delete the song cache - [ad5b0ff](../../../commit/ad5b0ff0f725577f89a8ed31e3b347789eef4b82)

.ci/prepare_symbols.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""
+Symbol Prepare
+Takes the Etterna.sym file, and creates a google breakpad directory structure.
+Creates to simplify use when uploading to action artifacts.
+"""
+import os
+import sys
+import shutil
+from pathlib import Path
+
+
+def get_metadata(filename: str):
+    """Read first line to get relevant file data"""
+    with open(filename, 'r') as f:
+        first_line = f.readline().strip()   # Remove newline
+    first_line = first_line.split(' ')  # Split by spaces
+    return first_line[3], first_line[4]
+
+
+def make_breakpad_directory():
+    build_uuid, module_id = get_metadata('Etterna.sym')
+    path = Path("EtternaSymbolsUploadDir", "EtternaSymbols", module_id, build_uuid)
+    os.makedirs(path, exist_ok=True)
+    shutil.copyfile('Etterna.sym', path / 'Etterna.sym')
+
+
+make_breakpad_directory()
+sys.exit(0)

.ci/upload_symbols.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+"""
+Etterna Symbol Uploader
+Takes the Etterna.sym file, and uploads it to the S3 at the correct
+google breakpad directory location.
+
+Google Breakpad Directory Structure is as follows: symbols/<module_id>/<build_uuid>/<module_id>.sym
+Directory Structure for Etterna: symbols/Platform.Arch/Etterna/<build_uuid>/Etterna.sym
+"symbols/Platform.Arch" will be the directory when passing into minidump_stackwalk
+"""
+import os
+import sys
+import platform
+import subprocess
+from pathlib import PurePosixPath
+
+# Ensure AWS Environment Variables exist
+if 'AWS_ACCESS_KEY_ID' not in os.environ or 'AWS_SECRET_ACCESS_KEY' not in os.environ:
+    print("Ensure 'AWS_ACCESS_KEY_ID' and 'AWS_SECRET_ACCESS_KEY' are properly defined environment variables")
+    sys.exit(1)
+
+# Program Variables
+SYMBOL_FILE = "Etterna.sym"
+AWS_BUCKET_NAME = "etterna"
+AWS_ACCESS_KEY_ID = os.environ['AWS_ACCESS_KEY_ID']
+AWS_SECRET_ACCESS_KEY = os.environ['AWS_SECRET_ACCESS_KEY']
+ETTERNA_ARCH = os.environ['ETTERNA_ARCH']
+
+
+def get_s3_upload_directory():
+    """
+    Get the correct directory on AWS for symbol upload.
+    Current possible symbol directories include:
+        - symbols/Windows.i386/Etterna
+        - symbols/Windows.x64/Etterna
+        - symbols/Darwin.x64/Etterna
+    :return: The correct base directory
+    """
+    base_dir = platform.system()
+    return "{}.{}/Etterna/".format(base_dir, ETTERNA_ARCH)
+
+
+def get_metadata(filename: str):
+    """Read first line to get relevant file data"""
+    with open(filename, 'r') as f:
+        first_line = f.readline().strip()   # Remove newline
+    first_line = first_line.split(' ')  # Split by spaces
+    return first_line[3], first_line[4]
+
+
+def upload_to_s3(filename: str):
+    # Collect Metadata
+    prefix_dir = get_s3_upload_directory()
+    build_uuid, module_id = get_metadata(filename)
+    upload_prefix = PurePosixPath('symbols', prefix_dir, build_uuid, filename)
+    print("The upload_prefix is {}".format(upload_prefix))
+
+    # Get git hash
+    git_command = ['git', 'rev-parse', 'HEAD']
+    process = subprocess.run(git_command, capture_output=True)
+    full_hash = process.stdout.decode('utf-8').strip()
+
+    # Upload to S3
+    s3_command = [
+        'aws', 's3api', 'put-object',
+        '--bucket', AWS_BUCKET_NAME,
+        '--body', filename,
+        '--key', upload_prefix,
+        '--tagging', 'GitHash={}'.format(full_hash)]
+    subprocess.run(s3_command)
+
+
+upload_to_s3(SYMBOL_FILE)
+sys.exit(0)

.editorconfig

@@ -17,4 +17,8 @@ trim_trailing_whitespace = false
 
 [{CMakeLists.txt, *.cmake}]
 indent_style = tab
-indent_size = 4
+indent_size = 4
+
+[*.lua]
+indent_style = space
+indent_size = 4

.github/ISSUE_TEMPLATE/01-bug_report.yml

@@ -0,0 +1,79 @@
+name: 🐞 Bug Report
+description: File a report to help us improve Etterna!
+title: "[Bug]: "
+labels: ["Type: Bug", "Needs triage"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Thanks for taking the time to fill out this bug report! Please make sure to check if the bug has already been reported before submitting a new report.
+
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+
+  - type: input
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: [email protected], Discord#1234, Just reply to the issue...
+    validations:
+      required: false
+
+  - type: dropdown
+    attributes:
+      label: Version Info
+      description: What version of Etterna are you running?
+      options:
+        - Latest available release
+        - Compiled from develop
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: What operating system are you seeing the problem on?
+      multiple: true
+      options:
+        - Windows
+        - macOS
+        - Linux (any distro)
+
+  - type: textarea
+    attributes:
+      label: Bug Behavior
+      description: Describe the bug you're currently experiencing.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: What should have happened instead?
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: What steps should we follow to see the bug?
+      placeholder: |
+        1. Run the game
+        2. Select "Game Start"
+        3. Open the debug menu
+        4. '...'
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/02-feature_report.yml

@@ -0,0 +1,39 @@
+name: 🛠️ Feature Request
+description: Share your ideas on how to improve the game!
+title: "[Feature Request]: "
+labels: ["Type: Enhancement"]
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for the feature?
+      description: Please search to see if an issue already suggested the feature you're thinking.
+      options:
+        - label: I have searched the existing feature requests
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the Feature
+      description: What is the addition you are proposing?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How Does The Feature Add To The Game?
+      description: (Explain the problem the feature aims to solve, or the new things it allows)
+      placeholder: |
+        In Etterna, it was previously not possible to ...
+        However, this feature lets players ...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: |
+        If you have any background information that would help implement the feature, put it here.
+        (e.g. knowing which section of the code would have to be changed, or describing how another game implemented a similar thing)
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/03-build_issue.yml

@@ -0,0 +1,47 @@
+name: ⚙️ Build Issue
+description: Having a problem building Etterna? Let us know here!
+labels: ["Type: Maintenance"]
+title: "[Build Issue]: "
+assignees:
+  - jameskr97
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Have you read through the build instructions before reading this?
+      description: All information related to building Etterna is written in that document
+      options:
+        - label: I have read the build instructions
+          required: true
+
+  - type: dropdown
+    attributes:
+      label: What operating system are you seeing the problem on?
+      multiple: true
+      options:
+        - Windows
+        - macOS
+        - Linux (any distro)
+
+  - type: textarea
+    attributes:
+      label: Describe the build issue
+      description: What problem do you have when building Etterna?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Contact us on the Etterna Dev Group Discord
+    url: https://discord.gg/ZqpUjsJ
+    about: Join the EDG Discord for support and discussion with the devs.