Deploying to gh-pages from @ n64decomp/mk64@4c4cb36b4d 🚀

This commit is contained in:
MegaMech
2024-02-22 15:38:52 +00:00
parent a0e1a42088
commit ccfa04e090
239 changed files with 22511 additions and 22883 deletions
+21 -7
View File
@@ -109,7 +109,11 @@ $(function(){initNavTree('compiling.html',''); initResizable(); });
</ul>
</ul>
</li>
<li class="level1"><a href="#windows">Windows</a></li>
<li class="level1"><a href="#windows">Windows</a><ul><ul><li class="level3"><a href="#requirements">Requirements</a></li>
<li class="level3"><a href="#setup">Setup</a></li>
</ul>
</ul>
</li>
<li class="level1"><a href="#macos">macOS</a></li>
<li class="level1"><a href="#docker">Docker</a></li>
<li class="level1"><a href="#building-us">Building US</a></li>
@@ -134,8 +138,20 @@ Arch</h3>
<p>Review the <a href="https://github.com/n64decomp/sm64">n64decomp/sm64</a> readme for instructions to compile in other distributions.</p>
<h1><a class="anchor" id="windows"></a>
Windows</h1>
<p>Not recommended. Use WSL unless this is your only option.</p>
<p><a href="buildwindows.html">Instructions here</a></p>
<p><em>N64 decomp does not mesh well with Windows. However, this process has been refined to be as painless as possible. WSL is a great alternative if issues arise.</em></p>
<h3><a class="anchor" id="requirements"></a>
Requirements</h3>
<ul>
<li>Clone the repo or download the zip on your computer</li>
<li>Dowload toolchain from <a href="https://github.com/coco875/mk64-tools/releases/download/v0.0.6/mips-tools-chain-windows.zip">here</a></li>
</ul>
<h3><a class="anchor" id="setup"></a>
Setup</h3>
<ol type="1">
<li>copy from mips-tools-chain-windows.zip the folder <code>mingw64</code> into tools folder in the repo</li>
<li>Open a terminal (cmd or powershell) in the repo folder and run <code>"tools\mingw64\w64devkit.exe"</code> and after <code>make</code></li>
<li>Wait for the build to finish and Enjoy!</li>
</ol>
<h1><a class="anchor" id="macos"></a>
macOS</h1>
<p>Install <a href="https://brew.sh">Homebrew</a>, then install the following dependencies: </p><div class="fragment"><div class="line">brew update</div>
@@ -145,13 +161,11 @@ macOS</h1>
Docker</h1>
<p>Build the Docker image: </p><div class="fragment"><div class="line">docker build -t mk64 .</div>
</div><!-- fragment --><p>When building and using other tools, append the following in front of every command you run: </p><div class="fragment"><div class="line">docker run --rm -v .:/mk64 mk64</div>
</div><!-- fragment --><p>For example: </p><div class="fragment"><div class="line">docker run --rm -v .:/mk64 mk64 make -C tools</div>
<div class="line">docker run --rm -v .:/mk64 mk64 make</div>
</div><!-- fragment --><p>For example: </p><div class="fragment"><div class="line">docker run --rm -v .:/mk64 mk64 make</div>
</div><!-- fragment --><h1><a class="anchor" id="building-us"></a>
Building US</h1>
<p>Place a US version of Mario Kart 64 called <code>baserom.us.z64</code> into the project folder for asset extraction.</p>
<p>Run the following commands after pulling: </p><div class="fragment"><div class="line">make -C tools</div>
<div class="line">make -j</div>
<p>Run the following commands after pulling: </p><div class="fragment"><div class="line">make -j</div>
</div><!-- fragment --><h1><a class="anchor" id="building-eu"></a>
Building EU</h1>
<p>Building EU requires US to be built first. See above.</p>