From 9c253c407f4bbfb327abf3be6105760ee420e922 Mon Sep 17 00:00:00 2001 From: Him188 Date: Sun, 11 Apr 2021 22:34:04 +0800 Subject: [PATCH] Rewrite docs for beginners --- docs/.ConfiguringProjects_images/6d010b1a.png | Bin 0 -> 3158 bytes docs/.ConfiguringProjects_images/a6a3b24b.png | Bin 0 -> 17928 bytes docs/ConfiguringProjects.md | 41 ++++++++++++------ docs/Plugins.md | 2 +- docs/README.md | 7 +-- docs/Run.md | 18 +++----- 6 files changed, 39 insertions(+), 29 deletions(-) create mode 100644 docs/.ConfiguringProjects_images/6d010b1a.png create mode 100644 docs/.ConfiguringProjects_images/a6a3b24b.png diff --git a/docs/.ConfiguringProjects_images/6d010b1a.png b/docs/.ConfiguringProjects_images/6d010b1a.png new file mode 100644 index 0000000000000000000000000000000000000000..e2d496d518aef8a82b43feb981c2b5d18b1f8bdf GIT binary patch literal 3158 zcma)9X*d*&79No>vW+oCmWJ#`_ALe(OJ%7<_NB39&4@IXvNRf^A!NyCiBcGbMvSEz zF$`nP*b8H+=(CJ{yT1GD{<-(Lf8OVu^PKbJJmtV}IJd%u<4{+9iSQvUy22E$0<_K7Vrb z?`DOc@O{3B2%m-7Zk;22z4T~%Z?_|)?{MtF!fHPm0C@DYw%B?jHH*sM_iv3A!47y- z4){Ni?V`pCX*-@ZAK z%=~f#2B*E#%gna4?C?Kx4^$n^E~A2^1&p*ikvfC^_crDa$m*|p7cl60<~J0;O?17% z7#C|tsZ^#dzORM9^l%gYlIotmi(@8*EJv=4=ci)dD)UzTGi< zCXvVC^%JT^%{7m%stOVx(N5boyx?-pmQ(49vT9uzLdeL+v=&`E?CzWMP~{898NGGC z;j_e~7k3ed!I5g^@A>nmubC)`OIe7zRU)~t-5`GSZR!tA z^}F8`k=hXXgz=oX##Gs4A$h?af2Z(>h-c8ezruXG2H#l2qjwp+mXD$I$A7>*T(P3! z{uzuPvXt+VLT50r@Kkp(tj1hn`t&vAshogK=G%f?D7`mI4>oKFvwc#H3LojydI#R= zAWpPIkINEvEHGtK7M_CtBvAr2+r-iTL~lW3M^h9&h_UluM_zGvneB`g3z!<7Ie4FH z&-o(4`}*=YfATM_e!}@0dy$5f$^B2GZJTp{gF`Q4f~0n~@4wws3x#$QG3fD3rR>p$ zK8X$fVOToG`b$@!J&FW38(` z*I!~L4v%4C%2Em`{(CZhyYtifdpZ+A!;2n#URcFV5JjX8>Z3u@fACc-@qsc>*ON2O z$sH|sDLCU#wc}t-WZrYo;Ic7~=4Se~IpJ!+-6&|2Lt|T@(+ENTML0|?32$RD$BqkO zUHx-5BK;3pa$BM@O9i-)ZgN=w@9dSu^gmC(>hRK@CeKutETT9-oC~RFepXnXL?w_u z;j%yuja%IS1IGltbhSDRz&jXXKw#imgeJUa;S{e}1s>lTbFe!}iU`ZRqK6<_%h@;S zLgZB~Rx%C}567ZLIqOV$E^r2eMqzL5UV*}NAmT`~jI6^3rc#p0sFu?)*6?d<=SLIDu^vLcB}(zKPvu zb((684Hg{TZ;IMk8?O)USx|OsnP@;^s&4qbp=_X#EpDHIbl+4l_UkVte-HU-BMMF$ ziJ4GRPNj*a=Li1janR5sR>^WvZ7r*lx@;`yz%x zL%(O_!ioqRrR`1$X)?A?zt+}TBM#rab#4fq8z{ZHwj_&nE^8Im=PtIXW!^abj?$v1 z#K(VrmQfqBlUSJ_`KH0;HQ+vLz#dvfRL&IJ0&g3he&3#vFn3RH>C@uqBXgriF6 ze!n?Rk0;ohv(p4La%$tZ|aw3PWq?=!43wY#mxyi=v6k!f13HRU}U?# zS)>aZ;acv(ZqImSZ#}^LI-A}2%9wdE$rE8G4T>4WLwnyEbp?{^D-)lWpTFm<9jJ4j z=62AnRLbej=86=%drMJ+yfwmVr5$?X`&fTvRAwE-s}(IZl{{O4c;;~Jb;n6*TkLZzH>Erg zx>hL=2ZM72q5toDk)#nA1dU9chiT9@>Vkl^)c zu=Ksrowbp9th0CLiBgW}G`OSoq>qU?f=B!k&NTs=ZD~WS&ir^c6ZV>3e~XR3=n5OE zt{_8?xLlV3{p+2;yL)z~HpoV=f^3SoV}%)bwEoAK2jRE%T10rGR8;P}55ry%R(S`I z=xRTg8?MDGx^D789dxj>V$ddN;^K(NYIpC20HbSCp5wQvT{Ql9b*QgQRL#n(Usr1v zO^~%cn2y=3S+H6$g&EneQTv+dI){$BQFZcz?r7({8gyHNQ>Oe@a|mMo8?-9j#cQ)4 zCg||}4|d6kCcHqd1}^jh!Snyjse&RD!{~UIf{dtKXFwydU5b{t9dZK1rB?Le8TL^J z*RY<)&qXl^x;TqYQgQL$zl=voI~z(TtmGm;1WCw=mSe$&}BCQ+PyX@DJ(2hS9WwZ1h!LfHI9J% zV7}RCmg6fR?4-&R#0Cj4wEwS$xr(;!F&Y)q@tH1Qd0JK#P^fUZL;Fa#ehDrZs8DXh zNGY-h0;-*#q^>UM>7dTKRK2TOZhDwrcDR>~UbrNyst+GrL6=VwGGiSy01`Ci*rR#K zmK8IyheL&SL3>YZ_q>u9$(_Gslz>#wVE{GOL=kkZM_ z`x_B*O6!qznE|cT&zVM1&H8w`wV+>#ZUT8S%3`gI_@zWtG3DoKC#aFOtg4UvwcOv|G872qIrGa&J$!fDzIzEr z`ihvOIzMw#@{ee}=!gS~Kbd*#5W-=33IfJc%GxsKaGn#(l0LbMtZKjk2{5$^yL7yj z@UwUFrJxULXo;@xJBn#JcF0|^?S8xDDLKmRFJ)f5!JJ#4_;0QC<%j!umB8+AQLI;9w^ zcH+m0V({pT)}!_BS~2U8>!`Xj^lV-E&>~_x?3Euvy4_hxwUmFx5Jwe%@;ksE>c6m~ zP;f6>hXnv(sia)(#!=(0%ZJ9hB**3AOt&w{hH}?9?o1`xGE^n!>q(c!>}W#070%P? zfDogX^9BS%S=C#cJHw5Z&v(w_mHl%^dbf1uN)JF=(xO<6??bS?iKKRH)cyN=pXT$9 zPdm-cRN2vM8Ouupb~8MKNYsX7xc7t$P`7&vMmRVX^h!1IJ_)pEm9(zJg8~v2KP7q- zV*Nk&W19-zhrrB?B$9VuH&uC$SoJ0CI;A#D(uPSTyC_Lr*)?3o9r>Ay`i-qM4+G_n z-DSRxUhFD(u;j5QwY|fM&leLh%BFIEO7zr?O`DJe9kIUK#4f4R#mme{TD46N)QZT8 zmabXQL5nKNVG7#4%?(vim_0WHaONvp58m938^Ft9!qEtW2@=95pUvqpO@5>~Sp|Id zxV33lQr6*(FQt84anWNUa=S2qVH&saZ1WE{95sdv=chFt^D&FZvq`y-0(ev<(Y|*A z%MDoMIyML^gaWJolW;NC!rTZ>bq1Pi5Dp}0E*0u=WG0g8uGpb(@;3oX##F2&s`?(Xh- zLi;@L`QG)dv)1{+4<@yLS&y9wPnv-o5*ws6R$bbks2&HG7Y0#-+(CTDH`UcSy|6;+v)CX%1io0bnWMR z1ZSI1)$qHv{vPjW`Y> zDb*&&2ja@HO@_fH^=hh0n81$4#ly_3Jkgrocp^O+PbSaK7Nb2_ z3YO__&)Tk-i*+G+oLq~8-t>kE!7xFU=-!{u8|&ExR$RXgZe(tV!C6P=J2C5dyGSms zMz*V0PnU5fx0a8WOoa*%{&~! zE*2Q`O*B1Hh60$^w2W(HS4GTPX5xLYN5@vw&9a*)`Q6D&Hy!Q}?`%?%`ye$*d`gFE z&ZYN)m=9&oXT9os^+N&bvDB2-BI+j`8J)RTattUnk+X0T z%M!k!(TyM7T?qv*Y#QErjtSPED_(6NZ{E6#=|Bn)j(eTve5YZ+0Y0+k!C^vlbQ!vN zSusx73)eT?B9oI(Csd;b#wo?Yn0Db}P!aZ$?YBP{Hq!}>x@^7D5#C|tWC+vzdC&8@ zsX7x|Y(}DW$JY=-Fd$|U(bEJh`Ns&t;6g-F5YfYKUMq6w0?<|r^cI5IwJx(=aoR#I z3c8B4d^(`o*;Ra1d1Yxn8{u#$j*~kPP`Iv$d-{88Ov4I9q=V9&vzH95+8Xf*(GSfX zc3PZyL8}94a1HoJMxjV`AM4}?W>y{Aav?x^Ygmb zLs#BD1x}lzuH_@kmmnD2>?>yI5rNZwe8HY>qTShcIbImPy^!wy^up#}Ur_6rd+@{C zd59SXXHLfqZS!F!Qts5f>@VbJ1HuT4+^}c?FhcN&91$R$)!5K`U&ed&`K+q*W0XCM z)?IJgFP^WattRdbDsZc!1c^B=d*`lZnk08mxyt;{e@c;Xp|~Hd9RzBSk1@AyFEHix zF0n%i#6`cdFk*r8Bi90B>DeX$U;tUrqtN!9_7_S9{ttp40Xu@g0n*Z_HyPuLfsQQL z2b1Y~ZOJWtpR^ekg}`R4f(J~VfYNhZI^}igSNo+J4Yk4sS|SSqinhrO;fw5vQVe24 zSoIPZluFFNw)p87eBC5Qi>QcKOG_&|!YomuAO>T*rE7}y>Vl4emn-mgvIk%TSqOts zgGt#0>GD9cJmj;g&TK&I3e{)WLB;|0TG>Q_d48Tj9c__Y2Mu7x_QD7Zh;2zlFXp^2 z)i~E1G?XW0A;Zly+12j=rCg>XE=gs}Q!HWMSe^uWm8ZemIqhGV#u84rOd8YSRrjWA z_KOqcdbQm+<0C7$SUOIFCp{iMnI|CHqR@|ONB;29gRCh|&K4(b;me2t+ulsUq)jd9 z^MXhV;sqS4uCQe!f~Q4A*hC?x2}Z`pqOIhDh5c#|rCez(E;m(1#3DCrb2I*|^%5(z z->aQhp?7Z+gq$Tfp*vthmUKsr&pq3+6&52ur`wEj`?2~P-y{zi&+W#^)xdbwZBO0w z%B|955*Uqxb?!HG{xvR4K>4M8*Zb)c=b5aWQlZp|x{iSl2zZX&^M^ebj8^nFGM{Vc zheYbaOfW9fE}uO}6fqNwf=L;9Tay+qTAshl@+^|TAOf%ki*ocP&+k&!zw;$pWVAFY zsBnP3rCTJ9{hXFEm$srUR{tG`F`%K)Ivt8%oSEXS4u3NR^uG7Gs}gFcp|n&}xC*j$JTsB4AFn?j$P zn!3D4El-{lB*OgMOuwlZ`u}*hKYh5gMq>r3aT$E?Hgox6K$0yU?%?UvKP6TmW$bZm z3T_OGDpp&|A-$CobPs#_R5&Q93Y{-u`QVwMHv3!bV%L1;%VH#4tM)@#D-&*XUpgOi zV8}1$Y$2UINdVaArua8S7b<=p&&zB9&sGPgS%?@(KSQ*`&!C|DSy;CxR5nZmNkw7XF*-^fXx$%ASTCF(VTY^g zZOsg+Oj_56jX|om`=uk8Je}nyW~DTmkJPz(wUFW9E%*!@BP)d z{P=*^?Y7ywA4tT27n;PodWL~G%sqsZL(89f9jJaz0Z!Qt84uzJ+GvW0T`ReVvBg+F zePQmH`D{*eIOL*ha{bvml}{x1c)@X9Rvn^b|BGYxBMYp8u zJQS-D70V{^NaY(Vewf2)e) z$T{<$#nl9C`Mz=pDa_Ed+u|)|&@gSRO0*$f>}YKEW&t?B=ZArIvZTHgajQkbS!TS7 zSgxs{qK4bIeE)JJrA~vDGVz9z+hJMV1<@-4mtTow*s-sUB5?P_#hMmbdU}?Cj=mP3 z6Cz)A?>`$6xLOwzBhchZ37OrV9bNq9-+`7)biz9NT;y;Jj@gm7Ht}==YdU9~`KqXs z>Ji&pmH1Wv)*YGe4vW3*oIzbs^*`b;CmsD#mGNmdi}Iu*JFm=QlN>u@FF`#$ql8c( zSGdN0g!yQVr6oS-?L4srPN-hAyAx~P&*`VnK1fpmfU=r&vvoDeG|72edU;U27q|V| zGB0>A=m4q7U>S_>*RV&zGbh9VujO3&h59d#xuaz?$_z0BTWOcfJu^|nGSmFdl0Qo z&tPYHN|xEq44o}GzTBUO_a_?jQMwZjC#(dWa&DWRqQTRa$21`@Uv3FrB#HL=QOlWe z*TE_{Q;@AQ@gYHI6OBB4aXSahkex*q8;;|U80VtgwFqup?~+tFeViut!fT!RIUV9H z{f&Kpo;QBa7IT;{r(Je=x$5xyj&Dwj{$86q;$U!UULbKis3uxMfhH*NSxx&Z zV*5R4dc9;(J)~xQa#paQ&Q|we5hS-u2xho2OnnUj{mjG;U0ibn0>47nRvQTMLlJ%t zjw{3aUroO*i45Yc$Ax+=Df`2=M*V}Ez0kS&g4d*^utS?=fax5wkyQm`NdsMABizUQ zjZSk~h00gw<4_r4Aja|wsf8~$N&(H;X82fXOR8AF(B{+?Azvp!dFwp%wZon@YRX@c z%FwySmhdovC3naQ+@VU;p|aSBNZgU=onE1#ZoD!Y9Ue}IZN1+pcd46`88Dr*e6Es+ zc80F2MbmH3%Y8nN=s4Cc%=LAm@RJ$mIQM2mI+x_1| z%~97pQQV1A0miovCkDsVyI~;gw$z6K!XM%NrgH>M&|m%^ETJDPzbXS);LPeA_}n6!*AP03n0O zN4R_Lwa+s7uyU$FcL~!ayQ_vWCRi55XEctM)`}5D3He^0-=3Kwe&r z`zjK2U{^JU+}Ykr)1|?ThBhy!91q%=Ej?;%%PRF!`N)k9z`<~>VZ=#rJb6X?Y@4Y? zSVymN-l_9A%ul=PqR_>4XR@ulHm(1J@i>wcl_9}U!f3cX|UKMc`D{)R-BdGep z{y2MHQ#mcbvoqVOFU#GgPK^vk4Lpa=SJ(#kXA9B(bWU6M1i64a}HlPpV_oj<; zt0hCA->AP^&_lg%gt^(FX<$Det_baOli45Q;weHlUY7dFkKxgvq^?4mny}=Els2LZ z8zYa~Zv&*CDi!;y*b4>5({l)p%SlpNrM} zCvp*g$JZZt}mZ*q0IChosk|hG1n0Py{qFb!4RHmQ2H5lb1!!3^$ z7r>4b2OpkgnUk6rUo%*Ya_yh{WU0v%EPI{qq&saQef9mB>Y{gAKRP`3@C&S`by}A%{`9#=Gq9TX# z$sv*S+S!;d*oi9WW_!tpQIVyb8XF6Y=>!5AbCfSoZ_{TSUw|~k>w|B9Ov1KGUG+SV zu#y!Qjvl=WgR59#ryXfFw<(}wJbPx#lSOW1kw=|k>eMb@E{lgHo>JiucrrpDgB!ZD zB4YbU)9vc(+Z?Xfej0*>C1I57&dWufO!eltO+9Gd!c9+tRRVbqzJDhJTNDH#i{XUK zWooIJSF*b!*}xv?!maq|N>yVU^R%+kp>_n{3j4)f1$43j0W;LI+*61qcDt$Wi+QFW zkQ|Ah)xBhLe1ZP5i?QB;g+KG2nBvycNc?QC%jR98qL)tv>)%&~`que+ngO7$Ql)1+ z;)9_jHE-3ILi=XE`cOTnbC?bOMwa}ubJb2;*oJzCd5gDXyWg<@vFBjwpCOUk^?d`^ zp7FI0L~1uni@C)75<5jxRc-dfH|QdR1F=9e?Z2`o%#XSHskKixCyl&M-;<7%*3x74 z&hX>tH2Lm|j1>rYp|uC0rLWu8d_}@x=c=?il?u2J%3VuYj*eYg4vhi_5H`}tLz;7g z>sTY4Z6!orGTl8G{BKpk0)j~Y{|%t#0xxq0{3xRRPHB*%ko2XKbRH0GlH~^ewhgH|rXfIoW6i7H*d7qlyzVGNPXRnWAbC`!DZm?nZMjZHjwELrwJt>B4 zb=;r~ow}ct^_}}wovwww%)PB_q}W)7*E}MfwG_!o?9^!pYo2X= zd+5aOpfj!YnR-DD>gRpRn1^}Xt>rddXCbX9d-r0LgL59=uVH{SUF`HlbvU*y{Z0&W zWPlS~^3IJUm7$5y#soLAOq6i1R zUeK_%_ZV4#`4cxp%l_ToaZR#`Ib_YQ-Ppy$mrA?&{lC`ig6^D_0!CHB6Bxbe`EIa~ z=JqY@+i^j0ocw{jwb5rp(v=~ch~Eiw5fW|Px^D; zF5?)&dFxN>jafuPbm6uH}xL?Nm zFhxj^tqzNOcxDL+C@(FVPTTq$Jv|}tvp)>X|9`CfPk2R;qR)`=HG7wB7@h5axNtux6Mb^;A&OVFUNwSsk$jg(lJKNe}u6Vc1Mi#8o z&qvp+qIMrSRGsU1eU+0zK=jANgs`w4KC2bpv+znM?i`v<-E*E@IOs(cv}6DrG5&cM zanr4@kDt9FdzES^BMb8Z5Z$REG#t*e`iWukM?5O^5-oJLI(+24T%kl!H-}dfkS%9IQfsS z&j{~dq=!h`O;TEo&`VzKaW^hqf4)dJ|5WL`rc?8QAp}1$PHY}=b2RvjsjX#~gyA>u z0lZ%a+wpjT#E?#}Hte0?b=hy|KW`gU!*>P6#Obyh>a)Eun5E$djk#gOB1WH%bI#25 z2$xp4Zj1CfpPJ-od-J^+77gJ2?NL1v()o3>scTeqYhofKmt-`)k1ZBae%_8M=pXLicU@^=_JYJj6Vz{tT(%V7;rkQwIe$)?W#u!p9%|{J#g}bKw2j zG&~5!uy?}wYF+Gd8^>tSH`A9tWp*G63abLxg`CmpVnR=;4ZsFu-P4bX&l7_ zD)G$vsR=$t%DNhv*C@^SDr}k&E<Jm% zCgOe>s*rX_U7P)lz)&x7-hA*PDg8|{m&^XeK>Wf7pXD}q-XFOQz@!z*C~(eVoRhZ-S+@M`=Vlr)%<{ zR*FOb+vWjnV4V?5aR#*-?ehEu1huf3zYB|jHOEp+kG)qbqO+owQqaD?veI@|C5)uY zv|HA-lW1s5^A5PV@hyorZ_plznyK36{-)b1;C`)_MgbZ0^e{Yk1hM}~fNiA$MD_2q z^q-hecb!KF;P#>CuDg0*;JGY=jm7XM%-(Ky)raqXuZvuD?pwGF-bH1me|?n#fUI+T zfULcE79aOQc8~dS#d_R)(P0I;FlF2 zn{VgjcB@&b6luCQMt+R)CBbaR+9qy*ifkr72r+Jwh-^LhCoRwz=7-Q!SDP_B}~*MBIcDPhHI8e*M#UBIPNLl zzDxq8ZB2djb34;s6uUWdf-6Brgd>=faXZC7+=wF4tWk`u33nS|=+PBE;Lf$q@r*(H z>@A41 zXjF!sHbu*m^h#yD$BITrMlD9_3dHUGqa4#kqxx)JmkzKMTV}i&>zW0}L{nW{V@liN zb`G?-j4V-h<#@=Rpb`^@9;tzmlBlS#^M2f9esVr-i&MZ?l&Wku-_)|rsNfq`m$moB zK^uLbB!#M0(}b05;>PfU9gm}7 zsD#1fHU-C9dV#>j=Qo^#FGU(J5tSDXZDzqSHz`ZE-@GL6VvXRO0X7;o{8tmh%l^q5=_B3rK5r%9<0!{M}x+hKRc zXQy$PQbwp{_LPN%BKib$9@pN^H`$+ zx6xtKueSpyo=RhfLevm)mu}eGi}HVpnOUD>ZEv~DXQ}*kVY^9&5@+=lCre9=)sMfh z_$6BjO87RN6ebXQIEo8B@zwmo54PlCX_WLF`nh8W4zl#3KcE(9vhSavdek;~Ccum$ zrVEuvP}P_1kNqKYC4&`~&F1dJPG;=T4{cwRn$B^$yrt)I>6h%rShDifrwn_3VWSLo zsh`ys?c|G8fX{5dFdu%ts<*yXo*tXi+nuMZh6!cntG#7n!eX>gUXOio?&r_hg25$z%-&uJbYO_xj0di{-ceVLvpAcA01PJ{u%AvTBzoC)@0AjcsI2@J= zQ0&YeWb5h}`h!=gIuKZZar(YFA8Acy4zn`(ozHu)0n^DIEEGFp1hdWF+qsfT&h^zF z2reI@Odnv)CW?-GY5Bg_ii{HfrbYDipfCb({|^Wsz>OF`gv8=sZI_;Uyx_^?kD1j4 zrcHPu85C2QnNz0YZ2!b!IV!-`Wyt13*Q@IuwO`|g*dfxU21{*)>dxd*8;R?x@*Gdx(h&L5Pr^} z!v1s|6m?|@+;5UI#7f_LVp09${G`_|D0pF-1l<4X)sa+JS*&VsOQ8VWgG1fP zST5Z#ox*C=l@CtnybjLIu5$hhBq5=G-#yLx2C0Ri zn_bq4V3Lxk%*uBE&Ka5RLY}?f2ZWG9a#N>5f*#ZG_VUfU^fN{laNx#eTmK6(_09SA zz)dQm482*zSOSsRNsb#7Pu-i+mgz-q6j{*Y{wH>z@@#Q+-Ms}wB&NI1nM8>1!`sTu zg!inDB>SiIKE!0jIs+lK@#>j^CeBX8P~+?FM!cK#^U16gVW7je6$!^6O7+IM`SyEB~n43~w*2_xr_&1+f1I z(Yd@2NClw2{w)e_b0_2|#QY!CamuWG&41%R*NiXhu$<0h{UCd9iG=mPzTI@b&GeCF zEs6M}9tm(jB^k>}lAtEujRo}KfxZ*?V>kn-D)@5$<3#kz>)jX_Y$At)v29dR&j}2< zQh_zAibDs@*Wmn)4zV*m_RuimTUt0|GF+XBb2eXGb?Y>V7`)J>hJ_Vp5E3CERzxnX z6Y`8DPbUBKZhnxC<%^+pR~aAB+k8pY6QO|{2v>=ifC~m9SW1VfoRGxw+cfGOqU-$3 zu;y$OMHHz>uv&+9#%9ZP-3Sr_kX&TXmb7I~uK0v)PheNWWGaF@XeK^K1*F^VB z3t*wg;se{ps?v%`cRf55Y`%3i z=6SmCERBUno$jJzqnE=rgGX_yErW;cW16XG*fL7efVT7y7^~m&#}vB1V83n3V>Dmi z&-@)V9?8z~V=T4ujndby<`sQM>BqJA-8j)zjb^pU@I&Vq3@wX)6=@rfZxy5?YOd_u z2I25N!fIWJ*08wV?FM>{t?by>c3^`n!Bz_Kpig@rCtb_C9@M$WBC6d0UP?=-ZR$B( z=9;m(MUqr~5kw?|5yt-ZX|bdB05ZetlX7WFhT~j~!;mHSzIMg2)J+aci*6u7;o3wS z7uWzDT_F=cxRw?U5dFIxb0V%P#?IklZgm}8v)-ft^oYr(zdkT6pG+ADRARolgX#jl^fnl>S6kFt~QpKdz9vK>zHB zD?W64teRR&%a%KQH^XR?E&o1M%9+eFFDKef&9N#cQ2Jn@faiR6O#Mgos-C^Fplw)` zX?2ucbZxeYrS6Rya~XN)rY(J^Q-s7ndjANYE7=O}hE9p#_T?FEU(j;sR|Q2PPK^}Y z*e2y3)ADbjc_r|Bg}8*ZhHSb87TBTTj#rDJJPI=Pyb2CCsvoJkmY>YZnZ>iArsCg< z8!-y*wNm=5e5BkJduLhRo@_wL1@b!=#0h#dPF%GD1Ce866)`*aV99fl0L+yCxGW2( zJ++^o8B|Gw;y5|DKCk-W9}XJI37jUVBsR11w(pa7q1*=)B}IT`H*oJLUohs!Z^m06 z#-q0n)zPVk*Uzt_hjF*lz=+weYi=svEG$XPmpcAY@19hKJK;tArnkqMIpfXoU|Ypi zrr&)<17>dCxuez#Om+CFY_(7f3D+5&Rn8?Y8+n+ao%4)CTZr}{Mj}LFKX*nzj zM9nn>_VN7IrsPV~xyB5P44Q|3t~#RJzz!=Y5@{UOkJGOamsxCilD_+Oy@|R9^ik`l zFc9QOqYcTy)#x_x{ZN07xP4!LJz3vU`%|7m{X$=Ap*ujR%f?Eqh3?mRkU@)?mu(Wh zfCK=s`Q6Rh!{%ZydTz+R=M)5!Zkysq6|30(@W`GyA#MW2s!9k+dt%yZmL&9goO7KYVAykU;&5tgl#fFTy3}&2ZGJ6l<0NVS__gDg!97;IYb#pl@vjPhpH&?}*KrN5@G0+arcjZf-f z?S7a~?7nk3tLY36TMh=|Vdd+<-{6$;zE@8XvK)c}(+8gydR$`bQMo#uE_7}`9(49J z`+aoSro^fpceb&ECT@3%XAFxmVQ)@BLRqB16!KQj*c~oAImWC^_gnGmdX$Wv8^9SQ zMPcQeIyJux2|*J0MQR+Q$%G$;NPva!ws}z`piKDs^`Hmwn167tv|?Uv2D>uOD;=m%_vU+Vo4DJ6cTof zd=D94<>^U&L#hl&hCwMhLQuBSAwvZ4h>GPQKl&AO@gVhj=B7UOacIy#pCD07y@Mto82~`x`q%^Z57n>({=Pvu|zo4pY!H6ZPyUzf^ApE`Pb%;s2jS}P? ziv98W^T<0h;Qan-W=0(;egXzteiS#xj}6l8_WiO18zsz8KNP?Gkoa({!h?V^)i$fz z$Gg%#;+nLi$d03xjLbMnMG1e@;LfaXXtg1C5vFw0?aK(I3PZ$WEy!?L*iew1391?M z+G{k%a*`{TIzSXWv z)hARb!7~OH^6>|b$1v5UW^^=;jggR%YeNcRnjg^17aSax+b^EHaZHJe=G2oh)E9qk zi&oLN@o0-FEknNPs!`|yb}?Dr*VJ)|W3H)9?O3~XB=q*6ITUTYEZO6@;`Ur>s^06l zUTU{V?FtOu>;M9)YH74crB~X#M=EpJAGl=x{%J+s2sTO2Mi;{gzgp4vw7~y8E<6t> zw0vJ`YUhN89_X)3k@LIQx=|u{)@p9P(A5{)Gd<$B;v+%$cUPms5%VnSBZp6}MrFBS z%BShS*S~aFFA-yOS|*wkqZJjgArB~GRrBsFnF4i+swGsQlJnL!a3~=#lG?41!P`^Q z`q;{9*S~{l=F?X&(3pGu7etNJVzn)O&}B?`G^!)(Dmd7%UXZbgz(%I2ntwG z_yC?HD2X&RUgH~lsdVUq9lG|P4K~p67Q(g28`HC@=oS?gASU25Yo1Ax?ZkdX(Kn{e zXDwdy3Fz`tjcmh;kL)v>Ibi|S$+uIfOx~8$zrO-=_&eci1~vX+9JFtPN6tJo>?G)o z3&ah*JyEStiXYu{LB(1~ltDbb3;53HdHRxTLv^`d14&_L5aYK}XK}Lw*%{I;+mmW5Hi5gp)yKeZEBkwp9*} zeqh8aN3R1Piim1@`=Ss3W);#F@oCXip1n$}8<4Bee@9^>Mk|IYa@73rvwwm;3T8fP z{Wmb7PG7|S+a*xN;0f%`%TTS2TUd7p*A){atrnzBke;jS?%8idWSH*Kp8pcxLyjrDW$MC=`+zTNgbX^nog0$9SLIWitErqwuo^ zFOARom0|d=y(*2b)KRWUr*4|Ah#Rad%Xb!thUaV>KZ3c9azf=k6N?;wWVV$k1vLV{ zZ<x1xA-3bk0-d%DJyIB%Aw-0_J-X8#)2)lrLjXpl;5Ns>%0MR@;gS^1DB3 z;6^9oog%kVSGE)S%EB(S>jOgwc1(U$3)J-OfdbOE?T_Qqq!=dd;Ip}2UkaQsjb1LH zi)yhOp$_I&3pv!Mx|tYUx8S@P|3cv^Q+9(wA{~Z z-sVoEOvDJbsRy5Y)d z&W1VcA1rr=L0`FiVrhv#@X}}Xxwg1 z4hGj4?=Zzvx7y~C-R{?6oBKM}W~ztRdwmJ`&GGZL$Bti|UQ^r^I|!CpLfjNd`dRq> z_ePwpEyp1d?3!^0VP1D(oX~-Ile#HX+k!Ic{3isp@3GUbkx$)Wc29e8mz`HbS>jO< zQ=SHO7*!t3cUAr2LC2=VSH_U{$~bOSMYAXB^GvVwYQm%5xxv0SDt^ZG?WTY7wc_P@ z-}Ww!>xjMqU9d*6*hkE5RJl&MtdFUbywcS}Oy2+5ewrWTx;2>;(g}!OpaH1<1wB_h zthj6g%uw$;P7q2#m4YwOkmBsu4ihHNyK+JC*qY zAofo_Z8{2f-(MEozX-9A!CKmjFIcQyeTduTtyd1h@564%73Iv^b1d7)Q_}19fjjb} zoz@eQHGE5F;CB0<&(qJ}Pvw|bbm#!b+io4X$8ICh#C>{0V`y_$?p}8sO?oX_OW?44 zA>|G-uartNwO-~mKBwcFx&h2!UQUuJP&3?7I5E$U;O@vPzhAp6SI@ok*H_)YDLBlp zo-LCCX#`-)>;X}RbDBvvuLt^`A5n@|UXpssmB~?>uF{)a53Zs*3XJZUyCoDKklJ@C zcqT_$Pbg)giW%Z!EIn|fd6q;-R{!jL^sIHwaB=fkLi5NJSXgvLX(3oYx0yQA=is{G zlxILDWwIPE^ir$xP%5I=C%ERs%Zln2cllu&&|QtjA2!imuE_B3?nN~Z`u27G)8@;m zeWPY^Z+82muhovYZi%mYD{tS+q0qBhO`=Iq_qH^Ho*?uqhLx84hmjetHQn0>9*U=N z!2N-Q_L+@X_M^(H0nM|caHI;0HRG&6XawpwgTZYLxF7gKqP5FTBIxVBa!|}KWfeYW zqET*+MZarJzu+!~L-)#;&sxvxLMZ%^&2C(RdjYg0q%cbrfkonUeMWX9&QFvE}q zH1^JLPhr@l;D7}<;7y<)Sl{?{lc4ZjEO_A$NqQ%0KF;VfWt*mlH=70K*QY#!rBUOl z+QX@}1a^mvT8K4Gqv(ey9^=DQddQJr)k{%aCIC<+b; z8BoUBc*k+PyTr$`)44BC_*U)P0#z4^Qu?TevUHKmP!MM1%$I*nSOyZ&)7O+G5){k! zykuScfA|f#41^@r;DvP=C6(rrsc}kFWOr_Yi2o^{!r*H<6)+AbHl=S=`{~O@a)8}z znOQpFn-kAFI6$2Y;hCq3`7i^y)dm^g!W2@TtH= zlT_nYKI}Kebui&3-eORa{MEs9eUsqMJ?@{koWtY#sPhN4(LJ75M4g$ABqNz$IdoN1 z|H&1;V1`~ek;4X;wu+XSHxXH%~P-Lr2_=i6@qvWos0 z`Rb?}9H=v0?@FHyfalwq#v&a3X_v6F=pnJE7=}q`sYOFt$uwX`dDg1F-XQw}oQB7F zL>DrP-`AV06bdtvJ94)r4Zam6f8R#PRQ7#ii6;NI%xE_7L(?!|a%0HFttYyoG^l#u z-PP}Jc;1R!q^>_f?A3krZ!KvT)JCz_{=CI&Kb#MXR?^>0Ri8e!2vI&fezD1;F*?Fi zM@kdbD3ZLs)39+>KnT{I?BHmVR_53GmG{Wf2y?e7pi*IVzW)PIwZ1fe15A#z6!a{k zs~Yb*eS#ONqF+oXg6byu>FZ1|%9WQ63-WJ?)=uYge#Oef&D1A;6Fm}@`%i_3Vx8$N z9vM-eqZuf!|KjZvZ90cORo8aXD?aWjL{&vcrG*7bS;5s>2o?3Z|%eS;| zuDpG(b>hKQD=m%vY+=gOHzzCh4(YIJ>`l|jNt2{j0hJvx@WKl1C$q7bALXW86=8f% z_XRXjl|}LIy3IN*i2Gage%00+%$^T3m8536&N*A!(s2pfO~EnWop?4~c+NL?o{#-1 ze=5XJi(lwYym?o82cwv))?^L*-;;6fC-k?1XD5F92&?DEA~&W;?Ax}z-7nLZ!5Ote zAFWh#%|7d${JQ2;SSM1F2{m$gD1P1BrugRw zCUQ^HWpUzI!HVpJ*3K{w`lXb{|8-1H4K0B6KD=VH2-S^;wJX!gyxQFaTs zB?0cYQro}xIR34D%YNRz_nPXhJ~N43 z)2uwjAWx+)+HW)^Isi4brAKY<5As~bNbgFh8J?a0(FfpsKDD%^dHfjE>i#uw;3LS|-=uHhHeG2gcqKrUni*tA17wXZdLe!_k7NlU$zVuK&mCFj*;@$3f*!errx z;-@3@hge-t{2%z5_8gICvMAGN7c74)dbi}>fa~*Ys`~c1DIj< z+f)-<>|!VUuxtzZ)rH*^bPV{6x8Pag6I4byBlz6Fc-oj((#Gjvxqm-f>wxEJ&0(RY zsK>{LYcc4FVmPK9Y?x@fHcYYhH!+B1+Qb{RR2EL|t4g z4#ih_mS#lI_+9=&}U!lu_d(SG^Wg2c$f71x@~ae7&? zuKXA6|E1!1EbK#IBCB>4ab}?PCu4qvjfa zsMJ>l_deTy9u6^QjR$*s?^22C&e|6oBhsd&cSb})_4EFet|Y+uj^2>sJe-t#JfZzw zFBF;;&hV(~&~n^&945raG){~w6!ExhiZ|(PIMA!lNES8t_rV5PBJS_kIi02SV-N;u zyJ5*)lDj*Ysyr5PMjkHrD=D{*Gdev1(*}3eTE_}*T;zVAt4ASU!oSd5y^HFu8^B{c z|HCn&7%v_<0O)4mj&NiFGq7h9?i@hHKe{7i0n)+$@Fsj89}oQbwlr=ieT@rtlG^S< zrREHZHOiotJ@``zhSC5quG|2?RA-!4>e{;tkFksP$h+7yiz?AeM8xVSxLf@$GSF^k zrHFJb%=46HQfUnT60c)!keb_uj<$EY{1hC@;U9i?OiFy;y7JC~_;zk~+|*tg97z;_ zV4!%PyYm%z^Z)xs9_nu3r>k7Z0M%Y24sy;5IY~;3Da>wNQ+MH+z1#U z{h+Wlw!F%iEvRjzs1W`4pM!%_iv~9g={|D`^4U zd#cdXqOG@A($@eeqI~b$#?zcIxi4&Cyp2zbO)Xa+OCSjmjI=j3q7}8{4lR_f-CJYh z!tH(R+P%szi2%Db$Jhj+qsNweWnnk{k)pIvBsrVi)y-*JR7y%=H7I-+KzX=ufyPHzg|ZqjFXRY*ZQv-h=0F(@`LN2=lsD7XW_2I zibsdBuVIg_U5SP9Gp3CQKI&4uvtjr|53^c*0d#aO>O%DE(W-osP%1&Jsiw}x(%mjf zKbK&|#(KvgQ{C{ARAaa?ZCg%Ko>C7#H$z?!Yu1wRyto(`f1R1*2avH_<(XDP{yCK&U>1}3 zzTTCfN@Bp>^tH<=OrZOJO&%X7#eDT@Kv+dJ9;0>|%PpP&4Q&ClVF&OaD~BQx{Jucs zB=#7GGei#HNqqow&CCDYTxJ*Cw>mx$A9o()SwH$+C<>C1(&P_o4h*TdJbx&pU4iJ4NMY?pjzDE%~ zM(;cyjpr#ITl1Btkd0XO&!`msW}**lyjU8$H)T7m8Q}Esn7Ot?wmMY2=3Q$cW zL9fau5bn~XAGW>yrsPfy(r@3gy?*`L;b2ML;PLKXUB#iQ?Uuw4a6PewoA}1dL-!O( zmafAr|40gKHa6pD+37XXSEW12MQ^hxomuj~2W!~L%70bi&dc85V95oPeJ{(b`tiBk ze3IkH{FlB8R{8Y3ln%hq8cIPl5C~>EAw{+S^HF4@7b+)QEpXi>V)`b?Q{#wX-kdFv2sp+XO%sTz&y9->qN0 z>pJ@!(!A5w=R2cC9ip(NJ0KRBID_6IaLO=oE?&TQ+K9h5f@ay0u8|cwBYrY zqgvD+y;uD6SY!xv%~m)!hsr;I=In}r?7_{8CwXMgUp_Q}@4OQto3=0s3&i!4X=#Q>?N!xF1owzen(nx|H3CE+{?JJluw7-fE#E}aA zv=Ua|N_)`+wDT1BVe=Lq2VK|{1@SS>uNdOscy*h-lronIRk3*Cp^tY2rq+~1oBh_( zD*J>(dIJvCpbOV4aT2P4Q@k&GhfnWw&gdxSM?y|_g{hF6@RY}k(!cfTn9k__UPJbp z!39OR0Qa7_54m_#{wDpt=Xsf_OFuB?&D4iOa*dc>(@o!D{t+YhZFDN^>74bnXc|D{ z2b1N4H;-VOTkZLTzAs07?yG-VZqtN7`s7@%wpN*`7i)Yr$2^YsNl<4YsF0+5rzM3u zEm>b;P1v;Hh;mC`DX^w+rRj0b8oJ46J0u&ZB5B4 zKlkHX*t^mH^;1Rg=;S$u(pIAYTIu^RWI#8)=yCz@-1QE1KBlJWWCjh`hN3Vv_WUXf z)qe1_v{wq8rj42Da(cdp1-xv!VHS(a2vdGKWwdq`RY=jxElmWd#n~*#wF2G!Fa{X1 zbdh|-UVyr8FC+u$pOr^l!pA~2RlNNA04Iz<;tGzU6u=*85ZA}or?abx1&p9EY{WCY z8GqETKpYqW_Zu+i_g)z(CpH2bG?bEs8svy^ZQ2XcG43)4vZ~ek^A*IroT4ab_$_~y zWJ54T-hFB)&(`>G^=_RPNL(~7>=cD~VW&aq!y)u6U06U+N5Q3N^=vT_jPJ1)7YxPS z#z$V+?hB@91*&NAR@)Gl^Cfp^#E&`TPJK{N0r2#Hmod!d&DncjHOp`FP#ZZ z14)*x#5UQLGKe!eyO*9Jx|GF+CV*60(pWV6YTCgFqT8efX@J>|45zT&Y3 zqHCjF&@O*RpVzWuYZ0JhUN}**?&teI0agI1|2zkqM%n&w#rE$KEBU#l2+QtL6I|6c zXj7E!cQ};-XN48&)ChGUDW{;)oq{gIfUKhE`;Z?CAtXM8!a*7k%>NH@358&K&kyPV O0000 现在你已经配置好了项目,开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console) + +### B.使用模板项目 Mirai 鼓励插件开发者将自己的作品开源,并为此提供了模板项目。 @@ -32,15 +46,17 @@ Mirai 鼓励插件开发者将自己的作品开源,并为此提供了模板 3. 克隆项目,检查并修改生成的属性 -### B.使用 Gradle 插件配置项目 +> 现在你已经配置好了项目,开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console) + +### C.使用 Gradle 插件配置项目 `VERSION`: [选择版本](#选择版本) 若使用 `build.gradle.kts`: ```kotlin plugins { - kotlin("jvm") version "1.4.31" - kotlin("serialization") version "1.4.31" + kotlin("jvm") version "1.4.32" + kotlin("serialization") version "1.4.32" id("net.mamoe.mirai-console") version "VERSION" } @@ -49,8 +65,8 @@ plugins { 若使用 `build.gradle`: ```groovy plugins { - id 'org.jetbrains.kotlin.jvm' version '1.4.31' - id 'org.jetbrains.kotlin.plugin.serialization' version '1.4.31' + id 'org.jetbrains.kotlin.jvm' version '1.4.32' + id 'org.jetbrains.kotlin.plugin.serialization' version '1.4.32' id 'net.mamoe.mirai-console' version 'VERSION' } @@ -60,9 +76,9 @@ plugins { 可以在 [README](../tools/gradle-plugin/README.md#mirai-console-gradle-plugin) 获取详细的 Gradle 插件使用方法。 -> 现在你已经配置好了项目,返回 [开发文档索引](README.md#mirai-console) +> 现在你已经配置好了项目,开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console) -### C.手动配置项目 +### D.手动配置项目 不推荐这种方式,因为通常还需要配置一些不容易配置的编译器参数。 @@ -80,5 +96,4 @@ dependencies { 注意,在打包插件时必须将依赖一并打包进插件 JAR,且排除 `mirai-core`,`mirai-console` 和[它们的间接依赖](https://mvnrepository.com/artifact/net.mamoe/mirai-core-jvm/2.4.0),否则可能导致兼容性问题。 -> 现在你已经配置好了项目,返回 [开发文档索引](README.md#mirai-console) - +> 现在你已经配置好了项目,开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console) diff --git a/docs/Plugins.md b/docs/Plugins.md index d0875603f..95c8ac182 100644 --- a/docs/Plugins.md +++ b/docs/Plugins.md @@ -407,7 +407,7 @@ object MyData : AutoSavePluginData() { ``` ### 打包插件 -若 [使用了 Mirai Console Gradle 插件](ConfiguringProjects.md#b使用-gradle-插件配置项目), 执行 Gradle 任务 `buildPlugin` 即可打包插件 JAR. 之后可以在 `build/mirai/` 找到 JAR 文件. 这个文件可以放入 Mirai Console `plugins` 目录中加载. +若 [使用了 Mirai Console Gradle 插件](ConfiguringProjects.md#c使用-gradle-插件配置项目), 执行 Gradle 任务 `buildPlugin` 即可打包插件 JAR. 之后可以在 `build/mirai/` 找到 JAR 文件. 这个文件可以放入 Mirai Console `plugins` 目录中加载. 若没有使用, 请打包插件并附带资源文件和所有依赖到一个单独的 JAR. diff --git a/docs/README.md b/docs/README.md index dc740a69f..2ac834ff3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,10 +2,11 @@ 欢迎来到 mirai-console 开发文档! -**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai),因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/tree/dev/docs)。** +**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai),因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md)。** -- **[配置项目](ConfiguringProjects.md)** -- **[启动 Console](Run.md)** +> 其他链接: +> - **[如何配置 Mirai Console 项目](ConfiguringProjects.md)** +> - **[如何启动 Mirai Console](Run.md)** ### 后端插件开发基础 diff --git a/docs/Run.md b/docs/Run.md index 92e56dd22..c7ecae2b4 100644 --- a/docs/Run.md +++ b/docs/Run.md @@ -4,14 +4,11 @@ Mirai Console 可以独立启动,也可以被嵌入到某个应用中。 ## 使用工具自动独立启动 -独立启动 Mirai Console 作为一个应用程序,由 Console 扫描 plugins 目录加载插件。 - -官方: https://github.com/iTXTech/mirai-console-loader -第三方: https://github.com/LXY1226/MiraiOK +该部分文档已经转移到 [用户手册](https://github.com/mamoe/mirai/blob/dev/docs/UserManual.md)。 ## 嵌入应用启动(实验性) -将 Mirai Console 作为一个依赖嵌入一个 JVM 应用启动,开发者主动加载插件。 +将 Mirai Console 作为一个依赖嵌入一个 JVM 应用启动,开发者主动加载插件。尤其适合在开发时启动真实环境的测试。 ### 环境 @@ -24,12 +21,9 @@ Mirai Console 可以独立启动,也可以被嵌入到某个应用中。 `build.gradle.kts`: ```kotlin -repositories { - jcenter() -} dependencies { - implementation("net.mamoe:mirai-console-terminal:2.0.0") // 自行替换版本 - implementation("net.mamoe:mirai-core:2.0.0") + api("net.mamoe:mirai-console-terminal:2.0.0") // 自行替换版本 + api("net.mamoe:mirai-core:2.0.0") } ``` @@ -55,8 +49,8 @@ Plugin.load() // 扩展函数 Plugin.enable() // 扩展函数 // Java -PluginManager.INSTANCE.loadPlugin(Plugin) -PluginManager.INSTANCE.enablePlugin(Plugin) +PluginManager.INSTANCE.loadPlugin(Plugin.INSTANCE) +PluginManager.INSTANCE.enablePlugin(Plugin.INSTANCE) ``` 但注意:这种方法目前是实验性的——一些特定的功能如注册扩展可能不会正常工作。