Update docs and push version

YonicDev · May 2, 2020 · c643b96 · c643b96
1 parent db1a96c
commit c643b96
Show file tree

Hide file tree

Showing 12 changed files with 134 additions and 48 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,10 +4,10 @@ jobs:
     include:
         - os: linux
           dist: xenial
-          env: CC=gcc-7 CXX=g++-7 VERSION=0.2
+          env: CC=gcc-7 CXX=g++-7 VERSION=0.2.1
         - os: osx
           osx_image: xcode9.4
-          env: Qt5_DIR="/usr/local/opt/qt" VERSION=0.2
+          env: Qt5_DIR="/usr/local/opt/qt" VERSION=0.2.1
 cache:
     directories:
         - $HOME/.cargo

diff --git a/LanguagePacks/mpdr_es.ts b/LanguagePacks/mpdr_es.ts
@@ -24,9 +24,11 @@
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.ui" line="14"/>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="26"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="69"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="98"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="101"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="71"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="81"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="86"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="115"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="118"/>
         <source>MPDR Documentation</source>
         <translation>Documentación de MPDR</translation>
     </message>
@@ -42,7 +44,7 @@
     </message>
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="22"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="71"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="73"/>
         <source>No documentation for your system language could not be found (%1). The English documentation will be shown.</source>
         <extracomment>%1 = Already translated system language name.</extracomment>
         <translation type="unfinished">No se encuentra la documentación para tu idioma del sistema (%1). Se mostrará la documentación en inglés.</translation>
@@ -59,7 +61,8 @@
     </message>
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="30"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="103"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="87"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="120"/>
         <source>The English documentation could not be loaded!</source>
         <translation type="unfinished">¡No se ha podido cargar la documentación en inglés!</translation>
     </message>
@@ -409,12 +412,17 @@ Here we refer to &quot;Morph Ball&quot; standalone upgrade</extracomment>
         <translation type="unfinished">Bomba Ganzúa</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="154"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="152"/>
+        <source>Super Metroid-like doors</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="164"/>
         <source>Misc</source>
         <translation type="unfinished">Otras opciones</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="160"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="170"/>
         <source>Fix Flaahgra music files</source>
         <extracomment>Either &quot;to fix broken music files&quot; or &quot;to use the full version of Flaahgra&apos;s song&quot;</extracomment>
         <translation type="unfinished">Arreglar música de Flaahgra</translation>
@@ -424,34 +432,34 @@ Here we refer to &quot;Morph Ball&quot; standalone upgrade</extracomment>
         <translation type="obsolete">Arreglar música de Flaahgra</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="167"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="177"/>
         <source>Metroid Prime Trilogy disk:</source>
         <extracomment>Where is the Metroid Prime Trilogy disk?</extracomment>
         <translation type="unfinished">Disco de Metroid Prime Trilogy:</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="177"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="187"/>
         <source>Either American or European version</source>
         <translation type="unfinished">Versión Americana o Europea</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="187"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="197"/>
         <source>Browse...</source>
         <translation type="unfinished">Examinar...</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="194"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="204"/>
         <source>Keep Attract mode</source>
         <extracomment>To keep a series of videos that can be seen in the title screen after not pressing anything for a while.</extracomment>
         <translation type="unfinished">Mantener vídeos de título</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="64"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="65"/>
         <source>Select a Metroid Prime NTSC 0-00/0-02  disc image</source>
         <translation type="unfinished">Selecciona una imagen de disco de Metroid Prime NTSC 0-00 o 0-02</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="64"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="65"/>
         <source>Standard disk images (*.iso *.gcm)</source>
         <translation type="unfinished">Imagen estándar de disco (*.iso *.gcm)</translation>
     </message>

diff --git a/LanguagePacks/mpdr_fr.ts b/LanguagePacks/mpdr_fr.ts
@@ -24,9 +24,11 @@
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.ui" line="14"/>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="26"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="69"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="98"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="101"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="71"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="81"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="86"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="115"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="118"/>
         <source>MPDR Documentation</source>
         <translation type="unfinished"></translation>
     </message>
@@ -42,7 +44,7 @@
     </message>
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="22"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="71"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="73"/>
         <source>No documentation for your system language could not be found (%1). The English documentation will be shown.</source>
         <extracomment>%1 = Already translated system language name.</extracomment>
         <translation type="unfinished"></translation>
@@ -55,7 +57,8 @@
     </message>
     <message>
         <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="30"/>
-        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="103"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="87"/>
+        <location filename="../DoorRandomizer/GUI/Help/docdialog.cpp" line="120"/>
         <source>The English documentation could not be loaded!</source>
         <translation type="unfinished"></translation>
     </message>
@@ -405,12 +408,17 @@ Here we refer to &quot;Morph Ball&quot; standalone upgrade</extracomment>
         <translation type="unfinished">Verrouiller bombe de puissance</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="154"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="152"/>
+        <source>Super Metroid-like doors</source>
+        <translation type="unfinished"></translation>
+    </message>
+    <message>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="164"/>
         <source>Misc</source>
         <translation type="unfinished">Autres options</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="160"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="170"/>
         <source>Fix Flaahgra music files</source>
         <extracomment>Either &quot;to fix broken music files&quot; or &quot;to use the full version of Flaahgra&apos;s song&quot;</extracomment>
         <translation type="unfinished">Corriger les fichiers audio pour Flaahgra</translation>
@@ -420,34 +428,34 @@ Here we refer to &quot;Morph Ball&quot; standalone upgrade</extracomment>
         <translation type="obsolete">Corriger les fichiers audio pour Flaahgra</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="167"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="177"/>
         <source>Metroid Prime Trilogy disk:</source>
         <extracomment>Where is the Metroid Prime Trilogy disk?</extracomment>
         <translation type="unfinished">Disque de Metroid Prime Trilogy:</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="177"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="187"/>
         <source>Either American or European version</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="187"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="197"/>
         <source>Browse...</source>
         <translation type="unfinished">Parcourir...</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="194"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.ui" line="204"/>
         <source>Keep Attract mode</source>
         <extracomment>To keep a series of videos that can be seen in the title screen after not pressing anything for a while.</extracomment>
         <translation type="unfinished">Garder vidéos joués pendant l&apos;écran titre</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="64"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="65"/>
         <source>Select a Metroid Prime NTSC 0-00/0-02  disc image</source>
         <translation type="unfinished">Sélectionner une image de disque de Metroid Prime NTSC 0-00/0-02</translation>
     </message>
     <message>
-        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="64"/>
+        <location filename="../DoorRandomizer/GUI/PatchSettings/patchsettingspanel.cpp" line="65"/>
         <source>Standard disk images (*.iso *.gcm)</source>
         <translation type="unfinished">Images de disque standard (*.iso *.gcm)</translation>
     </message>

diff --git a/README.md b/README.md
@@ -25,11 +25,13 @@ to these types:
 * **White** (Ice Beam only)
 * **Red** (Plasma Beam only)
 
-> **NOTE:** Doors from Pirate Frigate, Impact Crater, and reactor doors from the Crashed Frigate will not be randomized. Currently, vertical doors (placed on the ground or the ceiling), and doors from the Crashed Frigate's ventilation system can't be randomized either.
+> **NOTE:** Doors from Pirate Frigate, Impact Crater, and reactor doors from the Crashed Frigate will not be randomized. Currently, doors placed on the ground or the ceiling can't be randomized either.
 
 The amount of doors of any given color can be adjusted with **door weights**.
 These adjust the chance of any door to be that particular color, and are given in percentages, grouped by areas (Tallon Overworld, Chozo Ruins, Magmoor Caverns, Phendrana Drifts and Phazon Mines).
 
+Doors can also be excluded from the randomization process, having the same color as they do in the original game.
+
 You can save your configuration with JSON presets.
 
 ## Q & A
