From 4385e2788a40baafb890d87844f3bd8578f41915 Mon Sep 17 00:00:00 2001 From: Boemeltrein <130394941+Boemeltrein@users.noreply.github.com> Date: Sat, 1 Mar 2025 10:57:33 +0100 Subject: [PATCH] docs(minecraft-bedrock): helmify docs (#32737) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** ⚒️ Fixes # **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x ] 📜 Documentation Changes **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [x ] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [x ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- .../stable/minecraft-bedrock/docs/How-To.md | 26 ++++++++++++++---- .../minecraft-bedrock/docs/imgs/console.png | Bin 6025 -> 0 bytes .../minecraft-bedrock/docs/imgs/xuids.png | Bin 1592 -> 0 bytes 3 files changed, 20 insertions(+), 6 deletions(-) delete mode 100644 charts/stable/minecraft-bedrock/docs/imgs/console.png delete mode 100644 charts/stable/minecraft-bedrock/docs/imgs/xuids.png diff --git a/charts/stable/minecraft-bedrock/docs/How-To.md b/charts/stable/minecraft-bedrock/docs/How-To.md index f98c3203223..c201dd8278b 100644 --- a/charts/stable/minecraft-bedrock/docs/How-To.md +++ b/charts/stable/minecraft-bedrock/docs/How-To.md @@ -2,15 +2,29 @@ title: How To --- -In order to OP a player through `OPS` variable you will need to get the XUID of the player. You can temporarily join and grab your XUID from the logs. +## Use of XUID -![console](./imgs/console.png) +The Bedrock Dedicated Server requires permissions be defined with XUIDs. There are various tools to look these up online and they are also printed to the log when a player joins. -To add multiple XUIDS, you can do so by separating each `xuid` by a comma: +```bash +[2025-03-01 08:49:08:469 INFO] Player connected: Truecharts, xuid: 2345678909876543 +``` -![xuids](./imgs/xuids.png) +To add multiple XUIDs, you can do so by separating each `xuid` by a comma: -Or use this 3rd party service [here](https://www.cxkes.me/xbox/xuid) to grab the XUID of the username instead. +```yaml +workload: + main: + podSpec: + containers: + main: + env: + OPS: "XUID,XUID" # is used to define operators on the server. + MEMBERS: "XUID,XUID" # is used to define the members on the server. + VISITORS: "XUID,XUID" # is used to define visitors on the server. +``` + +Example of a 3rd party service [here](https://www.cxkes.me/xbox/xuid) to grab the XUID of the username instead. :::caution @@ -48,7 +62,7 @@ The `/data/permissions.json` should look something like this: This image comes bundled with a script called send-command that will send a Bedrock command and argument to the Bedrock server console. The output of the command only be visible in the container logs. -shell into the container and run whatever command you want for example: +Shell into the container and run whatever command you want for example: ```shell send-command gamerule dofiretick false diff --git a/charts/stable/minecraft-bedrock/docs/imgs/console.png b/charts/stable/minecraft-bedrock/docs/imgs/console.png deleted file mode 100644 index 08e2a4204218029b1f816f4d902fda98e1361698..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6025 zcmYjV2RK{p`%di_S`Qd_>p@u4;yq|03d_v`aX?tCUW=Pp)|$ed^pckGaCy1&qzkfbx(^%+i55I%4adp@#~77R0@vGYQHC$c{*f?Jd)-RkKBKs zLGFNLKzZIQ55yaNjd){{3(z8X;J`+Xn1OX5@seXD*e2ua;e<%wRY#e@&+A?_Vt&oa zg0VETOpW9l`p>wI$@l>hHz+xXm&i~bxLjefF%J&Hiz~SUl)HlBVIw~c&)+C{s?b*RpBBx27J79C(<1<^pKxG<_$53-GfK%1M@s3ZJVhluv0KZZHPeI6~;pxmcseYDKn zUqLoco(UTj%aK+`--h4sOV4wkZym33<0;n7z(JeI!*Hkie&2reqn)Lpss~1Q;1Yft zmO5GTqX>u8c6By$t#0j44xMp_D0>|Rxu?slhWV4iB2`{9YYD`D1F+W6QZnp+15e;ePjmifzSYNA;Qu$)zwAuu(_rJj8(Y1Z)k3 zZ_u|0M#n<%cS64IhEU47QE&%$=~me$30(1=0Hu1WEji{B>;9{lsu}Ri#YfR$XFA&d7Vk z??d$^87xA-!l4Zqwm;ZTBi95M4$n(69f=&9WubVbK}N8Y#NkmIhI2Hf?!B)TrX(wi@!*;Fu_NUbyS8s%Xf*-{~=W8e36B@h~-Jlt<9+W1-I{vwZ-0zze z4p#i>{>i^%>z;jmxsJJ4(;e2iL0;SRpCW|m-`fcSv&FFx-htA+$^rFA&n5JalE%_H zSMeT+fy>FSj}I2&)+ev&n^_Cl1O)uCnQo4s@8k*bKI_5txU}JzBtuT0#Bd`f&dvL+XuTA)@)d$6=&E#OJ&tLOO-WQ=kqquDP*GR0pE#aPQjqt z)MwV&kh8|5V7%F(3f^Fwx%F<7nfbj>55q)E-pKjvjhfojmYpJB31lm_Edt-9mM$hc zmH>aky_V%VF4YVdX)7$HBLb@(*v6e_n;QArB3Sth-kC{`yfI;X^u64t+-nfUP@?y=OXFxQw@qNetXT?uJ$FTv%$3_oLKr%B7e^-pr{ za{yU4S%%d2CuW_IdzHqE{=m@z3O&S?&&wja6r2b81>mtVA*d3%HC)Lt*+c1FeYB+P znwRatO*B7B^JGI|Zn->PW{e`;>Y;ToX_Tp{91rPIAq4~dIi`F*_)8j&K~E{)S=tSk zk!iYjyyj|d1RmKt)}oVF-v&Evz#Q=z;HSDNRaGNh9L7*|x4Du(+@aUvi#9Y}ycrTq zj*$Apw2NoHq0_JN=fduC1TQ}gIt2pD`amgoHaS9g+M-UZ)n!A77#XVzM&~)y^BhBt zS8@C5b`6>_@8XrENUK%=8Mg;)Y#;jM$=qg*6A%$yRCoTf-DL2yU%PHv#HLi=Jp6&X z&77m;@&-uFw+4c&IRLQtc%>|4HqX2H_qhn0Qlh<`Usm*o&K2ZQB|rhw%sJg@zOVhlNKcZ7h5ZS~8Ma3}QCv-o{PDcreY*q2 z6SlLpty-c<<)!OPjxU6y$8YerBSBEG08^YQxCq$cM) z;$1O~;s(DgugMx-qYlqvMNX;I;MiU@+5#)m;~m!l%TL2(*&d(XoC9%aqy z4T(=XDU^EX_J+rKP4!>mtN)SG2T6amG}aoaiIVhQSvg*mE2YKV?VxU?Ifu-XcB6`W z*1pD6`pPHX8g@7DRY6k3EtVlMf$dUIbpDGZ*K^>#3ABbi8hhuEjLr~~&F?a-_kG++ zH?AJ9LY3cj$t~N?lV((#tre3;iliA%zxC)ww|4xu)06xd`WdBWV4`%t93}PA1-yNj z|HqqFbt96A&KT@rccPAsJU=vJ+W0d?Zi||~etzP*{i9~c<24PDotR$J9jW@fN;FkB zXqWeHG5W^ayR`u%`0WO!`G-Y z#L5z-ORe)+?kf4`E&Pb?Gada1GD*usAvF_&S8o>}bUQ9K{~l&3so9toj z!#HGJsaB(Su_{3@UWz?-SEBtyg!_O)F^S!)eQS#Uu}xi71`8lZJful`)jFnrU|H)# zhg$x$CG*i37ghr!>W71uUq4yRS?B`=dNzTxHZ>9bF9UTGs|!>}D$u!~6<;c$5h`Mj z_g0)bo`YzZ+CbryInj2?8o&#ueKM_N;aSpd?@T=p0=pnYfe6%w-+#U491)(yS1m== z-P-iKg@2AqGW%@gTAI=%R!z~xf5)x3FS#yQZ&iH;uBk$qjkg?|;IavN4~E&_8Jy#V z&A3dYNO=}iKsVVQakvD9QhjsT|~u7-WFQXciU~bss;9UO34$Bs8ym{}7LN zB*@QO=?JNOXPvA?(j~RyblC$SS7n@^>SoBo^B$n-k_5!`1FX3Ne)3v+520M6cwfsi z_DE|Ty}A2-6)ZHnO$erPKFsv$hwEYOv*dla9QqhZ4rw_~;NkjqhpXVPg4#ENB5^km zA$u?OS4SC{6}JFV(pHWgq3=&xCsGbaeenK*x-otO=&eG;_PUn8xv4ZS^V?=v)OuK~ zjvU7~%|V~9zBgH0F%@=6VGRB6YofQWM@`p#5)=n!h@lr7&QuDXT0e=*m`l{jqF&-C zdh%(2k^v-X=U>5pgH&Q4gB~ih?>oBs4Q02dlz2zkcUgut&Mt1BfyiTW$-W@QEttA_ zBfw}3VgPqM#?A{(?WV2NqD&ra8foJKtFW5`s0U42$s>YH&pNrO<$W&nze`*{$t_79 zbWg3=e1Ss04*JNvwMv&;wpRhlp>#d2e83!E`3NxkM0{O{W+f>9Yj~KaAxDV)%c@Pi z+7if8vQwMyn_#;|Vn5N;PMY6ni;-*6-(;VvF8E!ZDg-Z%=n$q=F*7hkIqq(p~nmvs5Htjw`6 z&z$wFM*X#canJCEmhIMUKEB4>V`gvx;Vz9u&KBLnNr;1(b3^~F z&%D@xl9KumVIiqoa{W7U^c+^)dsz1k`nKw((|g=BH;vQF#H84I2fkhMzP7E<=`R;_ z{QJal!NWKd6M5b=i0P)wc&ILdAA+DN_!mo>d|^1MSMJI#`y5DvY;=!?J{uE%fPMZK z1J(YsH`a}H3#fcnRJGge2H5=8!!82S_GFN9nH80S{d1|&CE0Oju^TMsew|&+Z0?1~ z>XHY9C;MUY0!kyJSOrr_RC0{YR5yhiL49K7~HoRfnCb0dC z;Cx;;n_MKa*vsGBvfLU1cTyn!f4YY^7*@W%LT+=o#x1nmg;sk3+cN}usM^NKA4i>7 zRQ%P2Z5+_nvX9x?gf$NJZg>vwqWIQU;{=~XlDcqA>b#gz7Ga}~7u3r%ZVe2^Wg^Ux zTs*p^zv8ioNrJnTX;ME+AJ5&4W(2l(50e|dJAKdxBG=4ZSnfdx#rWyp%N_a|R)_Cj z;#h)I=oHxZdJg5f@JGR8Ekr))D2VOD9nx!E6iS~q- zEPhJp_`L8Nt1L}ho;Q`j`*5b=>V|)>H{J;*@q2UmIVBT)&syIRlf0AYb6s}MYDK84 zi_+7Naor_3U^f>ryPz57IFFR|*QCD8Zf0ePmC3?u{!hM%cU*4wE$B>dX5uT=#~%KT zGBPulc}ssqCSo{;2&2Xb%P0c@^^o4T{4U-@j6?Y-Mt@q6yq0jW>9eRGJ4=MDT6s8q zT^v;w=dFiqfA-f72ptQMaST1-n|{i}(KqmUSK#yL)unB^L;A5rX>qzFjoaEeLrTmo>`eZ2){31v0wC2iDx9Zd-1iX z0jvETM$qj!OAvEy&2CZJ<)BnC-^&hke=T~!GPmv%9>%TFBB*Va9gN>vgOTJLr3ELx z6U|)kFGe}8;ARjfuWT)XCbkIYxQEe^OR79V5qHVhucAWDzYc!b8cD2ytc3Wp}C5ha#3ZGTlR}Vzq11}$Y(=5bJU#1{^*wzkN5ENvKD+cK4Os2>eP^`e4zNd0ZL{;F7(9bdR0q}pW`PX zDd_pGNTck0=Y@XFnD#N!^V}gx%@~8LN5GZc9n$HHg6@P3|A25JtP|L&2d-99Ay3Hm zfGcAUkaQw}`R5E{Nn?fXf{_i9IwQCEx5BvrB5#fL5RQq_R}8v~Kri05Z)+pk2Gcg? z{j$Q>EgO&t?YJDVTMtJ7rke$RFRWiOToIA8sBxXn+*KLJXv*lvPra*z;3cYF(&!qi z<$5ml#PO?5{#<*9|+e|dT#&ZAXAzP~o=hPL%j?P@Ps!vv=(399!) z?O&$t#jw!I(YLy0EH+Qbp_-eqT|Wu~53NXc3Lq#NQ!y{3{g$9}hoh~qG=8>e zn~jf_kBuYgTNpxZx@sZeC1lTm1#AOnEvgt?VjKt8DEINoRa2;In@*xIO|jS)cklb8 z&bqG%Fh=@sXrVtM3KDUyX+m8zlg~RY#*#7(JW`z+zopV2DC%`MSHC(}k4zTX=Epi` zdp!nkl2?wqRi7^$T+=;tOk z%aj;6?*iqt@qrRm@w{PsmaG9yVAU?~RuNMk0o7@G19#KJBKHJl>H`lp;!0vi zSlZ(7F18Uk>KRz+iOXNYT%M?ygp=G8M{$(+LGBLO2<*4J7eC)nq$&q$#MA!|;j{7+ zI6p+@UDu)`1slMRk;z=HGgDF5UGT_+Brn#_t$8)KpJ_<>ET=jp??{eBM7^;=bchOd zf=oHVIMp;9PJuZ&5QWv{=QucS-cUjE0x`u|88O7K=X*XF;JEz~1 z@3?_yR`qjY4{r+2}c81t!4Faf4o_ zXM1$3yRxoLDBzDa_fww>^R)D;YNtnbL~E0P67VUgo}t)=BY!XQdTU48;|3vB17aho z^=Mz$%4TMHyzVz&x2!xj+hc)!MS%sUdAFgT@&{91StcVfkenpX>mibC<`&0G*Efl!=Xs z9KktDU^SHG3SUzX}LP%D-;PEh9prRUN{Ti@)jVc;8TLOR3|hQ19t$nk{` zMlW)-{%n~Aa?1WHJ-c%MZxvwry?gmJ8?b%FJIf!<3=+uVPU!v?Yp4sQKBK)%GL^_W z|Kfj3fc$e*+I~d1gwpG`nCtO&YJUL~5G}FEwlgRz3sjP@VY}8G5M!!$l{(X=okgTv z)^GFV3*?CD+tE_p1L?Ue5BtOJ&4Z{PM^n7}u3y8vUVz6WT z$3;b{QyaxrNiGHM&*{9H_}EhCfjgKm(gni*{vCCcrnLSS_55xc7lZ$YmS6(|HnIK6NvwRcNe0?fG*JfHxl;WROh!Ps{Uin{_Qwx@;>wy r{;%I$$a1UhUn|-$;(rrS9`aC$Ihr!IQN262&jFe!J!HA6ZRr02a<`C9 diff --git a/charts/stable/minecraft-bedrock/docs/imgs/xuids.png b/charts/stable/minecraft-bedrock/docs/imgs/xuids.png deleted file mode 100644 index 70827122f168cd8b084d74a0b253dd6da33f1b56..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1592 zcma)6dpOi-6#ltRqm@Du3EM?hid@?4kOoKq!+ZbUC0IvvpH{3-)48@u|;Q(M?>&_Nv z4=nZs0FfRG6Ju1k%iJ)-3WYh+zCc)sSIU$OPHK6O2^A{GpAtm3eI;+jbjN+vcXno% zIMnvr2lz)0tOO~ST`EnHsmf9d@j33Ngbi>fnwpq!mke-|j#}fzxH>~e?paxbsjTsZ za0kVlDgIrUWa68hfMehv4sQs9&Wbc$8Zgp z&U4c!v-h-*zdyoCi+(#%f#Dl9oNbMvFm;RwoKdGmGd!7vS>aZZ`r+~xK88HkRN^Y3 zL}YyWGtq7@TXb;4z-5Ctdl5VEcSA)e16k{R$%ZBml8l@Wok=T0*ONKbfxKQKYz4>r zppLE$Hf<*;N|gD!^64SLzu0xsHlwJ!wX^cg^{vr|1YL=u@1(?f>{#66j>5Y7 z`T-{MK$0ay;wW{^!_(8G=n84yWsX!Qa%(u*$*bYs<@gv~;!*n+2}En^iZ%+TCrYi6 zWA^o&bhlmA-Z)Rj&(+nH)Jrld z7lQ1&iNk5hs{ce(gx^6uIfEASn$#|oW1UZipA+y$vHcth7P4hHIYhrd5%ko$2wukL zu9FFPfw=$&Hsn(Oq94C9wa1{hH21gsNcwGscCI*BcU>Yp!XZII@dH88h+0vRFQI5S z6eMMdtIg&%MF%nn3NUiGK>&esfIC^#?(r18BAsZSmC(8#%IqTCS&NfSocR^YeMc*F z>L;A4s4I?@A7i9DG^BLIF}dpbxgPUi^W+}1bClB@Ya3*7U{ znZ=vj(+ed1pq8W6#~R#9(jIS4jvZU~e-pb_mxZ^?BrV|Wmx&Q=uWkteKwnGBF|&}b zeR-d{uV_Y@>nxMYU1*P|ZqLlmSBH{MOsufA%mtn*@J_p7;# z_>Fz*Q8sO8O5@Vs9*6N|7t+>f7SAWUk#nL2xs8=%FV+{Ui4A=xt<)LFyV4-l)nJu_ zxoufaFSnSUxb$6_-JW#^)7ZnF7bz5Fo#n#k6A_g!0$V6qaGl0TKKa%>mpvXvRj{6_ zT%9|&?AIe&fb1gkC$cPAoy9}mmHqppsIUS`tc-uQHL0)Uvi|?XPzRZED>l5v~2CJOW~GPhio$?iL+J z2?|ipC?$kSy3N+ZMhaM@ZFLsu+u}sm&$kyn5%H1Z{MGre#O*fxA-XvR4u^jn8rswA zd%s34y1XzgNhXZ?Wz#BI<)C^Y^f>^yxoT7uFmm9mr76ao*h^?SdFy>Q*)VcF#4L}R z9;xX8POq5lgh<0(XEWx1PP2cfrn>wr*qMO4@35Qe`l0N8)|6z4>1pr=urReTDZA(v F_YcZ7^JoA7