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

201 lines
9.1 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: Modding</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_2modding.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">Modding</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="modding"></a></p>
<ul>
<li>Very focused on ease of modding without weird formats or obscure tools.</li>
<li>Early stages of modding and as such some features are not fully implemented yet</li>
<li>SpaghettiKart does not use Retro</li>
</ul>
<h1><a class="anchor" id="general-structure"></a>
General Structure</h1>
<p>Mods in SpaghettiKart are packaged as <code>.o2r</code> or <code>.zip</code> archives, or as folders placed in the <code>mods/</code> directory.</p>
<div class="fragment"><div class="line">mods/</div>
<div class="line">├── MyTexturePack.o2r</div>
<div class="line">├── CustomTracks.zip</div>
<div class="line">└── MyDevMod/ &lt;- Folder-based mod for development</div>
<div class="line"> ├── mods.toml</div>
<div class="line"> └── textures/</div>
</div><!-- fragment --><p>Every mod <b>must</b> include a <code>mods.toml</code> file at its root. This file contains metadata about the mod (name, version, dependencies). See <a class="el" href="md_docs_2mods-toml.html">mods.toml File Structure</a> for details.</p>
<h2><a class="anchor" id="supported-formats"></a>
Supported Formats</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Format </th><th class="markdownTableHeadNone">Extension </th><th class="markdownTableHeadNone">Description </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">O2R Archive </td><td class="markdownTableBodyNone"><code>.o2r</code> </td><td class="markdownTableBodyNone">Recommended format for distribution </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">ZIP Archive </td><td class="markdownTableBodyNone"><code>.zip</code> </td><td class="markdownTableBodyNone">Standard zip file </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Folder </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Useful for development </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Disabled </td><td class="markdownTableBodyNone"><code>.disabled</code> </td><td class="markdownTableBodyNone">Renamed archives are skipped </td></tr>
</table>
<h2><a class="anchor" id="mod-loading-order"></a>
Mod Loading Order</h2>
<p>Mods are loaded in dependency order. If mod A depends on mod B, then B will be loaded first. Mods loaded later can override resources from earlier mods.</p>
<h1><a class="anchor" id="getting-started"></a>
Getting Started</h1>
<ul>
<li><a class="el" href="md_docs_2mods-toml.html">mods.toml File Structure</a> - Required metadata file for all mods</li>
<li><a class="el" href="md_docs_2migrations.html">Migration Guide</a> - Migrate existing mods to the new structure</li>
</ul>
<h1><a class="anchor" id="mod-types"></a>
Mod Types</h1>
<ul>
<li>Textures Pack<ul>
<li>Some texture might not be possible to change yet, but most of them can be changed.</li>
<li><a class="el" href="md_docs_2textures-pack.html">link</a></li>
</ul>
</li>
<li>Custom Tracks (CT)<ul>
<li>Custom tracks are reserved for advanced users. We plan to simplify the process in the future.</li>
<li><a class="el" href="md_docs_2custom-track.html">link</a></li>
</ul>
</li>
<li>Custom Characters<ul>
<li>Custom characters can only replace existing characters for now. We plan to allow to add new characters in the future.</li>
<li><a class="el" href="md_docs_2custom-characters.html">link</a></li>
</ul>
</li>
<li>Custom Audio<ul>
<li>Only custom sequences are supported, not custom samples (like voices or sound effects).</li>
<li><a class="el" href="md_docs_2custom-audio.html">link</a></li>
</ul>
</li>
<li>Scripting<ul>
<li>Add logic to the game are not possible yet but we plan to add support for scripting in the future. We will use <a href="https://en.wikipedia.org/wiki/WebAssembly">WebAssembly</a> with <a href="https://component-model.bytecodealliance.org/">component model</a> this will allow you to choose your language (Rust, C, C++, Python, JS, etc.) and compile it to WebAssembly.</li>
</ul>
</li>
<li>3D Models For Characters<ul>
<li>Custom 3D models for characters are not supported yet. Put high quality character can be really close of 3d model but easily add a lot of size to the mod. We plan to add support for custom 3D models in the future.</li>
</ul>
</li>
<li>Custom Sounds<ul>
<li>Custom sounds are not supported yet. We plan to add support for custom sounds in the future.</li>
</ul>
</li>
<li>Custom Menus<ul>
<li>Custom menus are not supported yet. We plan to add support for custom menus in the future. </li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink