From 9755acddb76fd90d5893828f61be221873816fc1 Mon Sep 17 00:00:00 2001 From: Zach Walton Date: Mon, 1 Aug 2022 19:00:27 -0700 Subject: [PATCH] first-time setup --- Docs/Userdocs/first_time_setup.md | 18 ++++++++++++++++++ Docs/Userdocs/images/gs-api-key.png | Bin 0 -> 4657 bytes Docs/Userdocs/sm5_migration.md | 2 +- 3 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 Docs/Userdocs/first_time_setup.md create mode 100644 Docs/Userdocs/images/gs-api-key.png diff --git a/Docs/Userdocs/first_time_setup.md b/Docs/Userdocs/first_time_setup.md new file mode 100644 index 0000000000..f0d0d6de2c --- /dev/null +++ b/Docs/Userdocs/first_time_setup.md @@ -0,0 +1,18 @@ +# First-Time Setup + +If you have a previous SM5 installation using GrooveStats Launcher, follow the [StepMania 5.1 to ITGmania Migration Guide](./sm5_migration.md). + +Otherwise, all you need to do is configure `GrooveStats.ini` in your profile folder as originally documented for the [GrooveStats Launcher](https://github.com/GrooveStats/gslauncher/blob/main/README.md). This can be done in one of two ways: + +1. Enter the Music Select screen when logged into a profile. This will automatically generate the file for you. +2. Identify your LocalProfile, and manually create a GrooveStats.ini with the following contents: + ``` + [GrooveStats] + ApiKey=YOUR_API_KEY + IsPadPlayer=1 + ``` + `IsPadPlayer=1` indicates that you are playing on a pad (and not a keyboard). If you're using a keyboard, then set this to 0. In that case your scores will not be submitted to GrooveStats, but other functionality will be active. + +To obtain your API key to make requests to the GrooveStats service, log into your GrooveStats account and visit the [Update Profile](https://groovestats.com/index.php?page=register&action=update) page to generate and copy your API key. Paste the API key after the `ApiKey=` in the `GrooveStats.ini` file. + +![GS API Key](./images/gs-api-key.png) diff --git a/Docs/Userdocs/images/gs-api-key.png b/Docs/Userdocs/images/gs-api-key.png new file mode 100644 index 0000000000000000000000000000000000000000..f63caba05b5cc9f2d4ffc3771f5ae4ff9a0a8a88 GIT binary patch literal 4657 zcmaJ_XEa=0*c}o~)KNl2nGh{nqPK}MderEmMhKz?QKHw077|36SD6Gu^llL4)qBkZ zL4tR5QKAdJlW%>$zq8iNz3bj}?|sg5_OthXPOQGJIu-eCatH)MrKzD}0D%y@fO9@5 zG58k_<~IX}8=e~G-Vg|N*WVvengBHm1VX#4siI`$Z@oS5Y-Fg;0{MA^BR1+GvCg#0 zV{-{J651*=+OCf;BTb0i1x<{|g^iU2%RWZTzK$!a_1qw}b5Si>ds_Evn%_)SF;RnC zF`pbt$MrrrNMXgl&HrXmNtpre-~Qba;Rb$e`loCBp8>S$+&q$Yy2 zpMP#@%3?*X^{4QjC|-0+`~Uc||BVC!X&;>GBLY!FT8M5%MliJt3PT_;*_;oNB7ERt z9(i9LIE3-viTpdm&taoVfxTykn^aU(H8nM2Vq!13xVXATMyTOZQc@JxBR;7oNlHj8 zo@{(AaS&x5N65>!78X8V9m$4rxVdfb?t02*=OicVTUcmKfsgK*D3NZH@bK`&#KaJX zhYb?wm>CB9`jQ6;u9AUU(^ZtDckkWP#2q+Ll0NHy&z+T()$F?+aWIoxR8k@ULz0u= z6q%!uN*bqla>!W9oya3%GBQ+8PtVrYR%PV_Nwk%rp)y0ZoF8=?2Q{no*uX&Cqk_w} z8Lc9t7oMJ#7|f!c!UY#ytmof5z01tZ%*MvXYzTi?lD=LJA~QW51$)vOB!lXlseBrl zl#~=7KWJ(btSU%F8jLC~&a8=#mrcaud3e+BVGO?78?4)$o*Emc{Z}ooH@-Klq=(Vx z`)`b8?QZst>{nqp?Ek|1`0?ZZ{(fO$;p0zg?_w|+Dx4UD;*E{%OR~p&sU#GPlq`~h zGBUW97FM!XuUEY^r$sM)k!pHF4|t5<+JuD)Vj zjv0EKZy1}u-O#2&mA1rH#QcU{gTAr4cb-Z8x+UJ#-^pE zX>h$h+R8MTWXeFJm+R1A`M9~crJWod)v=SKxe7KQ!ra`Q<>gPs#R1#15`KPuIy%Ej zk)*{XB{pp#Y#gZ|vFZgC60Z-OK(IPbpK{3LtAr=ZCLYZm#KJy~J1GmH=7a=N2JDUM z{8ow;Ij=>>#56TFR?ciO4F+oH=;-L`>OOizj>}UH&i`$Noh4kO>&tsM+|fbAA?~q& z;QWYq$8z&#G))#7O#_$Lo(jk`6I}Qbcs!IThSknAFfoZiVf+P_+uIeRk(k0lHH`kj z;UNVD#X|(5w5*Jb>h{#!T+s0^t9_he?nnLFx_%q9yvXfDJWqN<|7_8LA5Wwm27{?_ z9OY3DgrSFX6hh^ZeB9is7=51?toY6Bou+b2`8$fF+s@R~)C2;-{|~mXu-<8$lMp)> ze16n#UyaA(=#Hy;jVYJlu*;#98TF94<$;lMf4XT`+9R7sPGmX_|-MT@tD8H@N zLo3JU&!5}cdM@`Q0{DQjw6qi#M=qSMWyB}^cQ8V)vtjj+&z>z;v|WC#s2E-SO^a-B zpMU?T03LFJdHeP)7Q2eg4T)1=7vSTotgm13l$LUzYp3GX$*Q&MCg({h4wBr>@$~hj zzH!66-qqa6sR)H43$ab?T~1_`d2e}GHa;=IiONaQ;M&BO)l^p6KDY&9T3lSTtIDt} zMi)s^eOFqgMWU$Lyu7^ZL^GS3n&^47rC)6@;CjAuq&;doT|r~@a^F+T{#|2Y`!V)t ztmn=gPFdwTF%fzg#B)_Kr77jHFf=;a(9q!L?d{^^G~MiXKfarsib_I4Vt8<{^X`bt zw{qtfFY0S+q1TD$2HM*pp@L`s;@Sh-0aFYN@CylT_rgQx8a&|f-M1A&5IBR1EIB{- zpdbW#*t*ItIwi#riTqbi+@UG(*j+yNK3yyliHrbsIXD=Au-4V3##uAfN+qUdXI~tC zv+?7Pj1Z2Xoc$y!D$2>pnVMc<@8F=SqJr?>y(1$d!^ycsKs~czwrTbiTF@nu3p(*s zQR%{YufmW81qFM1dp04bgnGB{Z-VZ<)36scfBcwsuK|T_IW=I^($czr|Gt%#RTM0~ zJ4^P}XBGp+}yk@ca88YDmf)(vMZK;?}Rjqe)wgyb(dY03g=^QZ!u(1K>-2W zF)g?3P@SEf4U!L?sdf;1KGY6RV7_(h z+xY-D>+7*QD)Dh~d<+8vX#&~V*S`%RJHMjuHfH>~7O<0WK z@r?BJopx2_Hf@&|$3H@k=lw`XNC0xgL`9L%*zTp|WEl9&wQG@O77a^0f{cSdekceE zYHMl54-%HzW{zH*ot_2+1n6YT-sDJ4O|^ge6jNNhzOrIsZJm>qB^!L^69o&=-%E3Z z%u~nQxyUUm+irZhTx7Iy`g^tC!9&f)2Hs{WD=ppC-5rfW)y!-a8)DT|RrmZ6K-;49 zkx1h7LGHH_;^JWOJ->tUM|yt@(AK8hFh2e@kCyW*SK+)TAW%|V?Ck8!5ho}p7;<&t zhqG)2h41a{jnVI0-UHJP0y7G~Ms{|7&dbYdYGQJmg+)qSJR>vn@0?kwvDMWRQ&Y8# zjb`hrMt@|5b9V27Rju_CUqhIrZ2W#US8yf{$=^+Q>>dU=J*vWOEjpO6vH*VZeQc@BT z5dkIpq5{-%VQy|NC_GI~pw3#m!^5@CllW5el+;uP7%Umcb$a^h+S{WI0#_jPJ2zpzj= zQ=2`BiIH)IK#;I)hgkXmFM-FKWNII+jo)>1a|87NjDkc3ou%YPmQN}@U!J*CUb z%b}P~6pfs$?7n}?*qHv^yPuR%)Qc~GIJ)3VZ%|UQ%KA6~T#!i|9vslo(_?keU@0q6 zH1J3iVZ0_k@L?SDBrldI(;xe0*l*uB}-=Al<$KyxoV26B@P=9}MQBl~6iZ=o7>QP)) zHas$-2CXs^1bFuF*f}@=sBv)-D8G|F2$G$lU8usz@kEo04$S@P@?!jxy4WqsXe0*% z`TYDmuoxf>$lC3X0KA-0sXIsZ|4Z0N3@lcqzP?`i4V(>}`9EUjrQuKejK!LonxbG! zzfWy~_Ea4l9NgW@u~=T~wZrE1qDDk5w8!5>gyR5qNgS% zkcbC*LH8;^Qq2T^<*oeeh}=^$G&Hoe{TWTc^aKnG3lt@D#IhL~DCKy&7cU;YefUkR z%{xzzBe>Jo-CcOAXl#3z+{)`fhCfaA`*F>TSYZmq?8_|`wT;UQpEH&+xGL2A$rJq4 z)Xz~RS|lsAr2n8I|S4R&ZVxdj>Teu80%&{ zP%<@T(qrTnWC@I5;@q(auOlqtAC2m4Pr%Pfr&W z6&{Y8uhY;HaSoO&BD8tO^xKnhy+ zDNi!;4b!jKUlXKU>GhJ^1>M`a?M1(pTa^HZU@v-&n7H0`rrLRu$HvA67);@G7FJem zcgO;biHV6}q4xOHlnPYj7A3G537Hz8-f|EDc5ZHoFd&B$-@f(k@BoVqnuMNS04NaN zymVJpT^$t^Djj%K8XvFa<8v^F^KNjR`FGJ1Fesz2rI~>N9ULACx`D2)F50_lum(TC z8|rUa%|R~!NVuh?1%^~pQ%m91TflkqCaP^_-m{DXzpyJ}bG-COm$$&iD24ArJ^jNk)#^ zr=2mtRRZUxB*@s@)bwk%F8*XAdQ|@0wf8L>Fz7(^*Cz_3`&NI0#_h|OFME+=51;KV zbpt;j=esriB~U6+jYY=G-oU`X*7gq43CPs&@bF;zeGeCx--n0UVvf|fJ@1M#T+r!0 z$XQfO%-PvlVSYYv52|Wv?$eb|M{^zm{|bmKV4GR7A#h;4M~b4khQKM#BHc;B_;4mRG$Ej2-! z&g&J=R>dmptNvFS2G6(Zlneu1NE&3iUC^IW9ohO)ouH~ zZ<2SmEsLhc-?a7HY!jL;o;$~l5#>qi5<4d@o7c%7GoCML3#$;`$R;dPFMMW zClRi(I=S-Mx>%4(dcVz!75OHc_k#o@i8{YuET#*Vpeq8e-Q8VV!j}Rx+^6Xn9vVvh zw%B3-x+Xx33#MOcyffy%o?1_(4U%2&%iE#I)c%l}dAc7s?DFc5!v}~DV>Gg(4Mhg} zWzU}wT%$)IR*t5L&3^2%7>8rNZ+ZuMJ)*FXhw$dZ2fPathtF<11%$sdlKtkd)uwFn z&WhH_({jVb{qX7#IrW2_lG4(y=3IJ4p(jACctF3{CK*Y*d!&B`@ycDeb*i$%vu_-( z3+%E&T52jKT>c+3ArvewA)!le(GJ)PgJK5uyI|iT4QvzS0&Txe91b=ea6e`I{Ejbc z3#lNG*X;IVA)A2zfLH)L{zn|8_Lf!i)A$>Y=<8tjf_ORw+LHHW8%qTF`S5xmUAV44 zp@IVJXQX%h-RA(?8~@*)hb?16Qe09JZ!oqiQ_S%#T%nvbK>7FT=&Bd4#H0)`8tCC< iLAO$RodgnAehxo$=-Yevi!B+v7^11Ft5S}%jrbqB0|Na3 literal 0 HcmV?d00001 diff --git a/Docs/Userdocs/sm5_migration.md b/Docs/Userdocs/sm5_migration.md index a421913d5e..2eb0850f5a 100644 --- a/Docs/Userdocs/sm5_migration.md +++ b/Docs/Userdocs/sm5_migration.md @@ -1,7 +1,7 @@ StepMania 5.1 to ITGmania Migration Guide ========================================= -This guide explains how to migrate from StepMania 5.1 to ITGmania without losing access to your settings and songs. +This guide explains how to migrate from StepMania 5.1 to ITGmania without losing access to your settings and songs. If you don't have an existing SM5 setup and are starting from scratch, follow [First-Time Setup](./first_time_setup.md) instead. The steps are as follows: