From 1970e6ce659d178ce5760571fca882918e2a86c3 Mon Sep 17 00:00:00 2001 From: Ruri Date: Wed, 1 May 2024 18:16:48 +0200 Subject: [PATCH] Fixed hits docs --- docs/hits/general-info.md | 44 ++++++++------------------------- docs/wordlists/general-info.md | 6 ++++- static/img/hits/filter.png | Bin 8469 -> 0 bytes 3 files changed, 15 insertions(+), 35 deletions(-) delete mode 100644 static/img/hits/filter.png diff --git a/docs/hits/general-info.md b/docs/hits/general-info.md index 7f65bd4..30102e5 100644 --- a/docs/hits/general-info.md +++ b/docs/hits/general-info.md @@ -5,7 +5,7 @@ sidebar_position: 1 # Hits -All of the hits you obtain with a *Multi Run Job* that has *Database* in its *Hit Outputs* will be saved to the sqlite database. You can view them in the *Hits* section of OpenBullet 2. +All of the hits you obtain with a *Multi Run Job* that has *Database* in its *Hit Outputs* will be saved to the SQLite database, usually saved in `UserData/OpenBullet2.db`. You can view them in the *Hits* section of OpenBullet 2. ### Types of hits Hits have a type that depends on the *status* of the bot when it ended the execution of the config. Configs can change the status of the bot that executes them through *Keycheck* blocks or statements that specifically set the value of the `data.STATUS` variable. The values of the status that will result in a hit being sent to the hit outputs (for example the database) are, by default, @@ -23,39 +23,19 @@ Name=MYSTATUS Color=#FF00FF ``` -The `Name` can be anything (a single uppercase word is suggested for consistency) and the `Color` (defined with HTML notation) is used to color the keychains of a Keycheck block accordingly. +The `Name` can be anything (an uppercase word is suggested for consistency) and the `Color` (defined with HEX notation) is used to color the keychains of a Keycheck block accordingly. :::info INFO -Editing this file requires a restart of OpenBullet 2 for the changes to take effect. +Editing the `Environment.ini` requires a restart of OpenBullet 2 for the changes to take effect. ::: ### Operations on hits You can view the list of hits in a table, which can also be filtered. -Operations on hits can be executed on *Selected* or *Filtered* hits. - -#### Selected hits -In this case, operations will only be executed on the hits you manually selected. To select a hit, simply click on it. - -If you want to select multiple hits, you can -- click on each individual hit while holding down the CTRL button on your keyboard -- hold down the SHIFT button on your keyboard, then click on the first and the last hit to select a range of hits - -#### Filtered hits -In this case, operations will be executed on all hits that have not been filtered out by the filters you set. - -To filter hits you can click on the small filter icon next to the name of the column on which you desire to filter. - -![Filter](/img/hits/filter.png) - ---- - The available operations are: -- **Copy** - copies the hits to the clipboard -- **Download** - download a text file with the hits inside -- **Edit** - Edits a hit (e.g. if you want to manually adjust the captured data) +- **Copy with format** - copies the hits to the clipboard with the chosen format +- **Download with format** - download a text file with the hits inside, in the chosen format - **Send to recheck** - Creates a new Multi Run Job with the config that originally got the hits (if still present) and a file data pool that points to a temporary file where the hits to recheck are written. This is useful if you want to check some hits again to make sure they are still valid -- **Delete** - Deletes the hits - **Delete duplicates** - Removes the duplicate hits. - **Purge** - ⚠️ Deletes ALL of your hits, only do this if you are REALLY sure that you want to delete all the hits in the database @@ -63,16 +43,8 @@ The available operations are: The wordlist is taken into consideration when deduplicating hits, if you wish to ignore it, then go to the *OB Settings* page and enable *Ignore the wordlist name when removing duplicates from hits* ::: -:::caution WARNING -If you are using the web client without HTTPS, when copying hits to the clipboard, your browser will show you this error - -![Hits](/img/jobs/multi-run-job/clipboard-error.png) - -To solve this problem you can either enable unsecure sources in the browser or use something like [ngrok or cloudflared](https://discourse.openbullet.dev/t/your-openbullet-online/925) -::: - ### Export Formats -When copying or downloading hits, you can define the fields you want to keep by selecting your desired *Export Format*. For example, an export format like ` | ` will print the data and the capture separated by a pipe, for example `00042 | Valid = true`. You can choose between the built-in formats or you can also define a custom one by editing the `Environment.ini` file. +When copying or exporting hits, you can define the fields you want to keep by selecting your desired *Export Format*. For example, an export format like ` | ` will print the data and the capture separated by a pipe (e.g., `00042 | Valid = true`). You can choose between the built-in formats or you can also define a custom one by editing the `Environment.ini` file. ```ini title="Environment.ini" [EXPORT FORMAT] @@ -93,3 +65,7 @@ The available keywords that will be replaced with the corresponding data from th |`` |The captured data| Everything else will not be replaced. You can also use `\n`, `\r` and `\t` for new lines and tab characters. + +:::info INFO +Editing the `Environment.ini` requires a restart of OpenBullet 2 for the changes to take effect. +::: diff --git a/docs/wordlists/general-info.md b/docs/wordlists/general-info.md index 0cf91ba..288e78d 100644 --- a/docs/wordlists/general-info.md +++ b/docs/wordlists/general-info.md @@ -65,6 +65,10 @@ By doing this, when we select the `KeywordsCodes` wordlist type and we provide a The first wordlist type of the `Environment.ini` file is the one that will be assigned by default to newly created configs, so if you find yourself working with a specific wordlist type most of the time, move it to the top of the file. This way, you will not have to manually set the Allowed Wordlist Types of a config every time you create a new one. ::: +:::info INFO +Editing the `Environment.ini` requires a restart of OpenBullet 2 for the changes to take effect. +::: + :::info INFO You can also use the [Data Rules](./data-rules) in a config's settings to enforce rules on individual slices. -::: \ No newline at end of file +::: diff --git a/static/img/hits/filter.png b/static/img/hits/filter.png deleted file mode 100644 index a874c03469bce7232215527c5289c5073677be8d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8469 zcma)h2UJttwsjBzL5g&xYEVFFpCUzCP(trTdK07wp;svZMI=ZQQF=g{lmMakBF#t_ zr1uUINC>_24&Q&@8~5G&-W&fOBjIEpvd`XY&9&xSE8$uiic}OV6d(|YN?8f20|F79 z0N1P6t^n`xAM6K!iO^Saa$3rAa<^UGU2I>$Y(OC1*uYq6r8Zf%4h!8Ju)td;2DhJD zNdCi6aTUf0%Zv&}W3RtzcjfE{KW5j6QxubsL6}g~f_-%oH56~>$Pig^ahVaH51X@p zfq#T7!W-%jYW&Hr?LE@%jeaOQ%+JLb6Fxrm;ihkBFnkyM&MiF258U|i&FW!YSPa@n zJ8d}-*H5dn%}pEtCh-5Jitt7H`u!e!f~OBNQr1EAhbvOm-6n92+9b@1GqW@K+K&Cq zUO}|ATa`vFi`w3kyO#!z<}FY-dNyJcy2E5wX=>B!zs*d#GvS_$eH?ZJ1Ey1Y_Ac^) zsMh;X-XfO!+&UGUJ6kjo=XYygx;q8OT5~YwePn|ia-QNw_|-IOlv{58IoQzem@&sSpsu?ssS7A>)y4yH12v(Hs7j<=;9$b>1b0@p$J9tmd{Vqg3Lkl$1 zzn0=IJ1g+3aeaSe3iF5fV@7ejb8v{9Wwz3|BL^PmfZv=I?mdTtz67~f{@V0s1N=hn zs$}E=0ts?mzKDEtAl|?vnWwV4JlV<>W;zzRqx|aOdR@WiiBY-@IzF7c=5~=dLJm?20D)u|h(RDaP7p}qop5#Za)xG|)dmMB z@E>=AqgwK!<>ESD9wbeUjUniWCK%~B>%zCTwoZDa{rCA*uG$++lhgR7hmw4FB7-g+FWJMUaKZ!2Pk7*)1M~5iYLlqh>}liL`t1A;M7$H;!O>A#TKXuU zsqTUnJf_WPKdxQb+A z*u@k4(5g#GlZQw%OXSAD9DLB4ocQD@g45aQx1xV(4QHu1-%Eu$OoZKq-4 zk}4F_H(Hk4#%%GUO1A!3K);W2V^zr6;bB=YPMAx&dZ{V`;qRk>4>QR~&;5uf5IKIk zZ7Z6?N(qzN5{E|@ywX%z&QyjAQDKkzs2ORCe5Eb>c4Quvez$+L`bG5Og~!vcJ~2Z2 z?@O1P4R3jG?G{x-cx!wfsq?YaTYhV4tOqm2asEGt(Y) zd?>kdX2X{5Q+ZhR47YU82kvDy0}&kYN|$NsIGQ2_Z-0D3!s}O{Vt* zzSqKe0l(RFz3=aSW}A)S?*wN$T}=DTTyH9@+&XFq@AnNjT0M`y$MwwgZGivd8BzCu znK9lY6Z*g%m#OnVw%0F_*tabD`FT}U5V{fno|<({1lLV#o+Iy6 zZS(W1lX(3z)p$~^K3boWb*_tP?clgM**J1T>o)gP6vCWkBo1+Y7z7DC>R$&!duNg~ z>O;FoR`g8qu7XF{Zwro@IK)B~Y9E;gKviZ(drA1rrqKT>bU3-{m(eZguAEi-*QUV> z3OA#}7k4m(1-q;E74MlB(R2f;tAYHEth6{4C`yKJ+HJ{hWS z(`3->p9!B3)%(ASIl>5`kQ97HHV#RG@q6@5>5Cs9Z>T+3;q+zgnETxwS;C(1+8qH)Y2~JROA# z;2VP{lD&h_X&0YdE_m+hga;$e(`H&e=E=IQqShYN{`ML>?o|(IiR=yY&M6)~@)d`S zpUfJpG)Qt;_FYX+cl0Dzwi&z8Lwpe48e%qs*yGO3T6I9IH6Pd9(00&2W9C8OJO&Ga zhcS2c_MZL8O|RP`{`|bsoUgW*@LJRNz}`tXaNA7&q;|t$t~6u`s#oBw-do_}BwPv) zY+bb>Pfz$m`OO915W2Zmvbl~)B?YsHjUmmV|9}_1MQwjlCHdmzbWvl7G49?SFozEH zTWs9(u?pY4;j$YO;iV9lgji`_!i#0IMx>lL zL4A*zeDf7Qfk+0W#{W^3q{!)8;6+}f(Wj2Obv~bj)cT3?pvj%6_iWsfPzfl;5pJ2Pj5Fsge1$jw3l&iqu*wZ}pIA&KmC-k<&Jo%T@mAW)-3G ztJS+5=bA(^QOkN=OHNTVfUpeYGry3eJ<3PdD}>rDY!)|w>~?x+DDRj896wQQ1urS)v*gJvbqupxn|#R~7n#-albU3NZS>Ae8E?D&Bmc&LVw0$K*@H=Qj4?6OuJX?z0b^*;5{(t^opiqq zfNF+zU15;&_UME-@s&krMr*Tsu5*&&VrVR5wmA7ffYexH;!w0>V-EmHhHA5eK)VDY z5Gb5x4iVNSWqyKrmhqSH<1H-dw!pE`7|o`guh*R*qc`p;M{U}->r85El;D=P!X zAt51=^xi0GaOn8JXn;06O0S?Zj;DN)7=WTq{#ar4 zj30I|M-_$*I@=os5D8`A;7CJW4ySPppxQTn%(sPw|LpG<;^uyjAf;wgf-(!5T6*N@ zyu!~kva+(0TxqFsTco3>59fXO&~1NX{8>gxX=yA15G>U%+DO3^*RIWpYX~M}6^yi# zdV|4W!RcPG@>){2OV zR#jHYD=0Y6HX)sCn3)kc&W19xwp*(G9#f!H0fSbf-d_xeKSy|!sgoO@|)jp({3rB&2I?OWc-ubT#x%}ym z8hUzquC66I`2ovc4EoX`nowd=%C#j29*tBbC>b>yA~KRq%sEvbMMX{?9v=S0dt+5p_5?Q^s zlZlCmiVB6vrOh`^ISlDp$7&sw>;Ugrl_nxqdXj*nbl=gw1##v5GAJ}Uq4OnO z_|inBBh1gnCTGBY$o_F&?p`UMccem=jgn%KzRP%74v>I>z%DK>2GVdDTWRG%Li1@( zL4nHc8`nZx_f3KTQ{x*C(u|9|-P~e3UqUWUg->YAqZED*4Gj$rzNK>F@~v^`ij|j_ zXJlrEtf4-uEcYQLu~=+YX6D#uAjn-ND#8(esSy7HtoszU>L7A+_zl@k8x5pH4&Ht7 zf+)E0dmgpa&2T9A#QX_+$0 zQixh2`11BF+KQ&=>T0@Nc)H;Bo`Dyjk92j_N2&3*2^r-hg+{`!2DA5@Lx^HJHz%uU z*d;0)h6@ybxA-uX&zuGSY9fPN@XN@+Co1v}X;t{<#GP?dwZI&#D{{Pc^m;gERWd@o zZqn>17I&7!>dMyC)Py|E{~+Qx(y%|_2%wxdnNeI)GAu02-`6))Ch(XxpwnOJbwD&i zzqx)lPE%&4(lKFNv=1!tjPnA>sZ>-{zjIGU z_CT?`CovegDUl1jEu|%0oadiZ*q>_10J=+62Co%ke2V?_`Y-zlTjPm z2A*tILm4;ABV;JRm@d_7>%PAn~ZDiUX9Xkt$9&!8h9p%>v6{(arGm=cS`f z2Q&Wk+-h16zWmPB#D97>QSD-(tE+o*UtL}OOdaTUx63We(E=vY}TeBm=VKV5~GFikcGT{OJj`Sj_NLNwbE0mEtV{Q14RcQ?jL zLl6KN#D4rJ3k3pK5`KCJ5Fh}-#~v#^0wz^UD=RZ64{>IU{!V^=epXgiz`CBEyB`?& za1<7Nhx?N*iwg_<_{pIm24?1iUa?tEWqea{F>bSZmYRa1;6&cj^KnW_YHH87sY;6q zH8cv90^l;p6fk9mWclv6X_vpT&Dt#_fJMF8P1bVS5IJg)UvrDhdX%h2jc z7U{Ns?Csm+1B8nI{s#H=>mF`yNfKTUXrJrpP1PHQp$hWz{|uuH3=I>XWh9EZ%w)<( zBm<(*G#zlTfxf;okWr+kD_-f^*etK~rW7^jEG#ZgPfz>cri@HYH_js>BPp4%(DrY@ zAxxe@?%cV<%lorz3y_QWW{wi}Ln?k>DJoUh=5Jrp(=U32`wi2mIiwQVnE+tih>eK2 zo>HvE3wK(bUs(8*nCQE|VT8oNo0+EP3v7E5OFjP#hST%x<7Y2Am@Oisq8cx91KHk& zgp3v%(K9nwzxvHxJ|1v>deq+DJ~wBXGJyct3D9#kG4%BGx;i=l?;9b=NJxx0i0L@l z%(S#_&^|XXD8FH+ft2`?kboiehG!kj20?gu>;Sw69`D`(=jeiZxs34^Mi4)wr0UI)D#TQ&TG|Ff9;R@=)m55YtQINB8gFXXjutv<1>~IlHK( z9vPc~rRCT9`V*hoz)|=@f(6`2N2m3X7$0BvBP11b2@=Y)yt;bHWF2Q`iXU;6&eL^~ zk&#bBNCk|_US6D^iHL}-_NU`NJ&59j!1vYx2cbCtmUeQ+jExx{c=IFuMBgvsa2m~& z=RgFrO?NQ(yJ-G zr+1R|#$OqbWpx1h0|TXLU;Ft1kB|a_B0KwK=cjv6PwYsM2E3%IstOR*E6dBkvS(Xu zG|(k1cJldi7E#z($&0qS0Bc4DhLSfd-JgL2EG#SlLiMD1tJtEq!AIIs_pbutm~KF5 zjiN0s1{66PfvgH$!sD9*PrOHBX~@aPfye@)CWaG&TUu%tOsu__V4&zYBrN*iXOIaA z)qq`qK)h5Mz>YLDG=v&=b*!zq>Zx;u^^1%vfl{WXM!eBnD4~0CagmJj=G+{sBcKTT zAr}oclsuxMqFh|ofQ(N{N{TnhFd}vR6c>kyX7?X$w=kh;x+Y4}48#4BxaeMa@P%Tz ztVz*baCEzS<;ZAtTs%@_czD?8LfuK-%xpR?R&Lz-wCu@$FJ?;a+-z6;&rbJ0@uZYQ zwacsm?MCB@ZF$n7IKxPnc(iZ|z>Fn4Vbtu;Xg4ZWY_rm&mDHuBeQ>70?Ug=cO0wT^ zvD1J}JtrV`)fY+v0s}=@)a~M>0*@=g!W038T3#-^ZW}ri2xz~8=O_;C=IDNAae8f| zqh7N~h=aX-jr;P4&0PsVyubmslarHQlv}BLsSD61?FwwlSqLVeh8-N?cc%<68D8g2 z5|$WWDV~J1_C@*ufG4l7^s$II+yz+X1&3Jqcxtkr-$|~&2b!6VHc9>X8;e6Vy7D~G z3*fL|9H-Qecm<6O1t`Fv%={-7pR-kOny}=fXo~)drulW2L@8nIA)TboE6=>?ss3Zd zFYf8+GUrvG`L9SGsH;mgYt+Mh?R6?Wg;h?T*t$9?GQTJZw%ATi$NAlD0RtPH7X9Oz zQMA~aNBzGD5TL;Sms;}QCjQA8|J`N(M{)UY-}$$RzaMO-7)&P{rlu1V`2A*J{$H%*4d$1Rc!HWWc zf}r7G=T}(Av+WswTj0;ef#&x>uQ}R8x}vpZLDRD$6+t(a$=S1zMH|?0u19O;l^n=( z5k<0E3UTunHaqp5@)tTHYT^2@q=AF2oOL&1>GnQTx$=25Pq$BM-8dXMi;=HWO?_Y3 zX{o6xz`4{;NIz5ME}$}#2QR$@zk&YDh@qk04E>oVhV{H};HYVi!s2YfZ}C`_pT>xIfzGtKp9Q|GJQnerzT>(1B&O-k6s1F*#FqGI5__g6C7qdIaq zhJ_u-aMsXeJIP8@`c60htJ|4ELV7HbE3-7(hPK1@d&1sJX?6P5_m&m5n+uMQPW^*Q zj(o@GRfofbo(oMF$U-+Qv*F219a)wr1&=5~(MzXKPx>xRt z6(5C7)g|&Q>t-^}p9`iV^JVihP`k$N?-4RcdL~v}>?d8x1DDrI0j^Nm#+;BVIb^~G zP4zm~Nr$7OCyf$ADfeX1(?S~1UGF=YtzEVwz09ss-6~UNsSXuRK1BijNgwVlo?b9a zrXaj??+}PS9{$St2KA>MNE2S)mlI@GWg#Q!8e2@$$<+As`5Y+M zO&8RXXfEKy?S#5>9x59$Fg5?zS#A2dMf7%^;gq2^TCVbPy)QrZ4{Chgou$7{9(aM< zXgy^qGUr}67v+gGLmpwyNa8!(T|}KyIa-VROg(C9+Fl&v%N)$3w_ulsA<`do0RW*`J!1usJHP5ia)D|cGQoX0rM+X-=p?mHFf7IizpArG#J*|a! zCUv)cZ`iJ(fBsQGu;Nt%ySGuvGEl&(U#doua2tr+n;pFZfBPmh6kKxDyX=}-mrXhcvw?go527Yk!sLK4Fg@u%c{ng k9}o=xOXsj8`hv`VCg~e-?ek6G=W>v;yau%RndRI6049TH@&Et;