@@ -58,7 +60,7 @@ MPDR will automatically determine which language to use from the system's curren
 To add a new language, you have two options:
 
 * **Generate a fresh translation file by [building the project](https://github.com/YonicDev/mpdr-qt#build).** You'll have to modify the `CMakeLists.txt` before building the program. The file itself has guidelines on how to do it.
-* **Copy one of the existing translation files.** This is NOT recommended as some translation files might become updated as the program is developed.
+* **Copy one of the existing translation files.** This is only recommended to do in Release and Translator Friendly builds.
 
 > **NOTE:** The logs produced by the backend ([randomprime](https://github.com/YonicDev/randomprime), the actual randomizer) cannot be translated.
 
@@ -111,29 +113,35 @@ Although MPDR has been designed to be cross-platform, the setup and build config
 * **[CMake](https://cmake.org/download/) 3.5** or higher.
 * **[Qt 5.13.2](https://www.qt.io/download)**, recommended with Qt Creator and Qt Docs as it includes the Clang compiler.
   * If you're not using the Clang compiler, you'll need the **MSVC** compiler included in [Visual Studio 2017 or 2019](https://visualstudio.microsoft.com/) in Windows, or the **[GCC 7.4](https://gcc.gnu.org/)** compiler in Linux.
+  > **(mac OS only):** The Clang compiler provided by Qt is too old in Qt 5.13.2, so you must install **[Xcode 9.3](https://developer.apple.com/xcode/)** or newer. The Command Developer Tools will work just fine.
 * **The [Rust](https://www.rust-lang.org/install.html) language:** Install the `nightly` toolchain alongside the `powerpc-unknown-linux-gnu` target, as indicated [here](https://github.com/YonicDev/randomprime/blob/master/compile_to_ppc/README.md).
-
-> **(mac OS only):** The Clang compiler provided by Qt is too old in Qt 5.13.2, so you must install **[Xcode 9.3](https://developer.apple.com/xcode/)** or newer. The Command Developer Tools will work just fine.
+  * If you've downloaded using rustup, you can use this command to install the correct target and toolchain:
+  ```sh
+  $ rustup-init -y --profile default --default-toolchain nightly --target powerpc-unknown-linux-gnu
+  ```
+  > **(Windows only)**, you might have to install the `x86_64-pc-windows-msvc` target as well. Simply add it to the --target parameter alongside the other.
 
 ### Procedure
 
-Run the following command in your command line to clone the repository:
+1. Run the following command in your command line to clone the repository:
+
+  ```sh
+  $ git clone --recurse-submodules "https://github.com/YonicDev/mpdr"
+  ```
 
-```sh
-$ git clone --recurse-submodules "https://github.com/YonicDev/mpdr"
-```
+2. After that, go to the randomprime submodule and run `cargo build`. Due to an issue with the compilation procedure, this extra step must be taken.
 
-Then open the `CMakeLists.txt` file in Qt Creator to create the project. After configuring the project you simply have to hit the Build & Run button.
+3. Once it's been compiled, return to the mpdr-qt folder and open the `CMakeLists.txt` file in Qt Creator to create the project. After configuring the project you simply have to hit the Build & Run button.
 
-If you are prompted to select kits, you may select Clang/LLVM, an OS-specific kit (MSVC for Windows, and GCC for macOS and Linux), or both.
+  * If you are prompted to select kits, you may select Clang/LLVM, an OS-specific kit (MSVC for Windows, and GCC for macOS and Linux), or both.
 
-The compiler in the kit you choose must support C++17. Here is a list of supported compiler versions:
+    The compiler in the kit you choose must support C++17. Here is a list of supported compiler versions:
 
-|OS     | MSVC               | GCC       | Clang     |
-|:-----:| :-----------------:| :--------:| :--------:|
-|Windows| Visual Studio 2017 | -         | 7         |
-|mac OS | -                  | Xcode 9.3 | Xcode 9.3 |
-|Linux  | -                  | 7.4       | 7         |
+    |OS     | MSVC               | GCC       | Clang     |
+    |:-----:| :-----------------:| :--------:| :--------:|
+    |Windows| Visual Studio 2017 | -         | 7         |
+    |mac OS | -                  | Xcode 9.3 | Xcode 9.3 |
+    |Linux  | -                  | 7.4       | 7         |
 
 You may choose either Debug or Release configuration. The Minimum Size Release configuration is used to deploy prebuilt releases.
 

diff --git a/doc/0.2/0.2.1/common/ventdoors.png b/doc/0.2/0.2.1/common/ventdoors.png
diff --git a/doc/0.2/0.2.1/en/index.html b/doc/0.2/0.2.1/en/index.html
@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta charset="UTF-8">
+		<title>MPDR Documentation v0.2.1</title>
+		<link type="text/css" href="../../0.2/common/common.css" rel="stylesheet"/>
+	</head>
+	<body>
+		<h1>Metroid Prime Door Randomizer v0.2.1</h1>
+		<h2>What's new</h2>
+		<ul>
+            <li>MPDR now supports <b>Mac OS from High Sierra</b> (10.13) onward.</li>
+            <li><b>Power Bomb lockpicking:</b> When enabled, you may use a Power Bomb to open a door of any color.</li>
+            <img style="margin-left:calc(50% - 250px);width:500px" src="lockpicking.png">
+            <li><b>The ventilation system doors inside the Crashed Frigate</b> can now be randomized.</li>
+            <img style="margin-left:calc(50% - 250px);width:500px" src="../common/ventdoors.png">
+		</ul>
+        <p>For more information on the program, check the relevant documentation in 0.2.</p>
+		<div style="display:flex;flex-direction:column;align-items:center;">
+			<span style="text-align:center;">
+				<p><sub>This documentation is for MPDR version 0.2.1.</sub></p>
+				<figure>
+					<img style="display:block;width:50%;margin:0 auto;" src="../../0.2/common/verimage.png"/>
+					<figcaption class="imgver">&lt;Codename: Beetle Bravo&gt;</figcaption>
+				</figure>
+			</span>
+		</div>
+	</body>
+</html>
diff --git a/doc/0.2/0.2.1/en/lockpicking.png b/doc/0.2/0.2.1/en/lockpicking.png