223 lines
12 KiB
HTML
223 lines
12 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: mods.toml File Structure</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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('md_docs_2mods-toml.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">mods.toml File Structure</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><a class="anchor" id="modstoml-file-structure"></a></p>
|
|
<p>The <code>mods.toml</code> file is a metadata file required for all mods and resource packs in SpaghettiKart. It uses the <a href="https://toml.io/">TOML</a> format and defines important information about your mod, including its name, version, and dependencies.</p>
|
|
<h1><a class="anchor" id="location"></a>
|
|
Location</h1>
|
|
<p>The <code>mods.toml</code> file must be placed at the <b>root</b> of your mod archive (<code>.o2r</code>, <code>.zip</code>) or folder.</p>
|
|
<div class="fragment"><div class="line">MyMod/</div>
|
|
<div class="line">├── mods.toml <- Required at root level</div>
|
|
<div class="line">├── textures/</div>
|
|
<div class="line">│ └── ...</div>
|
|
<div class="line">└── ...</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="basic-structure"></a>
|
|
Basic Structure</h1>
|
|
<p>Here's a minimal <code>mods.toml</code> file:</p>
|
|
<div class="fragment"><div class="line">[mod]</div>
|
|
<div class="line">name = "my-awesome-mod"</div>
|
|
<div class="line">version = "1.0.0"</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="complete-structure"></a>
|
|
Complete Structure</h1>
|
|
<p>Here's a complete example with all supported fields:</p>
|
|
<div class="fragment"><div class="line">[mod]</div>
|
|
<div class="line">name = "my-awesome-mod"</div>
|
|
<div class="line">version = "1.0.0"</div>
|
|
<div class="line"> </div>
|
|
<div class="line">[dependencies]</div>
|
|
<div class="line">spaghettikart-assets = "=1.0.0-alpha1"</div>
|
|
<div class="line">another-mod = ">=2.0.0"</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="fields-reference"></a>
|
|
Fields Reference</h1>
|
|
<h2><a class="anchor" id="mod-section"></a>
|
|
[mod] Section</h2>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadNone">Field </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Required </th><th class="markdownTableHeadNone">Description </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><code>name</code> </td><td class="markdownTableBodyNone">String </td><td class="markdownTableBodyNone">Yes </td><td class="markdownTableBodyNone">Unique identifier for your mod. Use lowercase letters, numbers, and hyphens. </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><code>version</code> </td><td class="markdownTableBodyNone">String </td><td class="markdownTableBodyNone">Yes </td><td class="markdownTableBodyNone">Version of your mod following <a href="https://semver.org/">Semantic Versioning</a> (e.g., <code>1.0.0</code>, <code>1.0.0-alpha1</code>). </td></tr>
|
|
</table>
|
|
<h2><a class="anchor" id="dependencies-section"></a>
|
|
[dependencies] Section</h2>
|
|
<p>The <code>[dependencies]</code> section is optional and allows you to specify other mods that your mod requires.</p>
|
|
<p>Each dependency is defined as: </p><div class="fragment"><div class="line">[dependencies]</div>
|
|
<div class="line">mod-name = "version-requirement"</div>
|
|
</div><!-- fragment --><h3><a class="anchor" id="version-requirements"></a>
|
|
Version Requirements</h3>
|
|
<p>Version requirements follow semantic versioning ranges:</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadNone">Format </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Example </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><code>1.0.0</code> </td><td class="markdownTableBodyNone">Exact version </td><td class="markdownTableBodyNone">Only version 1.0.0 </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><code>>=1.0.0</code> </td><td class="markdownTableBodyNone">Greater than or equal </td><td class="markdownTableBodyNone">Version 1.0.0 or higher </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><code>>=1.0.0 <2.0.0</code> </td><td class="markdownTableBodyNone">Range </td><td class="markdownTableBodyNone">Between 1.0.0 (inclusive) and 2.0.0 (exclusive) </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><code>>=1.0.0-alpha1</code> </td><td class="markdownTableBodyNone">With prerelease </td><td class="markdownTableBodyNone">Version 1.0.0-alpha1 or higher </td></tr>
|
|
</table>
|
|
<p>see <a href="https://semver.org/">Semantic Versioning</a> for more details.</p>
|
|
<h1><a class="anchor" id="core-dependencies"></a>
|
|
Core Dependencies</h1>
|
|
<p>SpaghettiKart defines three core packages that are always available:</p>
|
|
<ul>
|
|
<li><code>mk64-assets</code> - The base game resources (version <code>1.0.0-alpha1</code>) (<code>mk64.o2r</code>)</li>
|
|
<li><code>extended-assets</code> - SpaghettiKart additional assets (version <code>1.0.0-alpha1</code>) (<code>spaghetti.o2r</code>)</li>
|
|
<li><code>spaghettikart-core</code> - SpaghettiKart core engine (For verifying that mods support your game version)</li>
|
|
</ul>
|
|
<p>If your mod depends on touching base game assets or SpaghettiKart assets, you should declare a dependency on these packages. For example:</p>
|
|
<div class="fragment"><div class="line">[dependencies]</div>
|
|
<div class="line">mk64-assets = "=1.0.0-alpha1"</div>
|
|
</div><!-- fragment --><h1><a class="anchor" id="validation"></a>
|
|
Validation</h1>
|
|
<p>When SpaghettiKart loads mods, it performs the following validations:</p>
|
|
<ol type="1">
|
|
<li><b>Missing mods.toml</b>: A warning is shown if the file is missing. The mod may still load but is considered incompatible.</li>
|
|
<li><b>Cyclic dependencies</b>: If mod A depends on mod B and mod B depends on mod A, an error is shown.</li>
|
|
<li><b>Missing dependencies</b>: If a required dependency is not found or has an incompatible version, an error is shown.</li>
|
|
</ol>
|
|
<h1><a class="anchor" id="load-order"></a>
|
|
Load Order</h1>
|
|
<p>Mods are automatically sorted based on their dependencies:</p><ul>
|
|
<li>Mods without dependencies are loaded first</li>
|
|
<li>Mods are loaded after their dependencies</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="best-practices"></a>
|
|
Best Practices</h1>
|
|
<ol type="1">
|
|
<li><b>Follow semantic versioning</b>: Use proper version numbers (MAJOR.MINOR.PATCH)</li>
|
|
<li><b>Specify minimal dependencies</b>: Only declare dependencies you actually need</li>
|
|
<li><b>Use version ranges</b>: Prefer <code>=1.0.0</code> because assets may change between versions</li>
|
|
</ol>
|
|
<h1><a class="anchor" id="migration-script-support"></a>
|
|
Migration Script Support</h1>
|
|
<p>When using the migration script (<code>migrations.py</code>), a <code>mods.toml</code> file can be automatically generated for your migrated mod. See <a class="el" href="md_docs_2migrations.html">Migration Guide</a> for details.</p>
|
|
<h1><a class="anchor" id="see-also"></a>
|
|
See Also</h1>
|
|
<ul>
|
|
<li><a class="el" href="md_docs_2modding.html">Modding Guide</a> - General modding information</li>
|
|
<li><a class="el" href="md_docs_2migrations.html">Migration Guide</a> - How to migrate existing mods</li>
|
|
<li><a class="el" href="md_docs_2textures-pack.html">Texture Pack Guide</a> - Creating texture packs </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>
|