From 580c5baeb3af125371de53fb35592d92a97a7d17 Mon Sep 17 00:00:00 2001
From: MysterD <myster@d>
Date: Wed, 16 Mar 2022 22:55:16 -0700
Subject: [PATCH] Add custom box model example

---
 .../custom_box/custom_box_surface.rgba16.png  | Bin 0 -> 538 bytes
 .../actors/custom_box/geo.inc.c               |  15 +++
 .../actors/custom_box/model.inc.c             |  97 ++++++++++++++++++
 .../actors/custom_box_geo.bin                 | Bin 0 -> 1991 bytes
 docs/lua/examples/custom-box-model/main.lua   |  24 +++++
 docs/lua/lua.md                               |   3 +-
 6 files changed, 138 insertions(+), 1 deletion(-)
 create mode 100644 docs/lua/examples/custom-box-model/actors/custom_box/custom_box_surface.rgba16.png
 create mode 100644 docs/lua/examples/custom-box-model/actors/custom_box/geo.inc.c
 create mode 100644 docs/lua/examples/custom-box-model/actors/custom_box/model.inc.c
 create mode 100644 docs/lua/examples/custom-box-model/actors/custom_box_geo.bin
 create mode 100644 docs/lua/examples/custom-box-model/main.lua

diff --git a/docs/lua/examples/custom-box-model/actors/custom_box/custom_box_surface.rgba16.png b/docs/lua/examples/custom-box-model/actors/custom_box/custom_box_surface.rgba16.png
new file mode 100644
index 0000000000000000000000000000000000000000..6c14136b02ec754aed90f3bf79fb7718cff9aa15
GIT binary patch
literal 538
zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE1|*BCs=hEVFy>`CI|pPYCo?c;Oe~#f?ak~c
z(rQ1s<B@i&n37nu%f=fG8XZfI9a8h?5bU{?V|LT!MDk7F2?^RaA~?hr^{ziuzhG^`
zY6Xrig`}taAFg^tyq8c^vO4|duZ8h*qhhw2i+dsqm=6bNOq=_o#AUX>UWTs!kC#df
zeR(t1*-Cc1{w&{f|H6`2r4e6$)!(1L*miEAZ$_4=oN?}Q9UDcNSk2pA<}KA{=1dg3
zCw@)Va>0kzOTndeA#>J#UY(>aIG<_$tCgws1+Um=TP|0yQIXMlqW$c9<rQBmqoX?`
zSJoQ+F6=b+W$6_Wopv%<O=qjd%)f7?|9v_eAk?o}KU=HMV$+i&tGlBnu9I9j?S<se
zPa&c2_J1x}dvRjb_dX62`-*#~8Mfp&=3f46$7i#?jN@Omg|^ur)svZje7~G+6T8*?
zKx)n$^DS4*=B#smKR4In*z_mUUvAc^uxmS~QWEcYJIQwS`_jHV#f@72C7jl~4K#i?
zd(ZzVk-?tHJM$+n0yqmiB8wRqxP?HN@zUM8KS04CPZ!6K2>0ZagoGdbN0`}Wu$@U;
zada`C1TUl5oX&uzQ!^j4Du=ChTby9R;^vG_9B^j160o@FasQTe=Nj4%tYCI?W?*<P
W#A5%I^O`EqbOujXKbLh*2~7YTgyMq$

literal 0
HcmV?d00001

diff --git a/docs/lua/examples/custom-box-model/actors/custom_box/geo.inc.c b/docs/lua/examples/custom-box-model/actors/custom_box/geo.inc.c
new file mode 100644
index 00000000..3a8f488c
--- /dev/null
+++ b/docs/lua/examples/custom-box-model/actors/custom_box/geo.inc.c
@@ -0,0 +1,15 @@
+// 0x0F0005D0
+const GeoLayout custom_box_geo[] = {
+   GEO_CULLING_RADIUS(500),
+   GEO_OPEN_NODE(),
+      GEO_SHADOW(SHADOW_SQUARE_PERMANENT, 0xB4, 240),
+      GEO_OPEN_NODE(),
+         GEO_SWITCH_CASE(2, geo_switch_anim_state),
+         GEO_OPEN_NODE(),
+            GEO_DISPLAY_LIST(LAYER_OPAQUE, custom_box_seg8_dl_08012D20),
+            GEO_DISPLAY_LIST(LAYER_OPAQUE, custom_box_seg8_dl_08012D48),
+         GEO_CLOSE_NODE(),
+      GEO_CLOSE_NODE(),
+   GEO_CLOSE_NODE(),
+   GEO_END(),
+};
diff --git a/docs/lua/examples/custom-box-model/actors/custom_box/model.inc.c b/docs/lua/examples/custom-box-model/actors/custom_box/model.inc.c
new file mode 100644
index 00000000..4287baf1
--- /dev/null
+++ b/docs/lua/examples/custom-box-model/actors/custom_box/model.inc.c
@@ -0,0 +1,97 @@
+// Breakable Box
+
+// 0x08011A78
+static const Lights1 custom_box_seg8_lights_08011A80 = gdSPDefLights1(
+    0x3f, 0x3f, 0x3f,
+    0xff, 0xff, 0xff, 0x28, 0x28, 0x28
+);
+
+// 0x08011A90
+ALIGNED8 static const Texture custom_box_texture[] = {
+#include "actors/custom_box/custom_box_surface.rgba16.inc.c"
+};
+
+// 0x08012A90
+static const Vtx custom_box_seg8_vertex_08012A90[] = {
+    {{{  -100,      0,   -100}, 0, {   992,      0}, {0x81, 0x00, 0x00, 0xff}}},
+    {{{  -100,      0,    100}, 0, {   992,    992}, {0x81, 0x00, 0x00, 0xff}}},
+    {{{  -100,    200,    100}, 0, {     0,    992}, {0x81, 0x00, 0x00, 0xff}}},
+    {{{  -100,      0,    100}, 0, {     0,    992}, {0x00, 0x00, 0x7f, 0xff}}},
+    {{{   100,      0,    100}, 0, {   992,    992}, {0x00, 0x00, 0x7f, 0xff}}},
+    {{{   100,    200,    100}, 0, {   992,      0}, {0x00, 0x00, 0x7f, 0xff}}},
+    {{{  -100,    200,    100}, 0, {     0,      0}, {0x00, 0x00, 0x7f, 0xff}}},
+    {{{   100,      0,   -100}, 0, {   992,      0}, {0x00, 0x81, 0x00, 0xff}}},
+    {{{   100,      0,    100}, 0, {     0,      0}, {0x00, 0x81, 0x00, 0xff}}},
+    {{{  -100,      0,    100}, 0, {     0,    992}, {0x00, 0x81, 0x00, 0xff}}},
+    {{{  -100,      0,   -100}, 0, {   992,    992}, {0x00, 0x81, 0x00, 0xff}}},
+    {{{   100,    200,   -100}, 0, {     0,      0}, {0x7f, 0x00, 0x00, 0xff}}},
+    {{{   100,    200,    100}, 0, {     0,    992}, {0x7f, 0x00, 0x00, 0xff}}},
+    {{{   100,      0,    100}, 0, {   992,    992}, {0x7f, 0x00, 0x00, 0xff}}},
+    {{{   100,      0,   -100}, 0, {   992,      0}, {0x7f, 0x00, 0x00, 0xff}}},
+};
+
+// 0x08012B80
+static const Vtx custom_box_seg8_vertex_08012B80[] = {
+    {{{  -100,    200,    100}, 0, {     0,      0}, {0x00, 0x7f, 0x00, 0xff}}},
+    {{{   100,    200,   -100}, 0, {   992,    992}, {0x00, 0x7f, 0x00, 0xff}}},
+    {{{  -100,    200,   -100}, 0, {   992,      0}, {0x00, 0x7f, 0x00, 0xff}}},
+    {{{   100,    200,    100}, 0, {     0,    992}, {0x00, 0x7f, 0x00, 0xff}}},
+    {{{   100,    200,   -100}, 0, {     0,      0}, {0x00, 0x00, 0x81, 0xff}}},
+    {{{   100,      0,   -100}, 0, {     0,    992}, {0x00, 0x00, 0x81, 0xff}}},
+    {{{  -100,      0,   -100}, 0, {   992,    992}, {0x00, 0x00, 0x81, 0xff}}},
+    {{{  -100,    200,   -100}, 0, {   992,      0}, {0x00, 0x00, 0x81, 0xff}}},
+    {{{  -100,      0,   -100}, 0, {   992,      0}, {0x81, 0x00, 0x00, 0xff}}},
+    {{{  -100,    200,    100}, 0, {     0,    992}, {0x81, 0x00, 0x00, 0xff}}},
+    {{{  -100,    200,   -100}, 0, {     0,      0}, {0x81, 0x00, 0x00, 0xff}}},
+};
+
+// 0x08012C30 - 0x08012CD8
+const Gfx custom_box_seg8_dl_08012C30[] = {
+    gsSPLight(&custom_box_seg8_lights_08011A80.l, 1),
+    gsSPLight(&custom_box_seg8_lights_08011A80.a, 2),
+    gsSPVertex(custom_box_seg8_vertex_08012A90, 15, 0),
+    gsSP2Triangles( 0,  1,  2, 0x0,  3,  4,  5, 0x0),
+    gsSP2Triangles( 3,  5,  6, 0x0,  7,  8,  9, 0x0),
+    gsSP2Triangles( 7,  9, 10, 0x0, 11, 12, 13, 0x0),
+    gsSP1Triangle(11, 13, 14, 0x0),
+    gsSPVertex(custom_box_seg8_vertex_08012B80, 11, 0),
+    gsSP2Triangles( 0,  1,  2, 0x0,  0,  3,  1, 0x0),
+    gsSP2Triangles( 4,  5,  6, 0x0,  4,  6,  7, 0x0),
+    gsSP1Triangle( 8,  9, 10, 0x0),
+    gsSPTexture(0xFFFF, 0xFFFF, 0, G_TX_RENDERTILE, G_OFF),
+    gsDPPipeSync(),
+    gsDPSetCombineMode(G_CC_SHADE, G_CC_SHADE),
+    gsSPSetGeometryMode(G_SHADING_SMOOTH),
+    gsSPEndDisplayList(),
+};
+
+// 0x08012CD8 - 0x08012D20
+const Gfx custom_box_seg8_dl_08012CD8[] = {
+    gsDPPipeSync(),
+    gsDPSetCombineMode(G_CC_MODULATERGB, G_CC_MODULATERGB),
+    gsSPClearGeometryMode(G_SHADING_SMOOTH),
+    gsDPSetTile(G_IM_FMT_RGBA, G_IM_SIZ_16b, 0, 0, G_TX_LOADTILE, 0, G_TX_WRAP | G_TX_NOMIRROR, G_TX_NOMASK, G_TX_NOLOD, G_TX_WRAP | G_TX_NOMIRROR, G_TX_NOMASK, G_TX_NOLOD),
+    gsSPTexture(0xFFFF, 0xFFFF, 0, G_TX_RENDERTILE, G_ON),
+    gsDPTileSync(),
+    gsDPSetTile(G_IM_FMT_RGBA, G_IM_SIZ_16b, 8, 0, G_TX_RENDERTILE, 0, G_TX_CLAMP, 5, G_TX_NOLOD, G_TX_CLAMP, 5, G_TX_NOLOD),
+    gsDPSetTileSize(0, 0, 0, (32 - 1) << G_TEXTURE_IMAGE_FRAC, (32 - 1) << G_TEXTURE_IMAGE_FRAC),
+    gsSPEndDisplayList(),
+};
+
+// 0x08012D20 - 0x08012D48
+const Gfx custom_box_seg8_dl_08012D20[] = {
+    gsSPDisplayList(custom_box_seg8_dl_08012CD8),
+    gsDPSetTextureImage(G_IM_FMT_RGBA, G_IM_SIZ_16b, 1, custom_box_texture),
+    gsDPLoadSync(),
+    gsDPLoadBlock(G_TX_LOADTILE, 0, 0, 32 * 32 - 1, CALC_DXT(32, G_IM_SIZ_16b_BYTES)),
+    gsSPBranchList(custom_box_seg8_dl_08012C30),
+};
+
+// 0x08012D20 - 0x08012D70
+const Gfx custom_box_seg8_dl_08012D48[] = {
+    gsSPDisplayList(custom_box_seg8_dl_08012CD8),
+    gsDPSetTextureImage(G_IM_FMT_RGBA, G_IM_SIZ_16b, 1, custom_box_texture),
+    gsDPLoadSync(),
+    gsDPLoadBlock(G_TX_LOADTILE, 0, 0, 32 * 32 - 1, CALC_DXT(32, G_IM_SIZ_16b_BYTES)),
+    gsSPBranchList(custom_box_seg8_dl_08012C30),
+};
diff --git a/docs/lua/examples/custom-box-model/actors/custom_box_geo.bin b/docs/lua/examples/custom-box-model/actors/custom_box_geo.bin
new file mode 100644
index 0000000000000000000000000000000000000000..91441f96b673d1f309c4ef94fd74b15d2600789d
GIT binary patch
literal 1991
zcmZRPPA)Aj$<K{X%CCqoPEEInPsxclurM$*a(1!cWB`NbAX24H=+B>@|AFBCO^C3-
zS0K&K#K3SJBno7|0E-I<d<}2{>-<!6fE^@sA4D(-Az4(CT2WG3lqv<(+!^5K&dVjm
z1ysW8>ERLtq!mDzgAGU)S5<vsU|`J4baoENOipHC(3n^{(b}8YQKZ#=a>pa>Rxu^9
zXqSyQ8Z<hV9y_Gw(IMD#E641n%ZcQhz7rC(Z$xm2E$Ur=sD8oPgw+ZhT?$E0`9ECs
zh<GodsAP5e&0h=S=SIbBH5d0p7BC+U(3m#&M~Ta9f4vM{{~s@v8v62Pth1HucKunt
z=l+EyuSz4n{;Iz}f3fY{Lf?!mQ90w><vKQsGO?PsyUbgv&&-)9c2E48tmT3at(SsJ
z>q6$N{k%F!U2s0r{8uYe>kD47&$e8yV51_V^+fyG_sT22Rz^p6My{+i`d!#*?90+C
zB0BA4u$s<RjhTPnO8@(GHbAIfvwpT#pT(vpM^<-7O<X6ra@q^YpPxcP-|hcgvi9P{
zs_%UqCiWHgPBU!Dam>B^*^bX<eHq8UY71?%KdL7)|M-46+a`9a`GM4&Ip$lgn9W(|
z{C;k(#j)v6roY^*Q(@P3PNgK?@ph8!>i4C6d5Rmg{7X2kcN=K@ZuXx4QzC;slXvD%
zU<7a$ctjR6FmMZjFyp1Wb$@_@L7py-ArbD$DG3Qb_>VBN&0sr|w&LhwJ_%k%u{oUq
zO{Zo)W>pSb?Y20<gvHGnojBmka3x@I(c}It>&`W_A6UWc=FGtGUWmp1E9W&;py>>r
zu6{1-oD!NC<&jbhIBDi&re~BCgOjJBqlJOJy*&d6gHj&|YiMYI^fNGHXe>)D0wy^~
zx^}cQ;0G$215B|X{D7H(p^<^%KZu<I6o0_{fEmI+0p^25kmVsd>i>h(!qhV`fcOyg
zAoD={Isak$A$*Wpn0-JC;rc<cAU@1~u=!9vL_N?%u=*2V{UGJ_K=;Dz1F47b5$=KU
zVfKOe_yfhs!hjoSFp8t=A(p@$0px?^VTJ--f#L`lA0!U}jbKkg_~2j$dlGIQLnEqr
zU_K&{utx$S5J2)QxJxf%0|B5bxY#)E1o(vnVWbGOq{IkP%SoJCV4=kz_kn>CtGQ??
z4HOV8Obl#Xz~YRDi;Yc4fR8~$h>uN5LX1I1N{kgGFSdaQvw#r<Gm8mWGV%Zo<m2H0
znk4`>11JY8g~6pYFgyIQsr(0|{sT*E1(4SJAOd%QxfmHhO}Yp2818^|u>cvwz##A!
zqz+4|4v}Vf2BkkUFfswF0Y(DG8bkbt(_R-7i$UN%Rz9RMDLpkGl*SYozA&-?X)y*a
uhAj*q7(i@31||l#P(No-Ndw}G0uvbCU<C$0P#F>GOu)ep3JMqorCk87FMG8B

literal 0
HcmV?d00001

diff --git a/docs/lua/examples/custom-box-model/main.lua b/docs/lua/examples/custom-box-model/main.lua
new file mode 100644
index 00000000..050436c1
--- /dev/null
+++ b/docs/lua/examples/custom-box-model/main.lua
@@ -0,0 +1,24 @@
+-- name: Custom Box Model
+-- description: Press DPAD+down to spawn a box
+
+E_MODEL_CUSTOM_BOX = smlua_model_util_get_id("custom_box_geo")
+
+function mario_update_local(m)
+    if (m.controller.buttonPressed & D_JPAD) ~= 0 then
+        print('spawning box: ', id_bhvBreakableBox, E_MODEL_CUSTOM_BOX)
+        -- spawn breakable box
+        spawn_sync_object(
+            id_bhvBreakableBoxSmall,
+            E_MODEL_CUSTOM_BOX,
+            m.pos.x, m.pos.y, m.pos.z,
+            nil)
+    end
+end
+
+function mario_update(m)
+    if m.playerIndex == 0 then
+        mario_update_local(m)
+    end
+end
+
+hook_event(HOOK_MARIO_UPDATE, mario_update)
diff --git a/docs/lua/lua.md b/docs/lua/lua.md
index b2f2b8b0..de8b8bf7 100644
--- a/docs/lua/lua.md
+++ b/docs/lua/lua.md
@@ -15,7 +15,7 @@ Lua scripts you make can be placed either the `mods` folder in the base director
 - When developing Lua mods, run the game from a console. Lua errors and logs will appear there.
 - You can use the `print()` command when debugging. Your logs will show up in the console.
 - [Setting up Visual Studio Code](vs-code-setup.md) will give you autocomplete and other nice things.
-
+- You can create a folder within the mods folder containing multiple lua scripts as long as one script is called `main.lua`. Dynos actors can be placed inside this mod folder under `<your mod folder>/actors/`.
 <br />
 
 ## Sections
@@ -54,3 +54,4 @@ All of this is a holdover from when there were only two players. It was a reason
 - [Replace Goomba Behavior](examples/behavior-replace-goomba.lua)
 - [Add to Goomba Behavior](examples/behavior-add-to-goomba.lua)
 - [Behavior with Surface Collisions](examples/behavior-surface-collisions.lua)
+- [Custom Box Model](examples/custom-box-model)