mirror/mk64
1
0
Fork 0
mirror of https://github.com/n64decomp/mk64 synced 2026-05-24 06:50:53 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
30311845eb5bb8f63463bdce903bf214e08d3a67
mk64/compiling.html
T

162 lines
7.7 KiB
HTML
Raw Blame History

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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: 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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"/>
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('compiling.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="PageDoc"><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="#autotoc_md17">Build Instructions</a></li>
<li class="level1"><a href="#autotoc_md18">Linux</a><ul><ul><li class="level3"><a href="#autotoc_md19">Arch</a></li>
</ul>
</ul>
</li>
<li class="level1"><a href="#autotoc_md20">Windows</a></li>
<li class="level1"><a href="#autotoc_md21">macOS</a></li>
<li class="level1"><a href="#autotoc_md22">Docker</a></li>
<li class="level1"><a href="#autotoc_md23">Building US</a></li>
<li class="level1"><a href="#autotoc_md24">Building EU</a></li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="autotoc_md17"></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>
<h1><a class="anchor" id="autotoc_md18"></a>
Linux</h1>
<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 --><h3><a class="anchor" id="autotoc_md19"></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="autotoc_md20"></a>
Windows</h1>
<p>Not recommended. Use WSL unless this is your only option.</p>
<p><a href="buildwindows.html">Instructions here</a></p>
<h1><a class="anchor" id="autotoc_md21"></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="autotoc_md22"></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 ${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 --><h1><a class="anchor" id="autotoc_md23"></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>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md24"></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.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink