Files
SpaghettiKart/md_docs_2custom-audio.html
T

152 lines
6.8 KiB
HTML

<!-- 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: Custom Audio</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('md_docs_2custom-audio.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">Custom Audio</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="custom-audio"></a></p>
<p>Replacing music tracks (sequences) requires a zip file that contains audio tracks in the same path/naming as in the original mk64.o2r. Only wav, mp3, ogg and flac are supported. To define the loop you need to create a json with the same name but end with .json. the json look like this: </p><div class="fragment"><div class="line">{</div>
<div class="line"> &quot;loop&quot;: {</div>
<div class="line"> &quot;start&quot;: 0,</div>
<div class="line"> &quot;end&quot;: 0</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --><p> The json file are optional. The unit of <code>start</code> and <code>end</code> is in pcm frames. You can use a tool like Audacity to find the correct values (it's call samples in Audacity). All properties available are: </p><div class="fragment"><div class="line">{</div>
<div class="line"> &quot;name&quot;: &quot;Name&quot;,</div>
<div class="line"> &quot;author&quot;: &quot;Author&quot;,</div>
<div class="line"> &quot;date&quot;: &quot;Date&quot;,</div>
<div class="line"> &quot;loop&quot;: {</div>
<div class="line"> &quot;start&quot;: 0,</div>
<div class="line"> &quot;end&quot;: 0</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --><p> The <code>name</code>, <code>author</code> and <code>date</code> are optional. The <code>loop</code> is used to define the loop of the sequence. If you don't want to loop the sequence, you can just remove the <code>loop</code> property. <code>date</code> doesn't have any effect on the audio playback. </p>
<h1><a class="anchor" id="example"></a>
Example:</h1>
<p>You want to change sound/sequences/main_menu then you just need to create a zip file with the following structure: </p><div class="fragment"><div class="line">audio_pack.zip</div>
<div class="line">└── sound</div>
<div class="line"> └── sequences</div>
<div class="line"> └── main_menu.mp3</div>
<div class="line"> └── main_menu.json</div>
</div><!-- fragment --><h1><a class="anchor" id="future-plans"></a>
Future plans</h1>
<ul>
<li>Support samples.</li>
<li>Create a tool to convert sequences and samples. </li>
</ul>
</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="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>