Merge remote-tracking branch 'upstream/master'

Author: MasterOfGrey

.appveyor.yml

@@ -1,70 +1,96 @@
 version: '{branch}.{build}'
 
-branches:
-    except:
-        - gh-pages
+skip_tags: true
+skip_branch_with_pr: true
 
-clone_depth: 5
+clone_depth: 2
 
 environment:
-    # Building with MinGW-w64 version 6.3.0. These env settings are used by the makefile.
-    MINGW_ROOT: C:\mingw-w64\x86_64-6.3.0-posix-seh-rt_v5-rev1\mingw64
-    matrix:
-        - es_run_mode: 'dist'
+  TEST_REPORT_FILE: .\tests\test-report.xml
+  PYTHON_BINARY: C:/Python38-x64/python.exe
+  SCCACHE_DIR: sccache
+  CXX: sccache g++
+  AR: gcc-ar
+  es_run_mode: 'dist'
+  matrix:
+    - MINGW_ROOT: C:\mingw-w64\x86_64-6.3.0-posix-seh-rt_v5-rev1\mingw64
+      MINGW_VERSION: v6.3.0
+    - MINGW_ROOT: C:\mingw-w64\x86_64-7.3.0-posix-seh-rt_v5-rev0\mingw64
+      MINGW_VERSION: v7.3.0
+    - MINGW_ROOT: C:\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64
+      MINGW_VERSION: v8.1.0
 
 install:
-    - ps: |
-        # Update env variables to use the desired MinGW version
-        Set-AppveyorBuildVariable -Name PATH -Value "$Env:MINGW_ROOT\bin\;$Env:PATH";
-        Set-AppveyorBuildVariable -Name DIR_MINGW64 -Value "$Env:MINGW_ROOT\x86_64-w64-mingw32";
-        # Ensure we have the precompiled libraries to link with (SDL, etc.).
-        if (!(Test-Path 'C:\dev64')) { New-Item 'C:\dev64' -ItemType Directory; }
-        if (!(Test-Path 'C:\dev64\bin'))
-        {
-            Start-FileDownload 'http://endless-sky.github.io/win64-dev.zip' 'C:\dev64.zip'
-            $zipArgs = 'x C:\dev64.zip -oC:\';
-            Start-Process '7z.exe' -ArgumentList $zipArgs -Wait;
-        }
-        # Ensure we have instructions on how to build our executable.
-        if (!(Test-Path '.winmake'))
-        {
-            if (!(Test-Path 'C:\cbp2make')) { New-Item 'C:\cbp2make' -ItemType Directory; }
-            $cbp2make_dir = 'C:\cbp2make\cbp2make-stl-rev147-all\bin';
-            if (!(Test-Path $cbp2make_dir))
-            {
-                Start-FileDownload 'https://downloads.sourceforge.net/project/cbp2make/cbp2make-stl-rev147-all.tar.7z?r=https%3A%2F%2Fsourceforge.net%2Fprojects%2Fcbp2make%2Ffiles%2F%3Fsource%3Dnavbar&ts=1500511318&use_mirror=managedway' 'C:\cbp2make.tar.gz';
-                $zipArgs = 'x C:\cbp2make.tar.gz -oC:\cbp2make';
-                Start-Process '7z.exe' -ArgumentList $zipArgs -Wait;
-            }
-            (Get-Content 'EndlessSky.cbp') -replace 'C:\\Program Files\\mingw64\\x86_64-w64-mingw32', $Env:DIR_MINGW64 | Set-Content 'EndlessSky.cbp';
-            $makeExe = "$cbp2make_dir\Release\cbp2make.exe";
-            $makeArg = '--local -in EndlessSky.cbp -out .winmake';
-            Start-Process $makeExe -ArgumentList $makeArg -Wait;
-        }
+  # Update env variables to use the desired MinGW version
+  - ps: |
+      Set-AppveyorBuildVariable -Name PATH -Value "$Env:MINGW_ROOT\bin\;$Env:PATH";
+      Set-AppveyorBuildVariable -Name DIR_MINGW64 -Value "$Env:MINGW_ROOT\x86_64-w64-mingw32";
+  # Ensure we have the precompiled libraries to link with (SDL, etc.).
+  - ps: |
+      if (!(Test-Path 'C:\dev64')) { New-Item 'C:\dev64' -ItemType Directory; }
+      if (!(Test-Path 'C:\dev64\bin'))
+      {
+        Start-FileDownload 'http://endless-sky.github.io/win64-dev.zip' 'C:\dev64.zip'
+        $zipArgs = 'x C:\dev64.zip -oC:\';
+        Start-Process '7z.exe' -ArgumentList $zipArgs -Wait;
+      }
+  # Use sccache
+  - ps: choco install sccache
 
 cache:
-    - C:\dev64
+  - C:\dev64
+  - C:\ProgramData\chocolatey\bin
+  - C:\ProgramData\chocolatey\lib
+  - scons-local -> .winmake
+  - sccache -> .winmake
+  - .sconsign.dblite -> .winmake
 
 build_script:
-    - ps: mingw32-make.exe -k -j2 -e -f .winmake $Env:es_run_mode;
+  - ps: mingw32-make.exe -re -j2 -f .winmake $Env:es_run_mode;
 
 before_test:
-    - ps: |
-        $here = (Get-Location).Path;
-        Copy-Item -Path "bin\*\EndlessSky.exe" -Destination $here;
-        Copy-Item -Path "C:\dev64\bin\*.dll" -Exclude "libstdc*" -Destination $here;
+  - ps: mingw32-make.exe -re -j2 -f .winmake build-tests;
+  - ps: |
+      $here = (Get-Location).Path;
+      Copy-Item -Path "bin\pkgd\release\endless-sky.exe" -Destination $here;
+      Copy-Item -Path "C:\dev64\bin\*.dll" -Exclude "libstdc*" -Destination $here;
 
 test_script:
-    - ps: .\tests\test_parse.ps1 'EndlessSky.exe';
+  - ps: .\tests\endless-sky-tests.exe -n es-ci -i --warn NoAssertions --order rand --rng-seed 'time' --filenames-as-tags -r junit -o $Env:TEST_REPORT_FILE;
+  - ps: .\tests\test_parse.ps1 'endless-sky.exe';
 
+# Upload the build if tests passed.
 after_test:
-    - ps: |
-        $here = (Get-Location).Path;
-        Copy-Item -Path "$Env:DIR_MINGW64\lib\libstdc++-6.dll" -Destination $here;
-        Copy-Item -Path "$Env:DIR_MINGW64\lib\libgcc_s_seh-1.dll" -Destination $here;
-        Copy-Item -Path "$Env:DIR_MINGW64\lib\libwinpthread-1.dll" -Destination $here;
-        # Zip the directory for release
-        $ARCHIVE_NAME = "$Env:APPVEYOR_REPO_NAME-$Env:APPVEYOR_REPO_BRANCH-$Env:APPVEYOR_REPO_COMMIT-win64.7z";
-        $ZIP_ARGS = "a $ARCHIVE_NAME .\*.exe -i!.\*.dll -i!.\data\ -i!.\icons\ -i!.\images\ -i!.\sounds\ -i!.\source\ -i!license.txt -i!copyright -i!README.md -i!changelog -i!credits.txt -i!keys.txt";
-        Start-Process '7z.exe' -ArgumentList $ZIP_ARGS -Wait;
-        Push-AppveyorArtifact $ARCHIVE_NAME;
+  - ps: |
+      $here = (Get-Location).Path;
+      Copy-Item -Path "$Env:DIR_MINGW64\lib\libstdc++-6.dll" -Destination $here;
+      Copy-Item -Path "$Env:DIR_MINGW64\lib\libgcc_s_seh-1.dll" -Destination $here;
+      Copy-Item -Path "$Env:DIR_MINGW64\lib\libwinpthread-1.dll" -Destination $here;
+
+      # Zip the directory for release
+      $BRANCH_NAME = switch ( [string]::IsNullOrEmpty($Env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH) ) {
+        $true { $Env:APPVEYOR_REPO_BRANCH }
+        $false { $Env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH }
+      };
+      $REPO_NAME = $Env:APPVEYOR_REPO_NAME -replace "^.+/";
+      $ARCHIVE_NAME = "$REPO_NAME-$BRANCH_NAME-$($Env:APPVEYOR_REPO_COMMIT.SubString(0,7))-MinGW$Env:MINGW_VERSION-win64.7z";
+
+      # Remove invalid characters that would prevent saving the artifact.
+      $INVALID_CHARS = [IO.Path]::GetInvalidFileNameChars() -join '';
+      $REPLACER = "[{0}]" -f [RegEx]::Escape($INVALID_CHARS);
+      $ARCHIVE_NAME = ($ARCHIVE_NAME -replace $REPLACER)
+
+      $ZIP_ARGS = "a $ARCHIVE_NAME .\*.exe -i!.\*.dll -i!.\data\ -i!.\icons\ -i!.\images\ -i!.\sounds\ -i!.\source\ -i!license.txt -i!copyright -i!README.md -i!changelog -i!credits.txt -i!keys.txt";
+      Start-Process '7z.exe' -ArgumentList $ZIP_ARGS -Wait;
+      Push-AppveyorArtifact $ARCHIVE_NAME;
+
+# Upload the test report even if tests failed.
+on_finish:
+  - ps: |
+      if (Test-Path $Env:TEST_REPORT_FILE)
+      {
+        (New-Object 'System.Net.WebClient').UploadFile(
+          "https://ci.appveyor.com/api/testresults/junit/$($env:APPVEYOR_JOB_ID)",
+          (Resolve-Path $Env:TEST_REPORT_FILE)
+        );
+      }

.codespell.exclude

@@ -0,0 +1,19 @@
+		"Woh"
+		"mor"
+		"Grey"
+		"Mitre"
+		"Alph"
+		"Gord"
+		"gard"
+		"Diamond Grey"
+		"Grey Wolf"
+				`	"The Grey Goose."`
+			`	He stops and frowns. "Look at me, rambling like an ol' man. Ser, Captain, I'd like to pay you <payment> to take me home, to <destination>."`
+			`	He smiles sadly. "Skaldgar always had a nose for good folks. Anyways, he told me he had a nephew named Helm who worked at the Norn spaceport. Find 'im and he can get'cha and this stone where it needs to go." The young man than looks you in the eye and gives a slow respectful nod, "For Ol' Skaldgar, may he be findin' ore in hel."`
+			`	Cygnet strokes his mustache. "Tod Copper. Tod Copper. Tell you what, that name doesn' ring a bell. Heck, I don' even keep track of names 'less I get someone impor'ant. If ya lookin' for someone in particular to buy, can I get a description?"`
+					goto shotdown
+			label shotdown
+		"ser"
+		"cach"
+		"oder"
+		" Grat"

.editorconfig

@@ -3,21 +3,30 @@ root = true
 
 [*]
 insert_final_newline = true
+trim_trailing_whitespace = true
 
 # Data files
 [data/**.txt]
 trim_trailing_whitespace = false
 indent_style = tab
 
 # Code files
-[*.{cpp,h,rc,hpp}]
-trim_trailing_whitespace = false
+[*.{cpp,h,rc,hpp}, SConstruct, SConscript]
 indent_style = tab
 
 # Markdown
 [*.md]
 trim_trailing_whitespace = false
 
+# Scripts
+[*.{sh,ps1}]
+indent_style = space
+indent_size = 2
+
 [*.xml]
 indent_style = space
 indent_size = 2
+
+[*.{yml,yaml}]
+indent_size = 2
+indent_style = space

.github/ISSUE_TEMPLATE/bug-report.yaml

@@ -0,0 +1,88 @@
+name: Bug Report
+description: Create a report to help us fix the game
+labels: [bug, unconfirmed]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report!
+        We know that filling this form out in full takes time, but we are also busy, unpaid volunteers--the more details you can provide, the smoother things will go.
+  - 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: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can others reproduce the issue?
+      value: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: |
+        If applicable, attach screenshots that may help others identify and resolve the issue.
+        (If you are reporting a visual bug, a screenshot is effectively required!)
+  - type: textarea
+    attributes:
+      label: Link to save file
+      description: You can either upload your save here, or to e.g. hastebin / GitHub Gists
+      placeholder: |
+        Windows: %APPDATA%\endless-sky\saves
+        Linux: ~/.local/share/endless-sky/saves
+        macOS: ~/Library/Application Support/endless-sky/saves
+  - type: input
+    attributes:
+      label: Operating System
+      description: What OS do you use?
+      placeholder: Windows 10 Pro, version 1803 build 17134.407
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Game Source
+      description: From where did you obtain your current game version?
+      options:
+        - Steam
+        - ESLauncher2
+        - Built from source
+        - GitHub Releases
+        - Homebrew
+        - Other (please describe)
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Game Version
+      description: What game version are you running?
+      placeholder: E.g. "v0.9.14" or "commit SHA cab74fd3"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: Add any other context about the problem here that didn't fit into the form inputs above.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+name: Feature Request
+description: Suggest an idea for this project
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for filing a feature request! This project has been around for quite a while, so it is quite common for ideas to have come up before. To help save everyone's time, you are required to search for related issues and address any comments and concerns that arose previously.
+        Otherwise, your issue will be closed--it is not fair to ask maintainers and collaborators to do background research for *your* feature request.
+
+        Where should you search?
+        - [GitHub Issues](https://github.com/endless-sky/endless-sky/issues?q=is%3Aissue)
+        - [Steam Forum](https://steamcommunity.com/app/404410/discussions/)
+        - [Discord Community](https://discord.gg/ZeuASSx)
+        - [Reddit](https://reddit.com/r/endlesssky/)
+        - [Google Groups](https://groups.google.com/g/endless-sky)
+  - type: textarea
+    attributes:
+      label: Problem Description
+      description: Provide a clear and concise description of what underlying issue is addressed by your feature request.
+      placeholder: I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Related Issue Links
+      description: |
+        Provide links to other topics that have sought to address the same issue, or discussed this same idea. Include links to Steam, GitHub, Google Groups, Reddit, or Discord.
+        (You can also address these related issues, to help differentiate your idea from those that have been dismissed in the past.)
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Desired Solution
+      description: Provide a clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Alternative Approaches
+      description: Provide a clear and concise description of any alternative solutions or features you've considered that would also address the underlying issue.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Add any other context or screenshots about the feature request here. If you're proposing new UI features, creating a mock-up can really go a long way in conveying your intent.