├── src ├── dependencies.txt └── scripts │ └── kgblib │ └── kgblib.ash ├── README.md └── LICENSE /src/dependencies.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # kol-kgblib 2 | Kingdom of Loathing - Kremlin's Greatest Briefcase library 3 | 4 | ## How do I use it? 5 | First, install it by running this command in KoLmafia's graphical CLI: 6 | 7 | ``` 8 | svn checkout https://github.com/mikebryant/kol-kgblib/branches/master/src/ 9 | ``` 10 | 11 | Then, run `kgblib.ash` to automatically unlock: 12 | - First light 13 | - Crank 14 | - Buttons 15 | - Drawers 16 | - Martini hose 17 | 18 | and use: 19 | - Drawers 20 | - Crank the flywheel to get 11 extra clicks 21 | 22 | To update the script, run this command in the graphical CLI: 23 | 24 | ``` 25 | svn update 26 | ``` 27 | 28 | ## Credits 29 | Inspired by AlbinoRhino 30 | -------------------------------------------------------------------------------- /src/scripts/kgblib/kgblib.ash: -------------------------------------------------------------------------------- 1 | script "kgblib.ash"; 2 | notify "LeaChim"; 3 | 4 | int [6] dial_state; 5 | int [6] light_state; 6 | boolean handle_is_up; 7 | boolean crank_is_unlocked; 8 | boolean buttons_are_unlocked; 9 | boolean left_drawer_is_unlocked; 10 | boolean right_drawer_is_unlocked; 11 | boolean martini_hose_is_unlocked; 12 | 13 | string dial_letters = "0123456789a"; 14 | 15 | string dial_number_to_letter(int dial_num) { 16 | return substring(dial_letters, dial_num, dial_num + 1); 17 | } 18 | 19 | void debug_state() { 20 | print( 21 | "KGB:: dials: " + 22 | dial_number_to_letter(dial_state[0]) + 23 | dial_number_to_letter(dial_state[1]) + 24 | dial_number_to_letter(dial_state[2]) + 25 | dial_number_to_letter(dial_state[3]) + 26 | dial_number_to_letter(dial_state[4]) + 27 | dial_number_to_letter(dial_state[5]) + 28 | ", lights: " + 29 | light_state[0] + 30 | light_state[1] + 31 | light_state[2] + 32 | light_state[3] + 33 | light_state[4] + 34 | light_state[5] + 35 | ", handle: " + (handle_is_up ? "up" : "down") + 36 | ", crank: " + (crank_is_unlocked ? "unlocked" : "unavailable") + 37 | ", buttons: " + (buttons_are_unlocked ? "unlocked" : "unavailable") + 38 | ", left drawer: " + (left_drawer_is_unlocked ? "unlocked" : "unavailable") + 39 | ", right drawer: " + (right_drawer_is_unlocked ? "unlocked" : "unavailable") + 40 | ", martini hose: " + (martini_hose_is_unlocked ? "unlocked" : "unavailable") 41 | ); 42 | } 43 | 44 | void parse_state() { 45 | string page = visit_url("place.php?whichplace=kgb"); 46 | 47 | matcher dial_matcher = create_matcher("kgb_dial([1-6])(.+?)char([0-9a])\\.gif", page); 48 | 49 | while (find(dial_matcher)) { 50 | dial_state[dial_matcher.group(1).to_int() - 1] = index_of(dial_letters, dial_matcher.group(3)); 51 | } 52 | 53 | matcher light_matcher = create_matcher("kgb_light([1-6])(.+?)light_(off|blinking|on)\\.gif", page); 54 | while (find(light_matcher)) { 55 | string light_name = light_matcher.group(3); 56 | light_state[light_matcher.group(1).to_int() - 1] = ( 57 | (light_name == "off") ? 0 : 58 | (light_name == "blinking") ? 1 : 59 | (light_name == "on") ? 2 : 999 60 | ); 61 | } 62 | 63 | handle_is_up = (page.index_of("action=kgb_handleup") > -1); 64 | 65 | crank_is_unlocked = (page.index_of("action=kgb_crank") > -1); 66 | 67 | buttons_are_unlocked = (page.index_of("action=kgb_button1") > -1); 68 | 69 | left_drawer_is_unlocked = (page.index_of("action=kgb_drawer2") > -1); 70 | right_drawer_is_unlocked = (page.index_of("action=kgb_drawer1") > -1); 71 | 72 | martini_hose_is_unlocked = (page.index_of("action=kgb_dispenser") > -1); 73 | 74 | return; 75 | } 76 | 77 | // Kick off our global variables by pulling in the current dial state 78 | parse_state(); 79 | 80 | 81 | void wind_dial(int dial, int set) 82 | { 83 | // 11 clicks will bring dial back to starting position 84 | string url = "place.php?whichplace=kgb&action=kgb_dial"+dial; 85 | 86 | int start_pos = dial_state[dial - 1]; 87 | 88 | int clicks = 0; 89 | if (set == start_pos) { 90 | return; 91 | } else if (set > start_pos) { 92 | clicks = set - start_pos; 93 | } else if (set < start_pos) { 94 | clicks = 11 - start_pos + set; 95 | } 96 | 97 | while (clicks > 0) { 98 | visit_url(url,false); 99 | clicks--; 100 | } 101 | 102 | parse_state(); 103 | debug_state(); 104 | return; 105 | } 106 | 107 | void wind_dials(int dial1, int dial2, int dial3, int dial4, int dial5, int dial6) { 108 | wind_dial(1, dial1); 109 | wind_dial(2, dial2); 110 | wind_dial(3, dial3); 111 | wind_dial(4, dial4); 112 | wind_dial(5, dial5); 113 | wind_dial(6, dial6); 114 | } 115 | 116 | 117 | void handle_down() { 118 | // Make sure handle is down 119 | if (handle_is_up) 120 | { 121 | visit_url("place.php?whichplace=kgb&action=kgb_handleup", false); 122 | } 123 | handle_is_up = false; 124 | 125 | return; 126 | } 127 | 128 | void handle_up() { 129 | // Make sure handle is up 130 | if (!handle_is_up) { 131 | visit_url("place.php?whichplace=kgb&action=kgb_handledown", false); 132 | } 133 | handle_is_up = true; 134 | 135 | return; 136 | } 137 | 138 | void reset_case() { 139 | handle_down(); 140 | handle_up(); 141 | handle_down(); 142 | handle_up(); 143 | handle_down(); 144 | 145 | return; 146 | } 147 | 148 | void left_actuator() { 149 | string left = visit_url("place.php?whichplace=kgb&action=kgb_actuator1", false); 150 | return; 151 | } 152 | 153 | void right_actuator() { 154 | string right = visit_url("place.php?whichplace=kgb&action=kgb_actuator2", false); 155 | return; 156 | } 157 | 158 | void turn_crank() { 159 | string crank = visit_url("place.php?whichplace=kgb&action=kgb_crank", false); 160 | return; 161 | } 162 | 163 | 164 | void unlock_light_one() { 165 | if (light_state[0] == 2) return; 166 | 167 | left_actuator(); 168 | right_actuator(); 169 | 170 | parse_state(); 171 | 172 | return; 173 | } 174 | 175 | void unlock_crank() { 176 | if (crank_is_unlocked) return; 177 | 178 | wind_dials(0, 0, 0, 0, 0, 0); 179 | parse_state(); 180 | 181 | handle_down(); 182 | left_actuator(); 183 | 184 | parse_state(); 185 | 186 | return; 187 | } 188 | 189 | void charge_flywheel() { 190 | if (get_property("_kgb_flywheel_charged").to_boolean()) return; 191 | 192 | handle_up(); 193 | for x from 1 to 11 by 1 194 | { 195 | turn_crank(); 196 | } 197 | 198 | handle_down(); 199 | 200 | set_property("_kgb_flywheel_charged", "true"); 201 | 202 | return; 203 | } 204 | 205 | 206 | void unlock_buttons() { 207 | if (buttons_are_unlocked) return; 208 | 209 | wind_dials(0, 1, 2, 2, 1, 0); 210 | left_actuator(); 211 | 212 | parse_state(); 213 | 214 | return; 215 | } 216 | 217 | void unlock_left_drawer() { 218 | if (left_drawer_is_unlocked) return; 219 | wind_dials(2, 2, 2, 0, 0, 0); 220 | left_actuator(); 221 | parse_state(); 222 | } 223 | 224 | void unlock_right_drawer() { 225 | if (left_drawer_is_unlocked) return; 226 | wind_dials(0, 0, 0, 2, 2, 2); 227 | right_actuator(); 228 | parse_state(); 229 | } 230 | 231 | void unlock_drawers() { 232 | unlock_left_drawer(); 233 | unlock_right_drawer(); 234 | return; 235 | } 236 | 237 | void left_drawer() { 238 | if (get_property("_kgb_left_drawer_used").to_boolean()) return; 239 | 240 | unlock_left_drawer(); 241 | visit_url("place.php?whichplace=kgb&action=kgb_drawer2", false); 242 | 243 | set_property("_kgb_left_drawer_used", "true"); 244 | return; 245 | } 246 | 247 | void right_drawer() { 248 | if (get_property("_kgb_right_drawer_used").to_boolean()) return; 249 | 250 | unlock_right_drawer(); 251 | visit_url("place.php?whichplace=kgb&action=kgb_drawer1", false); 252 | 253 | set_property("_kgb_right_drawer_used", "true"); 254 | return; 255 | } 256 | 257 | void unlock_martini_hose() { 258 | if (martini_hose_is_unlocked) return; 259 | wind_dials(0, 0, 0, 0, 0, 0); 260 | handle_up(); 261 | left_actuator(); 262 | parse_state(); 263 | } 264 | 265 | void kgb_auto() { 266 | unlock_light_one(); 267 | unlock_crank(); 268 | unlock_buttons(); 269 | unlock_drawers(); 270 | charge_flywheel(); 271 | unlock_martini_hose(); 272 | 273 | left_drawer(); 274 | right_drawer(); 275 | } 276 | 277 | void main() { 278 | debug_state(); 279 | kgb_auto(); 280 | debug_state(); 281 | } 282 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------