mirror/mk64
1
0
Fork 0
mirror of https://github.com/n64decomp/mk64 synced 2026-09-01 09:13:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ n64decomp/mk64@e09b3797ef 🚀

Browse Source
This commit is contained in:
MegaMech
2024-01-14 21:35:59 +00:00
parent 956bb14388
commit 1a5ca211de
304 changed files with 52172 additions and 50607 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiling.html
+45 -28
View File
@@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Mario Kart 64: Compiling mk64</title>
<title>Mario Kart 64: Installing mk64 Decomp</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -84,52 +84,69 @@ $(document).ready(function(){initNavTree('compiling.html',''); initResizable();
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Compiling mk64 </div> </div>
<div class="title">Installing mk64 Decomp </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="autotoc_md15"></a>
Dependencies</h2>
Build Instructions</h2>
<p>The build system has the following package requirements: </p><pre class="fragment">binutils-mips &gt;= 2.27
python3 &gt;= 3.6
libaudiofile
</pre><p> To add submodules run <code>git submodule update --init --recursive</code> after cloning.</p>
<h2><a class="anchor" id="autotoc_md16"></a>
EU Specific Steps (All versions)</h2>
<p>Both EU builds first requires US to be built first: </p><div class="fragment"><div class="line">make -j</div>
</div><!-- fragment --><p>Now build either EU 1.0 <code>eu-1.0</code> or EU 1.1 <code>eu-final</code> </p><div class="fragment"><div class="line">make -j VERSION=eu-final</div>
</div><!-- fragment --><p>diff/first-diff commands </p><div class="fragment"><div class="line">python3 first-diff.py --eu</div>
<div class="line">./diff &lt;function&gt; -eu</div>
</div><!-- fragment --><h4><a class="anchor" id="autotoc_md17"></a>
Debian / Ubuntu</h4>
</pre><ul>
<li><a href="#linux">Linux and WSL</a></li>
<li><a href="#arch">Arch</a></li>
<li><a href="#windows">Windows</a></li>
<li><a href="#macos">macOS</a></li>
<li><a href="#docker">Docker</a></li>
</ul>
<h3><a class="anchor" id="autotoc_md16"></a>
Compiling</h3>
<ul>
<li><a href="#building-us">US</a></li>
<li><a href="#building-eu">EU</a></li>
</ul>
<p>To add submodules run <code>git submodule update --init --recursive</code> after cloning.</p>
<h2><a class="anchor" id="autotoc_md17"></a>
Linux</h2>
<div class="fragment"><div class="line">sudo apt install build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev</div>
</div><!-- fragment --><h4><a class="anchor" id="autotoc_md18"></a>
Arch Linux</h4>
<p>To install build dependencies: </p><div class="fragment"><div class="line">sudo pacman -S base-devel capstone python</div>
</div><!-- fragment --><p> Install the following AUR packages:</p><ul>
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md18"></a>
Arch</h3>
<div class="fragment"><div class="line">sudo pacman -S base-devel capstone python</div>
</div><!-- fragment --><p> Install the following AUR package:</p><ul>
<li><a href="https://aur.archlinux.org/packages/mips64-elf-binutils">mips64-elf-binutils</a> (AUR)</li>
</ul>
<p>Review the n64decomp/sm64 readme for instructions to compile in other distributions.</p>
<h4><a class="anchor" id="autotoc_md19"></a>
Windows</h4>
<p>Compiling on Windows requires <code>MSYS2 MinGW x64</code>. The setup process is a tad intensive. <br />
</p>
<p>Review the <a href="https://github.com/n64decomp/sm64">n64decomp/sm64</a> readme for instructions to compile in other distributions.</p>
<h2><a class="anchor" id="autotoc_md19"></a>
Windows</h2>
<p>Not recommended. Use WSL unless this is your only option.</p>
<p>Instructions here</p>
<h4><a class="anchor" id="autotoc_md20"></a>
macOS</h4>
<h2><a class="anchor" id="autotoc_md20"></a>
macOS</h2>
<p>Install <a href="https://brew.sh">Homebrew</a>, then install the following dependencies: </p><div class="fragment"><div class="line">brew update</div>
<div class="line">brew install python3 capstone coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils</div>
</div><!-- fragment --><p>When building, use <code>gmake</code> to ensure that homebrew <code>make</code> is used instead of the old, macOS system <code>make</code>.</p>
<h4><a class="anchor" id="autotoc_md21"></a>
Docker</h4>
</div><!-- fragment --><p>Build using <code>gmake</code> ensuring homebrew <code>make</code> is used instead of the old macOS system <code>make</code>.</p>
<h2><a class="anchor" id="autotoc_md21"></a>
Docker</h2>
<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 ${PWD}:/mk64 mk64</div>
</div><!-- fragment --><p>For example: </p><div class="fragment"><div class="line">docker run --rm -v ${PWD}:/mk64 mk64 make -C tools</div>
<div class="line">docker run --rm -v ${PWD}:/mk64 mk64 make</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md22"></a>
Building</h2>
Building US</h2>
<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</div>
<div class="line">make -j</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md23"></a>
Building EU</h2>
<p>Building EU requires US to be built first. See above.</p>
<p>mk64 decomp supports two EU versions</p><ul>
<li>EU 1.0 <code>eu-1.0</code></li>
<li>EU 1.1 <code>eu-final</code></li>
</ul>
<p>Build using </p><div class="fragment"><div class="line">make -j VERSION=eu-1.0</div>
</div><!-- fragment --><p> or </p><div class="fragment"><div class="line">make -j VERSION=eu-final</div>
</div><!-- fragment --><p>First-diff/diff commands for EU </p><div class="fragment"><div class="line">python3 first-diff.py --eu</div>
<div class="line">./diff &lt;function&gt; -eu</div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->