From 8006626b60d96021146030fad89d1cbec3d9a43d Mon Sep 17 00:00:00 2001 From: Evelyn Head Date: Mon, 23 Oct 2023 15:24:57 +1030 Subject: [PATCH] Update README.md --- README.md | 69 +++++++++++++++++++++++++++++++++++++ SOURCES.md | 3 +- assets/dolphin-extract.png | Bin 0 -> 11811 bytes 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 assets/dolphin-extract.png diff --git a/README.md b/README.md index 8b13789..20ef3c2 100644 --- a/README.md +++ b/README.md @@ -1 +1,70 @@ +Wii Party +============= +A work-in-progress decompilation of Wii Party. + +All versions of the game are supported (with PAL as the default): + +- `SUPJ01-R0`: Rev 0 (JPN) +- `SUPJ01-R1`: Rev 1 (JPN) +- `SUPP01`: Rev 0 (PAL) +- `SUPE01`: Rev 0 (USA) +- `SUPK01`: Rev 0 (KOR) + +Dependencies +============ + +Windows: +-------- + +On Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required. +When running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds. + +- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`. + - Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K). +- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`. + - Quick install via pip: `pip install ninja` + +macOS: +------ +- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages): + ``` + brew install ninja + ``` +- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine): + ``` + brew install --cask --no-quarantine gcenx/wine/wine-crossover + ``` + +After OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can unquarantine it using: +```sh +sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app' +``` + +Linux: +------ +- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages). +- For non-x86(_64) platforms: Install wine from your package manager. + - For x86(_64), [WiBo](https://github.com/decompals/WiBo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used. + +Building +======== + +- Clone the repository: + ``` + git clone https://github.com/zeldaret/tww.git + ``` +- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/SUPP01` (or `SUPJ01-R0` for JPN r0, `SUPE01` for USA, etc.). +![](assets/dolphin-extract.png) + - To save space, the only necessary files are the following. Any others can be deleted. + - `sys/main.dol` + - `files/rel/*.rel.lz` +- Configure: + ``` + python configure.py + ``` + To use a version other than `SUPP01` (PAL), specify `--version SUPJ01-R0` (JPN r0), `--version SUPJ01-R1` (JPN r1), `--version SUPE01` (USA), or `--version SUPK01` (KOR). +- Build: + ``` + ninja + ``` diff --git a/SOURCES.md b/SOURCES.md index be4dad3..5902807 100644 --- a/SOURCES.md +++ b/SOURCES.md @@ -1 +1,2 @@ -Runtime.PPCEABI.H code borrowed from xbret/xenoblade and PrimeDecomp/echoes \ No newline at end of file +- Runtime.PPCEABI.H code borrowed from xbret/xenoblade and PrimeDecomp/echoes +- README based off zeldaret/tww and PrimeDecomp/echoes \ No newline at end of file diff --git a/assets/dolphin-extract.png b/assets/dolphin-extract.png new file mode 100644 index 0000000000000000000000000000000000000000..66716139d5d576b24070fa396078dc88e07886af GIT binary patch literal 11811 zcmcI~cT`i`_a}&mNEeU}DoAhA481-O=}7Mo>4bpPgr?F&O6XO35v2DbMGO$6N|P!O zkX}P?feF6H_cw3W%&avtYyL>iN$$D#?6d1`3qmjW zR3vfScGCb60gAk%{Lo$YR@jE@gNL^bvhL6}(Y?iD7&S5K|7)g0?baiOz^1h2$B$eS zWRg|djKO-=x;7alpG(BXr6k(kvjGxP5)x8$6L#FHK8%2FW2nQ@1X=+8jBfv@qX11* zb&~V&<;$ei-FeC;=wjXT^RsF38k;Loqh`P4sLU4D;p->!AK5!P=HlQH-!@)yVN7y; zR6EMFGm~p|br%gQvpn0c=Nmq*H~rK$@jBrWcnmqq`~^QSAODzp)p|wTFRkQ$3d?Ob za#LxUXtrq!e$Bk2DiPhcmBUvQ zFM>rl?Zl1Fz8<7Q5%fLL23Cthn}RV{q8KH6ZD7 zs<<4WP=k6rv|RpPFF;*riDKwV>iNOk(S5ZU&x~#8(o3>-MSPc8Pc0{dcL|9FD@w2hv1in%#pAe#foXnE&wE%7hXP?_%bjD^(}{=PnLxFNSXgfW6Bf^N zv;7C;Y~aXmMa2qWM)z~RD*E^fnS9g(u~+yZj$n8Ep$e+SAnIvqAoL!0f1mMhyr<)!>pJ9){Ij*x~IJ z`T1Jp@b(h)N!omz>~{hMiby0ta4@OdX?QZt5+4B;-i*o&h zcv$_n>4;B=u(0gt`RTI`$zVE8#cG&U>$rq?c9u>%Ntn6aZT@R_ja4Z6e>;No%gvtL zefRM0yDX!7Avk{~sRaLjCJu#C=!2Jqa)+5`O^+uBRBCbI*s`Rzg>~rpW&QJz0M|<> zuW&jN;JzBYT!5kIVWH8jQzXif13ol2ry(yd|FhYKl%#=&fs?B1^X0eXXXRZBjrO%0 zVdpq|@WpZMkic5!Ut*3>!Mo&5U-VlG1N6H z68x{1lrSqr-JRT{ zRNGpF-p|j^eYuau(Tq75|CcFs@fiVdwwX43rC_X#ZJVT<1eO_&w5X2hbkUi1eAQ!&HC;cLI&Nnv=k-6HCJuI=^4&wuF*EvywCvhG#^NZYwup8)dxKaQj$uvSn%GM~$ml<{o`6bcK7a5xEHa zF z9Q)v=l1bYIcyg@q6tnGV*XLBfSGrRg5fBfZjn?x+7!!EbI70#JAi}?FQNR4x=>QSa z+?b0_fUjGvVX}U0f0!%oVX#3ye6Mw$rbh1%BP{tn@fBX)clP{r7D7G|XNq1D_-`N|pkaFR5SiCv8!{ z?pRO5eT3Hh-Mix!tr!ApTw^?T+m?kNjU)hni`fzZp5>TVNy{=7;KHaC&bD#} zA`QRa)SKEqUrw{Ww8RiRQ-aFKO5Rnn#5T z(sP$GWc2w`!5=;CwbtrNQY3;ua((~-776ewdKho!dYPFN$~O7!sp<3 z`Kf&e8t%dAV)tvlPUZovw{jhg7t3Q@ZAh!*>($LF5AVGA9J+60*;hOGR-qye1mmNk zb6QxhuluWjEizn7iGTa&qH$Er(#NsGnfHsmb(|oMX_39yv%MorGvfS!3@ z#1i7ENVeISr6Qw~t*bcWkSD+6U~BmSz7nWqRDw%(*Y=`{e|YgAQTLX%bCu>%Scec> zOdohHB$hSB)%G1t&+-M@xTony*SW2c+ z3L)M`Y1EjIU;PD=FJOVQtznpV^f#Cp!e?L%%{iIQ5(%p`VFSvyKT`oM>^i@?3Q#@q zBi^r}Ga1}x>u06s((s=i4O3=-HPjWDGfN;9PtUwNG(s}?mwRkA)(^SQ=te$ORcfxk zFO}YwP^^N5=SNPRq#}CV1|E;?%((beMP<)KZRCF0Gt=M>*zDP99Cb^Y;M16)+PFGW zxsl7Wo@AJ~ci3a^q;E;B0_{7_b~{cT@svxi{35mh)>~@Ro`HzLPL~dj0hi}}&CNYd zfEQqoA6~8d3`@pE0hK+nhv2+Cg0Z-U@A2gA9=PN&`P|@$grak3U;l<6wG!_qwF`gI zt0ie^X+m#nkHYD?=0b*?s8QFa8}lNcmm)4CR!SbNgiQ0mtm)VqLCcVy*M5k?oDF4q z=_0j^l6~_RZ4#)Dw7-tG7cPakki9u-gfR13BE0a*{1x3UCC-!lAw5z|oOjqvo({zM z?Z`b#(m%B<0Sh&l$t+Ni(8f1=0J8GFaIge?E{))eTo@dwe}@VB`alGI2(vN}{`ehVz(?=FYk&HB~*&-T0s9W z0VTrr_RN9*AO->YOTNgd{Zv_?>#$w?{}faR(3|_Bf`wZQgZ}5CpD8Wm#Vc{XvBYZR zJTV6E$ZGQ3-UHGNLc5nKW8=TOTmv|)uYZQD<^R`FC=%)IZ$$P7$311$Pwn~h+{1;L zMz{7)=OmL}#+w6=sjpMDhq%P^Z|8o1YeIa2nlC4*milG?uIlXjNehI|y(bRy|hJcQiU=i1Pk;lZROi5(6Ag-!m2z=t2i9q7qoU2O?F zV_4vp1yAzp^N{baN~{u5>P_yS+XWkUAK#zed&j@Nzt_Vjf;mlT&@UH$937|QNcjW6 z+ygHF$f+v^0FTk-!O$}zh`+FDJS?xzG14E-Y-#M4|2C(X5DQC&;64~|>)phBD2`x= z%c>UPcj|CvetPRqPI{+j)7ULTDnm%V!16^;2 zFIzcvl2Jzq zjFQtM+bWnxa&1ANEnLpuhDZxJX7a+Yq;HtJbfWx%;m?SdDj$BJnF`Rcus4S$xJzgc z*}aBiQXQ<(J716u($Rj>-n$mgt{+4HD1i2x|I!4!KMJ6UDXRP_tGr3Yfn)!DC;h*a zN+&WfQy!!7q_5)M$30+1az^d*(_`0Rhg_q3_J92)a=5VmE7i&R5AGjhS;*^r-tb{j zf>7xV=uJLj=9H{P>zPQuQ9$x#1u$Cd=wp5-`je%^b>4C=_gLL1BB&TJ0C%}Pap%Nq zzkawpsU)jb(#OtY5U<9i7vEASu_Yh`8fB7GFWt&3lL! z^H-6tZ3Yc*%}%^Y(5+xRkJ6dHdS58nqoQPuDt9DG#XWh1=((whuhSCUC;yP=+e;HQ zG&D3Hr*6{JK|jO6)s|OeI=DO7(JM-lQD-9g^xAV`1-CN!5nZ@7ajOV5I*_p zK)Sf>2NJN`*>Ju}VEpU8_9X;|;J7Ji*CNWAX&7eaoqo9!4)$K73-T9r6GrcIISP*; zZ2&s*WYp0C+#G+iw(*9wzP;2@U%Yniy+nP*A+alvPbEqjSaK@F>4hmRI{{P)>iu5q zL-E$A_>xxH_}qtsI(I@s7E!@Z&c;f3p-{t2emX~(S^kr0X%$F~6)mxbm2R#~x!uwq z`9c1(iAt%}Xwo0tuyu#iY>gm7-x4T8QVD@N;RXgOsF5KrTPc-1!ht z?&7o(mu_u`txcWl*qoG$p`KE6b2Tn9ulN%%}Li7S^->G0mPJ9UqC<2Un>6nKB?4RB*TL8?(h6Gy1 zRXR-ypprXr-CQOC-AS^L{KaSGt!h_bb&V5ZM0o*kew)vlFw}QR7V3ZcB=x6Xn7^c# zilJl^cZj?o+0yAoL5&hj-2#v$w(<2X4(TXGm1(9X`ahiRrHv{{4lJf6wiolxU);$w zRF%#+p_P2Y~ zCLK+Gin*WOk#F6d)U)BGfVc0s1TBr~615OF3*8&j=BL*byc?2>`nSC`_p}$&4!e|` z?p7JB88o8>p?qh(7r5jUfZ6DiIOI}Z`zsaiP9&@2Mo(;-s3R}d)oc({qo~iMN zG!@ButI!`CemDy|g}ZYvQ!2L~s2*Lg~Db#5Y@@@rD z1&0|*)0zuMwv>gMxKL}MA&WLD{ZrYa$8 z?x>%=ihmKRWQX`FY$;{|Smz>R<5B#k>nmjmxaEXHD0}<`BQC|T#di(>GeZOJL0&z;$pc~0EJZ#Eb&wL*>w z&ZGo{c%$sDCYnSDOiZ`$PZd5uA(%#L9mlP%NZAS*L@-|V`hi5hTaIT(Zp%~;nS=m& zYPs5E;SQNVuJOCN*`Qw|YZ}w78UZ7q?{3-*1kr5pD zkc`tmXQBQ2IYn@-G+)KO&5Jx;)Geg-WPyN|o<0bLrKYq`6UB`!=y)phWGrdLpw^iQ z?9;Uv>X;w^RHCP{0HhM6VNCRzd1Avul~E5$Q{?Ntjz$jCcSgR3kqZHY6sUMjvcPTV zL`5Z~;5w(tTZ`DKx2TDAl@FIh^%$nu^n@An1BQDdiCj(IAnkZ>Xri}d*5q*0_xMpa zR1EPlKeDxvj{3}`x=iBb7>^+;Z{F?hD+Pp(pE_H z`GjgvDUrYQ1w!1RbyB*;7Xn3hx?+dqHdfH!>t8FD%X}_O>i(Uq*!rA$=gW|@bETr= z?uVe3=5){FQVN(}26RC=RRSVVYTjlhVWg#oh++_b*Rsg2m0g=LEp|aQSG04)AFH9d(I<}Xv5*8VeZ5y=C$2rMElI(s z)fty$R`r08<-X(>z2aic&BUqCz>GYGRSJR({kDL;(b65}TV6gfRl}sy zX?TSb+qltk?c!y$eWH?J@dzn98`iRbr)%F_IJWlc!avuO`k|)Ge(L46W@Ri3(%Z-o zvD|7rjhx{IPfAY=>PJ(ZQ$I$YR6>+N-O-;)oo~N3vbH3*ED|i#5TsH&Itjk^5N?)& z7_YmJ4@Y99MZ8eO+i}~S$EKwQC?jAn&B_Vok%Bh4Uy{FSd{19n0`y9a{vvq5okc_^ za<|&`{0KzL$oSyA3rHa5ip@!sgx(tkZNH2Z)7cwMA`($vDyH%^0Uo}Il$-2%OP~y- z7;j5`c`C2jHbOiQBWfawRx zw=-)R!_ZQ-E>z7?3XHS)b>}K75FPV;rU!Qie4t;#_{y}!GD5_$puL+w`Gwc2ilH$N zX!nkz6E(5=iVVk04>nfty^R@)X^0Gcg0al-GmLNf@zUPO*x`Ue|k8g)$^z0-kYjr6`> zGzhGM&TF9KJ{M~{R-^g=Wp;A%AUDuIqzGE<*If%Nrh2%Wmb)59<< zMm2RgqadI+Q*8uUv}sgaLwYpZ)F&ps%>b)(&X3N5WOWD0W2B&u3+o>o-L$_rt=(&P zUE;8;{zNNhdHHSMdX()5RHwxG1I-dez)#;F+>b%jgKUJMI0?x__&aRoca{>Ota}rO zz6BF>p3_|{tX`z>4UM>E6b$sA+wFgOW{)^ZtFc2(S?mC~vDFC-Y&7@UP77#>ONkGu z>#|-EWO3rZ9XbSrP2)onkH&twbR?+BOV>FQ#!gwQjEAY>CM6XpB{-EEW(Jggb&-j@ zkHDplTE2;7%(x+s}GSUQsSv67>B&%&kW_i+U4$t(aeD?r{JI!o* z;=`mnGVEQlPL6X%2}w8)ZQeMRcx8Gf2jy7O3&o#xQ^>9JO~`^Sc@n&v{- z5?Vtnq{C|cw#h6%l}Ve;f{C(&ipdwNVU@q0^gkn7xF`fNEUXw48Mt5y$JZhHUv5K2 z*grIIvc^6RgLy)bR0^R=1H-4xOv910{q7gPZJ^*9m`%w?rp<&9CZTWO5+hAi;QOn+ z{7j}h=8BMy*=<6fN9`}DURc@zBwuryS=<{QJ&102^Sy)NlP?px0qU=vF)LN8zE6$X zdL^jm{JEjo65uV-d$uEYS{aN@u@bxg>fG-X*293l@CHWCD{no%nup5qdK_YnJ`;llsu<{))YwOZ3s^w32D~gD?cw7*0s8kpdUC z=Yf)8DbC;E+}zUbi8vyvusESl@=>8ar5u|^3}UG*FAI(pA4T_bMo>)I@dew+hf|kr6^&3mI1D*=CMQksq@yK7U~uRNF+JEaS`8QkXmX_M>XO7Q2Y3qwd@g zF(l(~HO!7R78;O~nN$N=SUFEjYIs!mbHOpPT(tG*cV-yYVdpiz!eoKD*d?i=akEBE z@kdO6hnHRVt{x!f=O0GkQIqdJQ_0vpHD=`lxnaG@G72vjHZxsxgq6!uN1XxxIj@$I znAp#u9AUTBqXGY>)_p%(fa|+Ep&_dn6Fbx>iE$v#|^=Yzv5o!U%_d_D2vulXLeX24UOb7O(aw+olc?*(6^qXNPbv_@jPM673c z{O*!Ly5@Yo%bEN#9HB8b{;V6I+5{Mvg}OVT!6Ze}#EyKKl9I+g5({V650C0izG#`& zHV$yMvdQ$`NFwGd9k^MRoK-bT+-v(bhg5U_no1Hck@heW!Et_M_Mj`*4b#5?plMPC zfuB!C4ldZ%SNhYGR1&#|R72B{6{@sF(v_g?m3OVM(RW$W&4+kHEm(v5Y=j< zlox6gma*|N3m~e_kW#QiYDPH>WMpQ-bRx#iergz2Eba(3F|PUvUVF`(kdv=`y z?a6U5l+zvYA&nZs>zdzRnu~bfCu%D~JyWng(&%vuIVNDUr!<}$6%w3#%2z~ki#N@a zr-M}A>*oP!F3;F!X=FqGJ27XG1Ch>z!T5|?N&F?<8u!^x8RIDvqtp1?8rQ&>e#H`S ze?F@`mB3%#=$DAT)Plvx*Q<0#Z}0a5>2%p)d>+ue-V6rELMdSGq8ZB^{iMYZ>%PfalzhbBp zp+S%N4pY z!d$jpvPK5I)}0I2z=VW6M>$8J$*I$t;WW9qS@5xNIks_TpJT8V<_(Z>3E0f>ZM!Eo z=hD{H7h;62X7||yT8?~Oe(SN+LkYb+U9msiBeoP^g#0Fho*+Z*YmXaqfsM9`8Aqz$ zX)M(TG9-;Fk?)_Un&>R-9k^$(kF;5%Y(1=mHbi<^mpJ_HFUt>N7@tv5Dx27wkJoG= z&y^O*UZJoevlXtOHnM+M89AszqIY^ub}fm!E!UDjH$+$yjyV<(w)iSQp+AorlAa9$ z(Pe^6#&loNA^%u$D9$o4p8F52ZS{`=N^BOpA{S8j<#z5K9$NZd^`Cg5kgi*)lEtA> z^p_viKLU6z{bewqJr8xeE3P=&Z-LC9w`f;NAk$h^N*$p*rQTgF!TKR1^b>>px3x9w zLBxe3O;%}Do@%SCp${F6aHMoEw7+R_e>gB<);2P}wPP$@SW*tGQoF7pT}EQgXCxZZ zYgC?)yvJyd;r61Q6k6i!i%a9WxvkXG#DNu4YKdXp~E{BU@v!f zF(shlrPu-QhUf0vwkl{0LQ=(^?d10F%;qsngNJiE9RphyD^&R%T=b+J$wMm5okS^n zD_P1A$}{TSBkRXV{AsE0snhq>_1F1XJ^dD*^(+T%9KbATUY2UOf^6>Z-9P`T^8?n< zR9z4Xhzb~kZIGMtiRo$#PBDJk`@Rx$jM^w1@?b5TH@d|Wc;h3}H8GunxuN-lsFecM z?C)``T7xB%HC`%gpqADIkxU77wD?ZgSk$XN<#+W7_%UpPjoh59jD|la`075s_!jgV z`mtlHMk3!lEUvJT=PB!Ao)|#GSlu&EM<=Qm5#CDV_C_nIu+!5$$7-sN<@b{)9Jsw` zpu)B5laHv=DZU(CguWM$g%(l7ThsRxH{{uZU@DOPsnTPQE*J6r8SBM^Y zJ~`Q^(7A}srN^D$)zT-@BxMtHS^5v0!O8S zp|HS>z!uEvQ7ZJf`B zC-9{~#)__xKIuOR^i9t2RUS9@I6;vH-E-9L4Xkk{5_i4+f`AaeOli*dp_arsW;1a z7m5~O;!<(JH-2jTfWpBWb;GXsUO4K$3H8DsnkS@1tB$$zftqZ^%yL@m&9h_poPV@O z4r+qORocxkB3M^D;Z;<92n(2b^i*FaeoFyPcB~#^56C%w*5{@0A6=nU$S=qZSiIHr zj6ZTat4nI3Y-L_@rQUd6#cM z?k$+MmAW59f|}u*(%}XV2Q2OEmC{uWU4&q%ZYmUxonHY*pjH({R5N6neq!n?retP zW1a{7fI_N92+joW4{A8s&&4frTB35NO*M>N@B}3@CK=DB)acmv@^QykEIlp-W6o@!au;+a`)83R68nw{C7{){Kn+E`s`y~a1L570iA|>82 z&`bW5pS(U%KY9HUXScm$>Y9bcC$2la-JyS6sV|5Kp?h}4g