Files
SpaghettiKart/import.html
T

177 lines
7.5 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>SpaghettiKart: Import</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">SpaghettiKart
</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('import.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">Import</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="import"></a>
Import</h1>
<p>Presuming you have followed the steps in the export page, you should have</p><ul>
<li><code>mymod.zip</code> or <code>mymod.o2r</code> placed in the mods folder beside the game executable.</li>
<li>The track is ready for testing</li>
</ul>
<h2><a class="anchor" id="launch-the-game"></a>
Launch the Game</h2>
<ul>
<li>Press <code>ESC</code> and enable <code>Debug Mode</code> <img src="https://github.com/user-attachments/assets/1a3f09ba-0743-4243-b400-2a443df78cdd" alt="image" width="379" height="210" class="inline"/></li>
<li>Navigate away and back to the start screen and a debug menu should pop up. Use the left/right arrow keys to switch tracks. Custom tracks are placed at the end of the list.</li>
<li>Press <em>Launch HM64 Labs</em> to configure your track and place actors.</li>
</ul>
<p><img src="https://github.com/user-attachments/assets/52bcde3e-0b23-4611-9417-1adb71397a5c" alt="image" width="767" height="413" class="inline"/></p>
<ul>
<li>Select your track in the Content Browser</li>
<li>When opening your track for the first time, a scene.json file is created in the tracks data folder.<ul>
<li>If something ever goes horribly wrong you could manually edit this file or back it up to restore it later.</li>
</ul>
</li>
<li>If the game crashes while loading, then there is an issue with track path or mesh. Check logs, they are quite detailed and may point out what is wrong.</li>
</ul>
<p><img src="https://github.com/user-attachments/assets/5f092a60-3377-48e1-8d23-d527a0e60684" alt="image" width="1301" height="275" class="inline"/></p>
<ul>
<li>Navigate to the <a class="el" href="classTrack.html">Track</a> <a class="el" href="structProperties.html">Properties</a> winow to modify track name and settings</li>
</ul>
<p><img src="https://github.com/user-attachments/assets/59116891-0fca-4eb8-8050-02e70b75021d" alt="image" width="323" height="339" class="inline"/></p>
<p><img src="image-6.png" alt="alt text" class="inline"/></p>
<h3><a class="anchor" id="resource-name"></a>
Resource Name</h3>
<ul>
<li>Must be named identifier:track_name</li>
<li>The identifier can be used as a keyword for all of your mods</li>
<li>This format prevents name collisions so that everyone could make their own version of banana if they wish. mk is used for original game content and hm for harbour masters content. mk:banana, hm:harbour, etc.</li>
</ul>
<h3><a class="anchor" id="name"></a>
Name</h3>
<ul>
<li>The display name for the track </li>
</ul>
<h3><a class="anchor" id="debug-name"></a>
Debug Name</h3>
<ul>
<li>The display name in the debug menu. </li>
</ul>
<h3><a class="anchor" id="track-length"></a>
Track Length</h3>
<ul>
<li>An arbitrary value that describes the general length of the track</li>
</ul>
<h2><a class="anchor" id="conclusion"></a>
Conclusion</h2>
<p>Congrats! You have successfully made a track</p>
<p>If thet track did not work, try the troubleshooting page. </p>
</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="trackmenu.html">Track Making</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>