Merge pull request #1220 from etternagame/develop

0.72.0 merge

.github/workflows/ci-workflow.yml

@@ -7,17 +7,19 @@ on:
 
 jobs:
   linux-x64:
-    name: Linux x64 (${{matrix.cfg.cpp-version}})
+    name: Linux x64 (${{matrix.cfg.cxx}})
     runs-on: ${{matrix.cfg.os}}
     strategy:
       fail-fast: false
       matrix:
         cfg:
-          - { os: ubuntu-18.04, cpp-version: g++-8,      dist: false}
-          - { os: ubuntu-18.04, cpp-version: g++-9,      dist: false}
-          - { os: ubuntu-18.04, cpp-version: clang++-7,  dist: false}
-          - { os: ubuntu-18.04, cpp-version: clang++-8,  dist: false}
-          - { os: ubuntu-18.04, cpp-version: clang++-9,  dist: true}
+          - { os: ubuntu-20.04, apt: g++-8,    cxx: g++-8,      cc: gcc-8,    dist: false}
+          - { os: ubuntu-20.04, apt: g++-9,    cxx: g++-9,      cc: gcc-9,    dist: false}
+          - { os: ubuntu-20.04, apt: g++-10,   cxx: g++-10,     cc: gcc-10,   dist: false}
+          - { os: ubuntu-20.04, apt: clang-9,  cxx: clang++-9,  cc: clang-9,  dist: false}
+          - { os: ubuntu-20.04, apt: clang-10, cxx: clang++-10, cc: clang-10, dist: false}
+          - { os: ubuntu-20.04, apt: clang-11, cxx: clang++-11, cc: clang-11, dist: false}
+          - { os: ubuntu-20.04, apt: clang-12, cxx: clang++-12, cc: clang-12, dist: true}
 
     steps:
       - name: Checkout Etterna

.github/workflows/coverity-scan.yml

@@ -17,7 +17,7 @@ jobs:
           path: main
 
       - name: Install apt dependencies
-        run: sudo apt update && sudo apt-get install ninja-build nasm libglew-dev libxrandr-dev libxtst-dev libpulse-dev libasound-dev libogg-dev libvorbis-dev
+        run: sudo apt update && sudo apt-get install ninja-build nasm libglew-dev libxrandr-dev libxtst-dev libpulse-dev libasound-dev libogg-dev libvorbis-dev libcurl4-openssl-dev
 
       - name: Download Coverity Build Tool
         run: |

.gitignore

@@ -69,14 +69,10 @@
 !/NoteSkins/kb7/retrobar-razor_o2/
 
 !/NoteSkins/pump/cmd/
-!/NoteSkins/pump/cmd-routine-p1/
-!/NoteSkins/pump/cmd-routine-p2/
 !/NoteSkins/pump/complex/
 !/NoteSkins/pump/default/
 !/NoteSkins/pump/delta/
 !/NoteSkins/pump/delta-note/
-!/NoteSkins/pump/delta-routine-p1/
-!/NoteSkins/pump/delta-routine-p2/
 !/NoteSkins/pump/frame5p/
 !/NoteSkins/pump/newextra/
 !/NoteSkins/pump/pad/

CMake/Helpers/DocumentationTools.cmake

@@ -20,7 +20,7 @@ else()
 endif()
 
 # LDoc
-find_program(LDOC_EXE "ldoc")
+find_program(LDOC_EXE NAMES "ldoc" "ldoc.bat")
 if(NOT LDOC_EXE)
     message(STATUS "LDoc not found. Documentation target will not be created.")
 else()

CMakeLists.txt

@@ -19,12 +19,12 @@ set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
 
 # PROJECT WIDE SETUP
 project(Etterna
-		VERSION 0.71.2
+		VERSION 0.72.0
         HOMEPAGE_URL https://github.com/etternagame/etterna/
         LANGUAGES C CXX ASM)
 
 ## CMake and Compiler Setup
-set(CMAKE_CXX_STANDARD 17)                                      # Minimum C++ Version
+set(CMAKE_CXX_STANDARD 20)                                      # Minimum C++ Version
 set(CMAKE_CXX_EXTENSIONS OFF)                                   # True if compiler extensions are necessary. (Changes -std flag)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)                             # True to require minimum C++ version to compile
 set(CMAKE_OSX_DEPLOYMENT_TARGET 10.10)                          # Tell xcodebuild to target an older osx platform

Docs/Building.md

@@ -50,7 +50,7 @@ cmake -DOPENSSL_ROOT_DIR="/usr/local/opt/openssl" -G "Xcode" ..  # macOS
   - Arch: `pacman -S openssl`
   - Alpine: `apk add openssl-dev`
   - macOS: `brew install openssl`
-  - Windows: A CMake compatible version of OpenSSL is available at [Shining Light Productions](https://slproweb.com/products/Win32OpenSSL.html) website. You will need the 32bit and 64bit installers if you plan on building both versions. It's reccomended to uninstall old versions to make sure CMake can find the correct latest version. Direct links: [32bit](https://slproweb.com/download/Win32OpenSSL-1_1_1i.exe), [64bit](https://slproweb.com/download/Win64OpenSSL-1_1_1i.exe)
+  - Windows: A CMake compatible version of OpenSSL is available at [Shining Light Productions](https://slproweb.com/products/Win32OpenSSL.html) website. You will need the 32bit and 64bit installers if you plan on building both versions. It's recommended to uninstall old versions to make sure CMake can find the correct latest version. Direct links: [32bit](https://slproweb.com/download/Win32OpenSSL-1_1_1s.exe), [64bit](https://slproweb.com/download/Win64OpenSSL-1_1_1s.exe). If these links are dead, look for the OpenSSL v1.1.1 install links (EXE or MSI) on the Shining Light Productions site. Typically we use the full versions rather than the Light versions.
 - [depot_tools](https://dev.chromium.org/developers/how-tos/install-depot-tools) - Installation is platform specific. To skip installing this, follow the relevant instructions in [CLI Project Generation](CLI-Project-Generation).
 
 ### Linux Dependencies
@@ -139,7 +139,7 @@ We actively support the following CMake generators
 
 - macOS: `Ninja`, `Xcode`, `Unix Makefiles`
 - Linux: `Ninja`, `Unix Makefiles`
-- Windows: `Ninja`, `Visual Studio 15 2017`, `Visual Studio 16 2019` _(Technically, with how the CMake script is setup, any generator as far back as_ `Visual Studio 9 2008` _should work), but it has only tested it with the above three._
+- Windows: `Ninja`, `Visual Studio 16 2019`, `Visual Studio 17 2022`
 
 For the `OPENSSL_ROOT_DIR` parameter, set the directory for where ever the openssl root directory is located. Here are possible options
 
@@ -270,14 +270,14 @@ To run `cppcheck`, run the target. Running the target will be different dependin
 
 ### C++ Docs
 
-Etterna uses [doxygen](http://www.doxygen.nl/) to build it's C++ documentation. Documentation is generated in a `doxygen` directory, inside the build directory. CMake is setup to make a target called `doxygen` if the executable found in the path.
+Etterna uses [Doxygen](http://www.doxygen.nl/) to build it's C++ documentation. Documentation is generated in a `doxygen` directory, inside the build directory. CMake is setup to make a target called `doxygen` if the executable found in the path.
 
 - Debian: `apt install doxygen`
 - Fedora: `dnf install doxygen`
 - Arch: `pacman -S doxygen`
 - Alpine: `apk add doxygen`
 - macOS: `brew install doxygen`
-- Windows: An installer is available at the [doxygen website](http://www.doxygen.nl/download.html). As with [cppcheck](#cppcheck), make sure the executable binary directory is added to your path.
+- Windows: An installer is available at the [Doxygen website](http://www.doxygen.nl/download.html). As with [cppcheck](#cppcheck), make sure the executable binary directory is added to your path.
 
 Doxygen within CMake is able to use [graphviz](https://www.graphviz.org/download/) to generate better looking relationship/hierarchy graphs. You can see how to download it for your operating system at the [graphgiz download page](https://www.graphviz.org/download/).
 

Docs/Contributing.md

@@ -34,17 +34,21 @@ Currently, there's a lack of alternative themes (To the default one, Til Death)
 
 ## Documentation
 
-The project is sorely lacking in documentation. The current aim is to document the Lua stuff in https://etternagame.github.io/Lua-For-Etterna/API/Lua.xml (This is forked from http://dguzek.github.io/Lua-For-SM5/API/Lua.xml, a community-made reference for SM5 Lua). We intend to get the C++ documentation done in https://etternagame.github.io/wiki/ (At first we wanted to make this page have 3 "sections": General, Lua and C++, but gave up). Then there is a general wiki with information that can be useful to end users (https://wiki.etternaonline.com/).
+The project is sorely lacking in documentation.
 
-## Translating
+The current aim is to document the Lua stuff in https://etternagame.github.io/Lua-For-Etterna/API/Lua.xml (This is forked from https://quietly-turning.github.io/Lua-For-SM5/Luadoc/Lua.xml, a community-made reference for SM5 Lua).
+
+We intend to get the C++ documentation done in https://etternagame.github.io/wiki/
 
-The Til Death theme (Default) only has one translation available. In order to make others, simply copy etterna/Themes/Til Death/Languages/en.ini and translate all the right-side words (After the `=`). Also, a list of the words/text/captions/things that aren't translate-able in the theme would be useful to make them(Some of the text is hard-coded so it's not possible to translate it).
+There is a general wiki with information that can be useful to end users (https://wiki.etternaonline.com/).
+
+## Translating
 
 A guide on this can be found in [the translations document](Translations.md).
 
 ## Packaging
 
-A few people have complained about the lack of packages for Linux in general. If you'd like to, you can try working on a package for your favorite distro. I've already made a more-or-less functional debian package here: https://github.com/nico-abram/etterna/tree/debian/
+A few people have complained about the lack of packages for Linux in general. If you'd like to, you can try working on a package for your favorite distro. 
 
 ## Graphic Design
 

Docs/Translations.md

@@ -1,6 +1,6 @@
 # Translations
 
-Translation support has always been a part of Stepmania to some extent. With Etterna 0.67.0+ we have opened up the doors to translating most of Til Death and some more of the base game's strings.
+Translation support has always been a part of Stepmania to some extent. With Etterna 0.67.0+ we have opened up the doors to translating most of Til Death, and Etterna 0.71.3+ adds support for translation of Rebirth, as well as some more of the base game's strings.
 
 * [Supported Languages](#Languages)
 * [The Process](#Process)
@@ -22,7 +22,7 @@ Figuring out if your language is supported at the moment is mostly trial and err
 ## Process
 
 * Determine your 2 letter language combo from the lists found above.
-* Locate `/Themes/_fallback/Languages/en.ini` and `/Themes/Til Death/Languages/en.ini`
+* Locate `/Themes/_fallback/Languages/en.ini` and `/Themes/Til Death/Languages/en.ini` or `/Themes/Rebirth/Languages/en.ini`
 * Make a copy of both files and leave them in the same respective `Languages` folders. Rename the copies to use your 2 letter language combination. For example, Norwegian would be `no.ini`
 * Begin translating line by line in the new files.
 
@@ -45,7 +45,7 @@ If you run into any lines to translate that you would like more context to in or
 
 Spawncamping-wallhack does not feature this full translation support, but could in the future. 
 
-For your own theme, these translations can be done the exact same way. The Language files accessible from your theme are only those in `_fallback/Languages` and `yourtheme/Languages`. This means that the Til Death strings are not available, but that does not stop you from taking them at your own leisure.
+For your own theme, these translations can be done the exact same way. The Language files accessible from your theme are only those in `_fallback/Languages` and `yourtheme/Languages`. This means that the Til Death or Rebirth strings are not available, but that does not stop you from taking them at your own leisure.
 
 Adding additional strings to Til Death or any theme involves creating a new line in a designated section and then calling it with `THEME:GetString("section", "string name")`. We try to reduce calls to this by storing them in a table instead of loading them multiple times per Actor. This `GetString` function will look for the current language in the theme and fallback. Then it will look in the `en.ini` in the same order. If it finds nothing in all cases, then you get a missing string error.