mirror
/
SpaghettiKart
mirror of https://github.com/HarbourMasters/SpaghettiKart
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SpaghettiKart/compiling.html

233 lines
9.8 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.10.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('compiling.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">Installing mk64 Decomp</div></div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul>
<li class="level1">
<a href="#build-instructions">Build Instructions</a>
</li>
<li class="level1">
<a href="#linux">Linux</a>
<ul>
<li class="level2 empty">
<ul>
<li class="level3">
<a href="#ubuntu">Ubuntu</a>
</li>
<li class="level3">
<a href="#fedora">Fedora</a>
</li>
<li class="level3">
<a href="#arch">Arch</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="level1">
<a href="#windows">Windows</a>
<ul>
<li class="level2 empty">
<ul>
<li class="level3">
<a href="#setup">Setup</a>
</li>
</ul>
</li>
</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>
<li class="level1">
<a href="#building-eu">Building EU</a>
</li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="build-instructions"></a>
Build Instructions</h1>
<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>
<p>Run <code>make assets</code> to extract assets.</p>
<h1><a class="anchor" id="linux"></a>
Linux</h1>
<h3><a class="anchor" id="ubuntu"></a>
Ubuntu</h3>
<div class="fragment"><div class="line">sudo apt install cmake build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev</div>
</div><!-- fragment --><h3><a class="anchor" id="fedora"></a>
Fedora</h3>
<div class="fragment"><div class="line">sudo dnf install make automake gcc gcc-c++ kernel-devel cmake pkg-config git python3 zlib-devel audiofile-devel capstone</div>
</div><!-- fragment --><p> and install <a href="https://github.com/DragonMinded/libdragon/releases/tag/toolchain-continuous-prerelease">gcc toolchain of libdragon</a> and add <code>export PATH="/opt/libdragon/bin:$PATH"</code> to ~/.bashrc</p>
<h3><a class="anchor" id="arch"></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 <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>
<ul>
<li>Clone the repo or download the zip.</li>
<li>Download and extract the toolchain from <a href="https://github.com/coco875/mk64-tools/releases/download/v0.0.8/mips-tools-chain-windows.zip">here</a></li>
</ul>
<h3><a class="anchor" id="setup"></a>
Setup</h3>
<ul>
<li>Place the <code>mingw64</code> folder from the toolchain into the tools folder like so: <code>mk64/tools/mingw64</code>.</li>
<li>Open a terminal (cmd or powershell) in the repo folder and run <code>"tools\mingw64\w64devkit.exe"</code> and after <code>make assets &amp;&amp; make -j</code></li>
<li>Wait for the build to finish and Enjoy!</li>
</ul>
<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>
<div class="line">brew install python3 capstone coreutils make pkg-config tehzz/n64-dev/mips64-elf-binutils</div>
</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>
<h1><a class="anchor" id="docker"></a>
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</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 -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>
<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 -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="basics.html">Understanding the Basics</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink