summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcoco875 <59367621+coco875@users.noreply.github.com>2026-02-26 20:36:21 +0100
committerGitHub <noreply@github.com>2026-02-26 12:36:21 -0700
commit5c93004e38ac2345ed4c3686ceba27f2aa427793 (patch)
tree1e1d4d1519d9a8e7996001788de8f2424d311d18 /docs
parentcb3b447b53abb8280e8dba891cd7acdd0aa1909f (diff)
clarify modding section (#656)
* clarify modding * add the mention of gamebanana page --------- Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/mainpage.md17
-rw-r--r--docs/modding.md25
2 files changed, 29 insertions, 13 deletions
diff --git a/docs/mainpage.md b/docs/mainpage.md
index fed532110..816b0e386 100644
--- a/docs/mainpage.md
+++ b/docs/mainpage.md
@@ -2,6 +2,20 @@ Complete resources for learning about SpaghettiKart
@htmlonly
<br>
<div class="pagebutton">
+<a class="pagea" href="modding.html">
+<div class="pagelink">
+ <div class="pageimg"><img width=320 src="buttonimage.png" /></div>
+ <div class="content">
+ <div class="pageheading">Modding Main Page</div>
+ <div class="pagedescription">
+ <p>It's time to race!</p>
+ </div>
+ </div>
+</div>
+</a>
+</div>
+
+<div class="pagebutton">
<a class="pagea" href="trackmenu.html">
<div class="pagelink">
<div class="pageimg"><img width=320 src="buttonimage.png" /></div>
@@ -29,4 +43,5 @@ Complete resources for learning about SpaghettiKart
</a>
</div>
-@endhtmlonly \ No newline at end of file
+@endhtmlonly
+
diff --git a/docs/modding.md b/docs/modding.md
index 492e053b9..89e895d52 100644
--- a/docs/modding.md
+++ b/docs/modding.md
@@ -1,4 +1,5 @@
# Modding
+
* Very focused on ease of modding without weird formats or obscure tools.
* Early stages of modding and as such some features are not fully implemented yet
* SpaghettiKart does not use Retro
@@ -39,22 +40,22 @@ Mods are loaded in dependency order. If mod A depends on mod B, then B will be l
## Mod Types
* Textures Pack
- * Some texture might not be possible to change yet, but most of them can be changed.
- * [link](textures-pack.md)
+ * Some texture might not be possible to change yet, but most of them can be changed.
+ * [link](textures-pack.md)
* Custom Tracks (CT)
- * Custom tracks are reserved for advanced users. We plan to simplify the process in the future.
- * [link](custom-track.md)
+ * Custom tracks are reserved for advanced users. Don't hesitate to make feedback and PR to improve the doc.
+ * [link](custom-track.md)
* Custom Characters
- * Custom characters can only replace existing characters for now. We plan to allow to add new characters in the future.
- * [link](custom-characters.md)
+ * Custom characters can only replace existing characters for now. We plan to allow to add new characters in the future.
+ * [link](custom-characters.md)
* Custom Audio
- * Only custom sequences are supported, not custom samples (like voices or sound effects).
- * [link](custom-audio.md)
+ * Only custom sequences are supported, not custom samples (like voices or sound effects).
+ * [link](custom-audio.md)
* Scripting
- * Add logic to the game are not possible yet but we plan to add support for scripting in the future. We will use [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) with [component model](https://component-model.bytecodealliance.org/) this will allow you to choose your language (Rust, C, C++, Python, JS, etc.) and compile it to WebAssembly.
+ * Add logic to the game are not possible yet but we plan to add support for scripting in the future. We will use [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) with [component model](https://component-model.bytecodealliance.org/) this will allow you to choose your language (Rust, C, C++, Python, JS, etc.) and compile it to WebAssembly.
* 3D Models For Characters
- * 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.
+ * 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.
* Custom Sounds
- * Custom sounds are not supported yet. We plan to add support for custom sounds in the future.
+ * Custom sounds are not supported yet. We plan to add support for custom sounds in the future.
* Custom Menus
- * Custom menus are not supported yet. We plan to add support for custom menus in the future.
+ * Custom menus are not supported yet. We plan to add support for custom menus in the future.