view clojure/com/aurellem/run/bootstrap_0.clj @ 331:6ec288064d49

improved do-save-corruption
author Robert McIntyre <rlm@mit.edu>
date Fri, 06 Apr 2012 12:18:58 -0500
parents ecff37d22293
children 5c2041d1cdda
line wrap: on
line source
1 (ns com.aurellem.run.bootstrap-0
2 (:use (com.aurellem.gb saves gb-driver util
3 items vbm characters money))
4 (:use (com.aurellem.run util title save-corruption))
5 (:use (com.aurellem.exp item-bridge))
6 (:import [com.aurellem.gb.gb_driver SaveState]))
8 (defn-memo boot-root []
9 [ [] (root)])
11 (defn-memo to-rival-name
12 ([] (to-rival-name (boot-root)))
13 ([script]
14 (->> script
15 title
16 oak
17 name-entry-rlm
18 (scroll-text 5))))
20 (defn-memo name-rival-bootstrap
21 ([] (name-rival-bootstrap (to-rival-name)))
22 ([script]
23 (->> script
24 (first-difference [] [:a] AF)
25 (first-difference [] [:r] DE)
26 (play-moves
27 [[]
28 [] [] [:r] [] [:d] [:a] ;; L
29 [:r] [] [:r] [] [:r] [] [:r] []
30 [:r] [] [:d] [] [:d] [:a] ;; [PK]
31 [:u] [] [:l] [] [:l] []
32 [:l] [] [:l] [] [:l] [:a] ;; U
33 [:r] [] [:r] [] [:r] []
34 [:r] [] [:r] [] [:d] [:a] ;; [PK]
35 [] [:a] ;; [PK]
36 [] [:a] ;; [PK]
37 [:r] [] [:d] [:a] ;; END
38 ]))))
40 (defn-memo leave-house
41 ([] (leave-house (name-rival-bootstrap)))
42 ([script]
43 (->> script
44 finish-title
45 walk-to-stairs
46 walk-to-door
47 (walk [↓ ↓]))))
49 (defn-memo to-pallet-town-edge
50 ([] (to-pallet-town-edge (leave-house)))
51 ([script]
52 (->> script
53 (walk [→ → → → →
54 ↑ ↑ ↑ ↑ ↑ ↑]))))
56 (defn-memo start-pikachu-battle
57 ([] (start-pikachu-battle
58 (to-pallet-town-edge)))
59 ([script]
60 (->> script
61 (first-difference [:b] [:b :a] DE)
62 scroll-text
63 (do-nothing 200)
64 (play-moves [[:b]]))))
66 (defn-memo capture-pikachu
67 ([] (capture-pikachu (start-pikachu-battle)))
68 ([script]
69 (->> script
70 (scroll-text 3))))
72 (defn-memo go-to-lab
73 ([] (go-to-lab (capture-pikachu)))
74 ([script]
75 (->> script
76 end-text
77 (scroll-text 5)
78 end-text
79 ;; oak walks you to his lab; no input required.
80 (do-nothing 400))))
82 (defn-memo talk-to-oak-in-lab
83 ([] (talk-to-oak-in-lab (go-to-lab)))
84 ([script]
85 (->> script
86 (scroll-text 14)
87 end-text)))
89 (defn-memo try-to-get-eevee
90 ([] (try-to-get-eevee (talk-to-oak-in-lab)))
91 ([script]
92 (->> script
93 ;; walk to pokeball
94 (walk [↓ → →])
95 ;; and try to grab it
96 (play-moves
97 (concat [↑ ↑ [:a]]
98 (repeat 100 [])))
99 (scroll-text 10)
100 (end-text))))
102 (defn-memo obtain-pikachu
103 ([] (obtain-pikachu (try-to-get-eevee)))
104 ([script]
105 (->> script
106 (scroll-text 6)
107 (end-text))))
110 (defn-memo begin-battle-with-rival
111 ([] (begin-battle-with-rival
112 (obtain-pikachu)))
113 ([script]
114 (->> script
115 (walk [↓ ↓ ↓])
116 (scroll-text 3)
117 (end-text)
118 (scroll-text))))
120 (defn-memo defeat-eevee
121 ([] (defeat-eevee
122 (begin-battle-with-rival)))
123 ([script]
124 (->> script
125 (do-nothing 400)
126 (play-moves [[:a]])
127 (critical-hit)
128 (do-nothing 200)
129 (scroll-text 2) ;; for eevee's tail-whip
130 (do-nothing 10)
131 (play-moves [[:a]])
132 (critical-hit)
133 (do-nothing 200)
134 (scroll-text 2) ;; tail whip again
135 (do-nothing 10)
136 (play-moves [[:a]])
137 (critical-hit)
138 (do-nothing 200))))
140 (defn-memo finish-rival-text
141 ([] (finish-rival-text
142 (defeat-eevee)))
143 ([script]
144 (->> script
145 (scroll-text 12)
146 (end-text))))
148 (defn-memo pikachu-comes-out
149 ([] (pikachu-comes-out
150 (finish-rival-text)))
151 ([script]
152 (->> script
153 (scroll-text 8)
154 (end-text))))
156 (defn-memo leave-oaks-lab
157 ([] (leave-oaks-lab
158 (pikachu-comes-out)))
159 ([script]
160 (->> script
161 (walk [↓ ↓ ↓ ↓ ↓ ↓]))))
163 (defn-memo oaks-lab->pallet-town-edge
164 ([] (oaks-lab->pallet-town-edge
165 (leave-oaks-lab)))
166 ([script]
167 (->> script
168 (walk [← ← ←
169 ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ →]))))
171 (defn-memo pallet-edge->viridian-mart
172 ([] (pallet-edge->viridian-mart true
173 (oaks-lab->pallet-town-edge)))
174 ([dodge-stupid-guy? script]
175 (let [dodge-1 (if dodge-stupid-guy?
176 [→ →]
177 [→])
178 dodge-2 (if dodge-stupid-guy?
179 [↑ ↑ ←]
180 [↑ ↑])]
182 (->> script
183 ;; leave straight grass
184 (walk-thru-grass
185 [↑ ↑ ↑ ↑ ↑])
187 (walk [↑ ↑ ↑ ↑])
189 (walk-thru-grass
190 [← ← ↑])
192 (walk [↑ ↑ ↑ ↑ → → → ])
194 (walk-thru-grass
195 [→ ↑ ↑ ←])
197 (walk
198 [← ←
199 ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑
200 → → → → ])
202 ;; this part is dependent on that
203 ;; stupid NPC in the grass patch
204 (walk-thru-grass
205 (concat dodge-1
206 [↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ]))
208 (walk
209 (concat
210 dodge-2
211 [← ← ←
212 ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑
213 ← ←
214 ↑ ↑ ↑ ↑
215 → → → → → → → → → →
216 ↑ ↑ ↑ ↑ ↑ ↑ ↑]))))))
218 (defn-memo get-oaks-parcel
219 ([] (get-oaks-parcel
220 (pallet-edge->viridian-mart)))
221 ([script]
222 (->> script
223 (do-nothing 50)
224 (end-text)
225 (scroll-text 3)
226 (do-nothing 197)
227 (play-moves [[:a] []])
228 (walk [↓ ↓ → ↓]))))
230 (defn-memo viridian-store->oaks-lab
231 ([] (viridian-store->oaks-lab
232 (get-oaks-parcel)))
233 ([script]
234 (->> script
235 (walk [↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
236 ← ← ← ← ← ← ← ← ←
237 ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
238 ← ←
239 ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
240 ↓ ↓ ↓ ↓ ↓ ↓ ↓
241 → → → → → → → →
242 ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
243 ← ← ← ← ←
244 ↓ ↓ ↓ ↓
245 ])
246 (walk-thru-grass
247 [↓ ↓ ↓ ↓ ↓ ↓ ↓])
248 (walk [↓ ↓ ← ↓ ↓ ↓ ←
249 ↓ ↓ ↓ ↓ ↓ ↓
250 → → → ↑])
252 (do-nothing 1))))
255 (defn-memo viridian-store->oaks-lab-like-a-boss
256 ([] (viridian-store->oaks-lab-like-a-boss
257 (get-oaks-parcel)))
258 ([script]
259 (->> script
260 (walk [↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
261 ← ← ← ← ← ← ← ← ←
262 ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓])
264 (walk-thru-grass
265 [↓ ↓ ↓ ↓ ↓])
267 (walk
268 [↓ ↓ ← ↓
269 ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
270 → → → ↓])
272 (walk-thru-grass
273 [↓ ↓ ↓])
275 (walk [↓ ← ← ↓ ↓ ↓ ↓ ↓ ↓])
277 (walk-thru-grass
278 [↓ ↓ ↓ ↓ ↓ ↓])
280 (walk [↓ ↓ ↓ ← ↓ ↓ ↓
281 ↓ ↓ ↓ ↓ ↓
282 → → → ↑]))))
284 (defn-memo deliver-oaks-parcel
285 ([] (deliver-oaks-parcel
286 (viridian-store->oaks-lab-like-a-boss)))
287 ([script]
288 (->> script
289 (walk [↑ ↑ ↑ ↑ ↑ ↑ ↑ ↑])
290 (play-moves [[] [:a]])
291 (scroll-text 13)
292 (end-text)
293 (do-nothing 200)
294 (scroll-text 2)
295 (end-text)
296 (scroll-text 2)
297 (end-text)
298 (scroll-text 8)
299 (end-text)
300 (scroll-text 9)
301 (end-text)
302 (scroll-text 7)
303 (end-text)
304 (walk [↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓]))))
306 (defn-memo return-to-viridian-mart
307 ([] (return-to-viridian-mart
308 (deliver-oaks-parcel)))
309 ([script]
310 (->> script
311 oaks-lab->pallet-town-edge
312 (pallet-edge->viridian-mart false))))
314 (defn-memo walk-to-counter
315 ([] (walk-to-counter
316 (return-to-viridian-mart)))
317 ([script]
318 (->> script
319 (walk [↑ ↑ ←]))))
323 ;; useful addresses
324 52262 ;; --- current-cursor-offset
325 52278 ;; --- current screen-offset
328 (defn exp-item-list []
329 (clojure.pprint/pprint
330 (apply harmonic-compare
331 (map read-state
332 ["up-1" "down-1"
333 "up-2" "down-2"
334 "up-3" "down-3"
335 "up-4" "down-4"
336 "up-5" "down-5"
337 "up-6"]))))
340 ;; turns out that these addresses are the cursor position
341 ;; for all lists in the game (start list, pokemon list, shop
342 ;; lists, inventory lists, battle list, basically
343 ;; everything!)
345 (def list-cursor-offset-address 52262)
346 (def list-screen-offset-address 52278)
348 (defn list-offset
349 ([^SaveState state]
350 (let [mem (memory state)]
351 (+ (aget mem list-screen-offset-address)
352 (aget mem list-cursor-offset-address))))
353 ([] (list-offset @current-state)))
357 (defn exp-item-selection []
358 (clojure.pprint/pprint
359 (apply memory-compare
360 (map read-state
361 ["1-item"
362 "2-items"
363 "3-items"
364 "4-items"
365 ]))))
367 (def item-quantity-selected-address 65432)
369 (defn item-quantity-selected
370 ([^SaveState state]
371 (println "items:" (aget (memory state) item-quantity-selected-address))
372 (aget (memory state) item-quantity-selected-address))
373 ([] (item-quantity-selected @current-state)))
375 (defn set-cursor-relative
376 "Assumes the arrow keys currently control the cursor.
377 Moves the cursor n steps relative to its current
378 position."
379 [n script]
380 (let [key (if (< 0 n) ↓ ↑)]
381 (multiple-times
382 (Math/abs n)
383 (partial first-difference
384 [] key list-offset)
385 script)))
387 (defn set-cursor
388 "Assumes the arrow keys currently control the cursor. Sets
389 the cursor to the desired position. Works for any menu
390 that uses a cursor including the start menu, item menu,
391 pokemon menu, and battle menu."
392 [n [moves state :as script]]
393 (let [current-position (list-offset state)
394 difference (- n current-position)]
395 (println difference)
396 (set-cursor-relative difference script)))
398 (defn set-quantity
399 "Set the quantity of an item to buy or sell to the desired value
400 using the fewest possible button presses."
401 ([total-quantity desired-quantity [moves state :as script]]
402 (let [current-quantity (item-quantity-selected state)
403 loop-point (if (> total-quantity 99) 0xFF 99)
404 distance (- desired-quantity current-quantity)
405 loop-distance (int(* -1 (Math/signum (float distance))
406 (- loop-point (Math/abs distance))))
407 best-path (first (sort-by #(Math/abs %)
408 [distance loop-distance]))
409 direction (if (< 0 best-path) ↑ ↓)]
410 (println "best-path" best-path)
411 (reduce
412 (fn [script _]
413 (delayed-difference [] direction 5 item-quantity-selected
414 script))
416 script
417 (range (Math/abs best-path)))))
418 ([desired-quantity [moves state :as script]]
419 (set-quantity 99 desired-quantity script)))
421 (defn activate-start-menu [script]
422 (first-difference [:b] [:b :start] AF script))
424 (defn-memo do-save-corruption
425 ([] (do-save-corruption
426 (walk-to-counter)))
427 ([script]
428 (->> script
429 activate-start-menu
430 (set-cursor 4)
431 select-menu-entry
432 select-menu-entry
433 (play-moves
434 ;; this section is copied from speedrun-2942 and corrupts
435 ;; the save so that the total number of pokemon is set to
436 ;; 0xFF, allowing manipulation of non-pokemon data in RAM
437 ;; via the pokemon interface.
438 [[] [] [] [] [] [] [] [] [] [] [] [] [] [] [] [] [] [] []
439 [] [] [] [] [] [] [] [] [] [] [] [:select] [:restart]])
440 (title)
441 (first-difference [] [:start] AF)
442 (first-difference [] [:a] AF))))
444 (defn gen-corrupted-checkpoint! []
445 (let [[cor-moves cor-save] (do-save-corruption)]
446 (write-moves! cor-moves "cor-checkpoint")
447 (write-state! cor-save "cor-checkpoint")))
449 (defn corrupted-checkpoint []
450 [(read-moves "cor-checkpoint")
451 (read-state "cor-checkpoint")])
453 (def menu do-nothing )
455 (defn close-menu [script]
456 (first-difference [] [:b] AF script))
458 (defn wait-until [script-fn script]
459 (let [wait-time
460 (- (dec (count (first (script-fn script))))
461 (count (first script)))]
462 (println "wait-time" wait-time)
463 (do-nothing wait-time script)))
465 ;; (defn select-menu-entry* [script]
466 ;; (let [wait-time
467 ;; (- (dec (count (first (set-cursor-relative 1 script))))
468 ;; (count (first script)))]
469 ;; (println "wait-time" wait-time)
470 ;; (play-moves (concat (repeat wait-time []) [[:a] []]) script)))
472 (defn select-menu-entry [script]
473 (->> script
474 (wait-until (partial set-cursor-relative 1))
475 (play-moves [[:a] []])))
477 (defn purchase-item
478 "Assumes that the cursor is over the desired item, and purchases
479 quantity of that item."
480 [n script]
481 (->> script
482 select-menu-entry
483 (set-quantity n)
484 (first-difference [] [:a] AF)
485 scroll-text
486 select-menu-entry
487 scroll-text))
489 (defn-memo corrupt-item-list
490 "Corrupt the num-of-items variable by switching a corrupted pokemon
491 into out-of-bounds memory."
492 ([] (corrupt-item-list
493 ;;(corrupted-checkpoint)
494 (do-save-corruption)
495 ))
496 ([script]
497 (->> script
498 activate-start-menu
499 (set-cursor 1) ; select "POKEMON" from
500 select-menu-entry ; from main menu.
501 (set-cursor 5) ; select 6th pokemon
502 select-menu-entry
503 (set-cursor 1)
504 select-menu-entry
505 (repeat-until-different [] list-offset)
506 (set-cursor 9)
507 select-menu-entry ; switch 6th with 10th
508 close-menu
509 close-menu)))
511 (defn-memo get-lots-of-money
512 "Sell 0xFE cancel buttons to make a tremendous amount of money."
513 ([] (get-lots-of-money (corrupt-item-list)))
514 ([script]
515 (->> script
516 (first-difference [] [:a] AF) ; talk to shopkeep
517 (repeat-until-different [] list-offset)
518 (set-cursor 1)
519 select-menu-entry
520 (repeat-until-different [] list-offset)
521 select-menu-entry
522 (set-quantity 0xFF 0xFE)
523 (scroll-text)
524 select-menu-entry)))
526 (defn note [str script]
527 (println str) script)
529 (defn-memo buy-bootstrapping-items
530 "Buy items that will become part of the bootstrapping
531 program."
532 ([] (buy-bootstrapping-items (get-lots-of-money)))
533 ([script]
534 (->> script
535 close-menu
536 select-menu-entry
537 (purchase-item 1) ; buying a pokeball overflows
538 ; the item-counter from 0xFF to 0x00
539 ; repairing the item-list.
540 (set-cursor 1)
541 (purchase-item 1) ; these other items are here to
542 ; protect the burn heals when the
543 (set-cursor 2) ; item list is corrupted again.
544 (purchase-item 1)
546 (set-cursor 3)
547 (purchase-item 1)
549 (set-cursor 4) ; 95 burn-heals spells out the
550 (purchase-item 96) ; return address to the pokemon
551 ; kernel. 96 so that they can be
552 ; deposited without causing a shift.
554 close-menu ; stop talking to shopkeep
555 (wait-until select-menu-entry)
556 (play-moves [[:b]])
557 end-text)))
559 (defn-memo corrupt-item-list-again
560 ([] (corrupt-item-list-again (buy-bootstrapping-items)))
561 ([script]
562 (->> script
563 activate-start-menu
564 (set-cursor-relative 0)
565 select-menu-entry
567 ;; repair list-offset for pokemon-list
568 (set-cursor-relative -1)
570 (set-cursor 4) ; switching it to
571 select-menu-entry ; tenth place.
572 (set-cursor 1)
573 select-menu-entry ; select "switch" on 5th
575 (repeat-until-different [] list-offset)
576 (set-cursor 9) ; goto 10th pokemon
577 select-menu-entry ; do switch
578 close-menu
579 close-menu)))
581 (defn-memo viridian-store->viridian-poke-center
582 ([] (viridian-store->viridian-poke-center
583 (corrupt-item-list-again)))
584 ([script]
585 (->> script
586 ;; leave store
587 (walk [↓ ↓
588 → ↓ ↓])
589 (walk [← ← ←
590 ↓ ↓ ↓ ↓ ↓
591 ← ← ← ↑]))))
593 (defn-memo to-poke-center-computer
594 ([] (to-poke-center-computer
595 (viridian-store->viridian-poke-center)))
596 ([script]
597 (->> script
598 (walk [→ →
599 ↑ ↑ ↑
600 → → → → → → → → →])
601 (do-nothing 1))))
603 (defn-memo begin-deposits
604 ([] (begin-deposits
605 (to-poke-center-computer)))
606 ([script]
607 (->> script
608 ;; access PC
609 (scroll-text 2)
611 ;; access item storage
612 (menu [[:a] [:d] [:a]])
613 (scroll-text 2)
615 ;; begin deposit
616 (menu [[:d] [:a]])
617 (do-nothing 40))))
619 (defn deposit-n-items
620 [n script]
621 (->> script
622 (do-nothing 100)
623 (play-moves [[:a]])
624 (do-nothing 80)
625 (multiple-times
626 (dec n)
627 (fn [script]
628 (->> script
629 (play-moves [[:u]])
630 (do-nothing 1))))
631 (play-moves [[:a]])
632 (scroll-text)))
634 (defn deposit-one-item
635 [script]
636 (->> script
637 (do-nothing 100)
638 (play-moves [[:a]])
639 (do-nothing 80)
640 (play-moves [[:a]])
641 (scroll-text)))
643 (defn-memo create-header
644 ([] (create-header (begin-deposits)))
645 ([script]
646 (->> script
647 (multiple-times 33 deposit-one-item)
648 (do-nothing 1))))
650 (defn bootstrap-init []
651 [(read-moves "bootstrap-init")
652 (read-state "bootstrap-init")])
654 (defn create-bootstrap-program
655 ([] (create-bootstrap-program
656 (create-header)))
657 ([script]
658 (->> script
659 (do-nothing 120)
660 (menu [↓ ↓ ↓ ↓ ↓ ↓ ↓])
661 ;;(deposit-n-items 33)
663 (menu (repeat 17 ↓))
667 (do-nothing 1))))
670 (defn test-pc-item-program []
671 (-> (read-state "bootstrap-init")
672 (set-memory pc-item-list-start 50)
673 (set-memory-range
674 map-function-address-start [0x8B 0xD5])
675 (set-memory-range
676 (inc pc-item-list-start)
677 (flatten
678 [(repeat
679 28
680 [0xFF 0x01])
681 [;; second part of item manipulation program
682 0x00 ;; this starts at address 0xD56C
683 0x2A ;; save (HL)=(target) to A, increment HL
685 0x00
686 0x47 ;; save A to B
688 0x00
689 0x3A ;; save (target+1) to A, decrement HL
691 0x00
692 0x22 ;; A -> target, increment HL [(target+1) -> target]
694 0x00
695 0x70 ;; load B into target+1 [(target) -> target+1]
697 0x00
698 0xC3 ;; first part of absolute jump
700 0x0C ;; return control to pokemon kernel
701 0x5F]
702 (repeat
703 5
704 [0xFF 0x01])
706 [;; first part of item manipulation program
707 0x00
708 0x21 ;; load target into HL
710 0x94 ;; this is the target address
711 0xD5
713 0x00 ;; relative jump back to first part
714 0x18
716 0xE1 ;; of program
717 0x01
719 0xFF ;; spacer
720 0x01
722 0x04 ;; target ID (pokeball)
723 0x3E ;; target Quantity (lemonade)
724 ]]))))