Linux/GCC Support (#28)

* Initial Linux/GCC support commit

* Add instructins for linux in the README

* apply suggestions by @Erotemic and @Emill

* Fix python 3.10 symlink line

* Fix func_80041E80 type mismatch (#3)

Type mismatch functions.h:664

* Makefile: clean OTRExporter/libultraship/ZAPDTR with distclean and fix CXX_FILES

* Makefile: find C/CXX_FILES automatically

* Makefile: remove ugly conditions in find commands

* cleanup _MSC_VER usage

* fix Windows build

* cleanup extraction scripts

* fix Windows build

* Fix Windows path separator issue

* fix rumble support for linux

* use glew-cmake in dockerfile

* add pulseaudio backend

* fix ZAPDTR linkage

* Check for "soh.elf" in directory (#6)

hide second button if `soh.exe` or `soh.elf` is present

* Fix hardcoded segment addresses (#5)

* fix condition

* hack lus -> soh dep for ZAPDTR

Co-authored-by: sholdee <102821812+sholdee@users.noreply.github.com>
Co-authored-by: qurious-pixel <62252937+qurious-pixel@users.noreply.github.com>
Co-authored-by: GaryOderNichts <12049776+GaryOderNichts@users.noreply.github.com>

.gitignore

@@ -279,7 +279,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -375,7 +375,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -384,7 +384,7 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder 
+# MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
 *.out
@@ -395,6 +395,7 @@ ExporterTest/ExporterTest.a
 ZAPDUtils/ZAPDUtils.a
 .vscode/
 build/
+external/
 ZAPDUtils/build/
 ZAPD/BuildInfo.h
 

BUILDING.md

@@ -1,21 +1,52 @@
 # Building Ship of Harkinian
 
+## Windows
+
  1. Install [Python](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe)
  2. Install [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/vs/community/)
  2b. In the Visual Studio Installer, install `MSVC v142 - VS 2019 C++`.
  4. Clone the Ship of Harkinian repository.
  5. Place one or more [compatible](#compatible-roms) roms in the `OTRExporter` directory with namings of your choice.
  6. Run `OTRExporter/OTRExporter.sln`.
  7. Switch the solution to `Release x64`.
- 8. Build the solution. 
+ 8. Build the solution.
  9. Launching `OTRExporter/extract_assets.py` will generate an `oot.otr` archive file in `OTRExporter/oot.otr`.
  10. Run `soh/soh.sln`
  11. Switch the solution to `Release x86`.
  12. Build the solution.
  13. Copy the `OTRExporter/oot.otr` archive file to `soh/Release`.
  14. Launch `soh.exe`.
 
-## Compatible Roms
+## Linux
+
+```bash
+# Clone the repo
+git clone git@github.com:HarbourMasters/ShipWright.git
+cd ShipWright
+# Copy the baserom to the OTRExporter folder
+cp <path to your ROM> OTRExporter
+# Build the docker image
+sudo docker build . -t soh
+# Run the docker image with the working directory mounted to /soh
+sudo docker run --rm -it -v $(pwd):/soh soh /bin/bash
+```
+Inside the Docker container:
+```bash
+# Clone and build StormLib
+git clone https://github.com/ladislav-zezula/StormLib external/StormLib
+cmake -B external/StormLib/build -S external/StormLib
+cmake --build external/StormLib/build
+cp external/StormLib/build/libstorm.a external
+cp /usr/local/lib/libGLEW.a external
+
+cd soh
+# Extract the assets/Compile the exporter/Run the exporter
+make setup -j$(nproc)
+# Compile the code
+make -j $(nproc)
+```
+
+# Compatible Roms
 ```
 OOT_PAL_GC      checksum 0x09465AC3
 OOT_PAL_GC_DBG1 checksum 0x871E1C92 (debug non-master quest)

Dockerfile

@@ -0,0 +1,38 @@
+
+
+FROM ubuntu:21.04 as build
+
+ENV LANG C.UTF-8
+ARG DEBIAN_FRONTEND=noninteractive
+
+RUN dpkg --add-architecture i386 && \
+    apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y \
+        binutils:i386 \
+        gcc-10:i386 \
+        g++-10:i386 \
+        python3.10 \
+        python \
+        make \
+        cmake \
+        git \
+        lld \
+        libsdl2-dev:i386 \
+        zlib1g-dev:i386 \
+        libbz2-dev:i386 \
+        libpng-dev:i386 \
+        libgles2-mesa-dev && \
+    ln -sf /usr/bin/python3.10 /usr/bin/python3 && \
+    ln -s /usr/bin/gcc-10 /usr/bin/gcc && \
+    ln -s /usr/bin/gcc-10 /usr/bin/cc && \
+    ln -s /usr/bin/g++-10 /usr/bin/g++ && \
+    ln -s /usr/bin/g++-10 /usr/bin/c++
+
+RUN git clone https://github.com/Perlmint/glew-cmake.git && \
+    cmake glew-cmake && \
+    make -j$(nproc) && \
+    make install ARCH64=false
+
+RUN mkdir /soh
+WORKDIR /soh

OTRExporter/OTRExporter/AnimationExporter.cpp

@@ -49,12 +49,12 @@ void OTRExporter_Animation::Save(ZResource* res, const fs::path& outPath, Binary
 
 		writer->Write((uint32_t)normalAnim->rotationValues.size());
 
-		for (int i = 0; i < normalAnim->rotationValues.size(); i++)
+		for (size_t i = 0; i < normalAnim->rotationValues.size(); i++)
 			writer->Write(normalAnim->rotationValues[i]);
 
 		writer->Write((uint32_t)normalAnim->rotationIndices.size());
 
-		for (int i = 0; i < normalAnim->rotationIndices.size(); i++)
+		for (size_t i = 0; i < normalAnim->rotationIndices.size(); i++)
 		{
 			writer->Write(normalAnim->rotationIndices[i].x);
 			writer->Write(normalAnim->rotationIndices[i].y);

OTRExporter/OTRExporter/ArrayExporter.cpp

@@ -10,7 +10,7 @@ void OTRExporter_Array::Save(ZResource* res, const fs::path& outPath, BinaryWrit
 	writer->Write((uint32_t)arr->resList[0]->GetResourceType());
 	writer->Write((uint32_t)arr->arrayCnt);
 
-	for (int i = 0; i < arr->arrayCnt; i++)
+	for (size_t i = 0; i < arr->arrayCnt; i++)
 	{
 		if (arr->resList[i]->GetResourceType() == ZResourceType::Vertex)
 		{
@@ -32,7 +32,7 @@ void OTRExporter_Array::Save(ZResource* res, const fs::path& outPath, BinaryWrit
 			writer->Write((uint32_t)vec->scalarType);
 			writer->Write((uint32_t)vec->dimensions);
 
-			for (int k = 0; k < vec->dimensions; k++)
+			for (size_t k = 0; k < vec->dimensions; k++)
 			{
 				// OTRTODO: Duplicate code here. Cleanup at a later date...
 				switch (vec->scalarType)
@@ -62,6 +62,8 @@ void OTRExporter_Array::Save(ZResource* res, const fs::path& outPath, BinaryWrit
 					writer->Write(vec->scalars[k].scalarData.u64);
 					break;
 					// OTRTODO: ADD OTHER TYPES
+				default:
+					break;
 				}
 			}
 		}
@@ -98,6 +100,8 @@ void OTRExporter_Array::Save(ZResource* res, const fs::path& outPath, BinaryWrit
 				writer->Write(scal->scalarData.u64);
 				break;
 				// OTRTODO: ADD OTHER TYPES
+			default:
+				break;
 			}
 		}
 	}

OTRExporter/OTRExporter/CutsceneExporter.cpp

@@ -29,7 +29,7 @@ void OTRExporter_Cutscene::Save(ZResource* res, const fs::path& outPath, BinaryW
 			for (auto& e : ((CutsceneCommandSetCameraPos*)cs->commands[i])->entries)
 			{
 				writer->Write(CMD_BBH(e->continueFlag, e->cameraRoll, e->nextPointFrame));
-				writer->Write(CMD_F(e->viewAngle));
+				writer->Write(e->viewAngle);
 				writer->Write(CMD_HH(e->posX, e->posY));
 				writer->Write(CMD_HH(e->posZ, e->unused));
 			}
@@ -46,7 +46,7 @@ void OTRExporter_Cutscene::Save(ZResource* res, const fs::path& outPath, BinaryW
 			for (auto& e : ((CutsceneCommandSetCameraPos*)cs->commands[i])->entries)
 			{
 				writer->Write(CMD_BBH(e->continueFlag, e->cameraRoll, e->nextPointFrame));
-				writer->Write(CMD_F(e->viewAngle));
+				writer->Write(e->viewAngle);
 				writer->Write(CMD_HH(e->posX, e->posY));
 				writer->Write(CMD_HH(e->posZ, e->unused));
 			}
@@ -105,7 +105,7 @@ void OTRExporter_Cutscene::Save(ZResource* res, const fs::path& outPath, BinaryW
 			for (auto& e : ((CutsceneCommandSetCameraPos*)cs->commands[i])->entries)
 			{
 				writer->Write(CMD_BBH(e->continueFlag, e->cameraRoll, e->nextPointFrame));
-				writer->Write(CMD_F(e->viewAngle));
+				writer->Write(e->viewAngle);
 				writer->Write(CMD_HH(e->posX, e->posY));
 				writer->Write(CMD_HH(e->posZ, e->unused));
 			}
@@ -122,7 +122,7 @@ void OTRExporter_Cutscene::Save(ZResource* res, const fs::path& outPath, BinaryW
 			for (auto& e : ((CutsceneCommandSetCameraPos*)cs->commands[i])->entries)
 			{
 				writer->Write(CMD_BBH(e->continueFlag, e->cameraRoll, e->nextPointFrame));
-				writer->Write(CMD_F(e->viewAngle));
+				writer->Write(e->viewAngle);
 				writer->Write(CMD_HH(e->posX, e->posY));
 				writer->Write(CMD_HH(e->posZ, e->unused));
 			}