(ns com.aurellem.gb.hxc

   (:use (com.aurellem.gb assembly characters gb-driver util

                          constants species))

   (:use (com.aurellem.world practice))

   (:import [com.aurellem.gb.gb_driver SaveState]))

 

 

 

 

 ; ************* HANDWRITTEN CONSTANTS

 

 

 

 (defn low-high

   [low high]

   (+ low (* 256 high)))

   

 

 (defn format-name

   "Convert the string of alphabetic/space characters into a keyword by

   replacing spaces with hyphens and converting to lowercase."

   [s]

   (if (nil? s) nil

   (keyword (.toLowerCase

             (apply str

                    (map #(if (= % \space) "-" %) s))))))

 

 

 ;; used to decode item prices

 

 (defn decode-bcd

   "Take a sequence of binary-coded digits (in written order) and return the number they represent."

   [digits]

   ((fn self [coll]

      (if (empty? coll) 0

          (+ (first coll) (* 100 (self (rest coll))))))

    (map

     #(+ (* 10 (int (/ % 16)))

         (rem % 16))

     (reverse digits))))

 

 

   

 

 (def pkmn-types

   [:normal    ;;0

    :fighting  ;;1

    :flying    ;;2

    :poison    ;;3

    :ground    ;;4

    :rock      ;;5

    :bird      ;;6

    :bug       ;;7

    :ghost     ;;8

    :A

    :B

    :C

    :D

    :E

    :F

    :G

    :H

    :I

    :J

    :K

    :fire     ;;20 (0x14)

    :water    ;;21 (0x15)

    :grass    ;;22 (0x16)

    :electric ;;23 (0x17)

    :psychic  ;;24 (0x18)

    :ice      ;;25 (0x19)

    :dragon   ;;26 (0x1A)

    ])

 

 

 ;; question: when status effects claim to take

 ;; their accuracy from the move accuracy, does

 ;; this mean that the move always "hits" but the

 ;; status effect may not?

 

 (def move-effects

   ["normal damage"

    "no damage, just opponent sleep" ;; how many turns? is atk power ignored?

    "0x4C chance of poison"

    "leech half of inflicted damage"

    "0x19 chance of burn"

    "0x19 chance of freeze"

    "0x19 chance of paralyze"

    "user faints; opponent defense halved during attack."

    "leech half of inflicted damage ONLY if sleeping opponent."

    "imitate last attack"

    "user atk +1"

    "user def +1"

    "user spd +1"

    "user spc +1"

    "user acr +1" ;; unused?!

    "user evd +1"

    "get post-battle $ = 2*level*uses"

    "0xFE acr, no matter what."

    "opponent atk -1"     ;; acr taken from move acr?

    "opponent def -1"     ;;

    "opponent spd -1"   ;;

    "opponent spc -1" ;;

    "opponent acr -1";;

    "opponent evd -1"

    "converts user's type to opponent's."

    "(haze)"

    "(bide)"

    "(thrash)"

    "(teleport)"

    "(fury swipes)"

    "attacks 2-5 turns" ;; unused? like rollout?

    "0x19 chance of flinch"

    "opponent sleep for 1-7 turns"

    "0x66 chance of poison"

    "0x4D chance of burn"

    "0x4D chance of freeze"

    "0x4D chance of paralyze"

    "0x4D chance of flinch"

    "one-hit KO"

    "charge one turn, atk next."

    "fixed damage, leaves 1HP." ;; how is dmg determined?

    "fixed damage."             ;; cf seismic toss, dragon rage, psywave.

    "atk 2-5 turns; opponent can't attack" ;; unnormalized? (0 0x60 0x60 0x20 0x20)

    "charge one turn, atk next. (can't be hit when charging)"

    "atk hits twice."

    "user takes 1 damage if misses."

    "evade status-lowering effects" ;;caused by you or also your opponent?

    "(broken) if user is slower than opponent, makes critical hit impossible, otherwise has no effect"

    "atk causes recoil dmg = 1/4 dmg dealt"

    "confuses opponent" ;; acr taken from move acr

    "user atk +2"

    "user def +2"

    "user spd +2"

    "user spc +2"

    "user acr +2" ;; unused!

    "user evd +2" ;; unused!

    "restores up to half of user's max hp." ;; broken: fails if the difference

    ;; b/w max and current hp is one less than a multiple of 256.

    "(transform)"

    "opponent atk -2"

    "opponent def -2"

    "opponent spd -2"

    "opponent spc -2"

    "opponent acr -2"

    "opponent evd -2"

    "doubles user spc when attacked"

    "doubles user def when attacked"

    "just poisons opponent"   ;;acr taken from move acr

    "just paralyzes opponent" ;;

    "0x19 chance opponent atk -1"

    "0x19 chance opponent def -1"

    "0x19 chance opponent spd -1"

    "0x4C chance opponent spc -1" ;; context suggest chance is 0x19

    "0x19 chance opponent acr -1"

    "0x19 chance opponent evd -1"

    "???" ;; unused? no effect?

    "???" ;; unused? no effect?

    "0x19 chance opponent confused"

    "atk hits twice. 0x33 chance opponent poisioned."

    "broken. crash the game after attack."

    "(substitute)"

    "unless opponent faints, user must recharge after atk. some

   exceptions apply."

    "(rage)"

    "(mimic)"

    "(metronome)"

    "(leech seed)"

    "does nothing (splash)"

    "(disable)"

    ])

 

 

 ;; ************** HARDCODED DATA

 

 (defn hxc-thunk

   "Creates a thunk (nullary fn) that grabs data in a certain region of rom and

 splits it into a collection by 0x50. If rom is not supplied, uses the

   original rom data."

   [start length]

   (fn self

     ([rom]

        (take-nth 2

                  (partition-by #(= % 0x50)

                                (take length

                                      (drop start rom)))))

     ([]

       (self com.aurellem.gb.gb-driver/original-rom))))

 

 (def hxc-thunk-words

   "Same as hxc-thunk, except it interprets the rom data as characters,

   returning a collection of strings."

   (comp

    (partial comp (partial map character-codes->str))

    hxc-thunk))

 

 

 ;; --------------------------------------------------

 

 (def hxc-items

   "The hardcoded names of the items in memory. List begins at

 ROM@045B7"

   (hxc-thunk-words 0x45B7 870))

 

 (def hxc-types

   "The hardcoded type names in memory. List begins at ROM@27D99,

   shortly before hxc-titles."

   (hxc-thunk-words 0x27D99 102))

 

 (def hxc-titles

   "The hardcoded names of the trainer titles in memory. List begins at

 ROM@27E77"

   (hxc-thunk-words 0x27E77 196))

 

 

 (def hxc-pokedex-text*

   "The hardcoded pokedex entries in memory. List begins at

 ROM@B8000, shortly before move names."

   (hxc-thunk-words 0xB8000 14754))

 

 (defn hxc-pokedex-text

   "The hardcoded pokedex entries in memory, presented as an

 associative hash map. List begins at ROM@B8000."

   ([] (hxc-pokedex-text com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (zipmap

       (hxc-pokedex-names rom)

       (cons nil ;; for missingno.

             (hxc-pokedex-text* rom)))))

 

 ;; In red/blue, pokedex stats are in internal order.

 ;; In yellow, pokedex stats are in pokedex order.

 

 (defn hxc-pokedex-stats

   "The hardcoded pokedex stats (species height weight) in memory. List

 begins at ROM@40687"

   ;; uses hxc-pokedex-text to count pokemon

   ;; since hxc-pokenames includes several missingno"

   ([] (hxc-pokedex-stats com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [poketext (hxc-pokedex-text rom)

            pkmn-count (count poketext)

            pokedex-names (zipmap (range) (hxc-pokedex-names rom))

            ]

      ((fn capture-stats

         [n stats data]

         (if (zero? n) stats

             (let [[species

                    [_

                     height-ft

                     height-in

                     weight-1

                     weight-2

                     _

                     dex-ptr-1

                     dex-ptr-2

                     dex-bank

                     _

                     & data]]

                   (split-with (partial not= 0x50) data)]

               (recur (dec n)

                      (assoc stats

                        (pokedex-names (- pkmn-count (dec n)))

                        {:species

                         (format-name (character-codes->str species))

                         :height-ft

                         height-ft

                         :height-in

                         height-in

                         :weight

                         (/ (low-high weight-1 weight-2) 10.)

                         

                     ;;    :text

                     ;;    (character-codes->str

                     ;;     (take-while

                     ;;      (partial not= 0x50)

                     ;;      (drop

                     ;;       (+ 0xB8000

                     ;;          -0x4000

                     ;;          (low-high dex-ptr-1 dex-ptr-2))

                     ;;       rom)))

                         })

                      

                      data)

               

               

               )))

       

       pkmn-count

       {}

       (drop 0x40687 rom)))       ))

 

 

 

 

 

 

 

 (def hxc-places

   "The hardcoded place names in memory. List begins at

 ROM@71500. [Cinnabar] Mansion seems to be dynamically calculated."

   (hxc-thunk-words 0x71500 560))

 

 

 (defn hxc-dialog

   "The hardcoded dialogue in memory, including in-game alerts. Dialog

   seems to be separated by 0x57 instead of 0x50 (END). Begins at ROM@98000."

   ([rom]

      (map character-codes->str

           (take-nth 2

                     (partition-by #(= % 0x57)

                                   (take 0x0F728

                                         (drop 0x98000 rom))))))

   ([]

      (hxc-dialog com.aurellem.gb.gb-driver/original-rom)))

 

 

 (def hxc-move-names

   "The hardcoded move names in memory. List begins at ROM@BC000"

   (hxc-thunk-words 0xBC000 1551))

 

 

 (defn hxc-move-data

   "The hardcoded (basic (move effects)) in memory. List begins at

 0x38000. Returns a map of {:name :power :accuracy :pp :fx-id

   :fx-txt}. The move descriptions are handwritten, not hardcoded."

   ([]

      (hxc-move-data com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [names (vec (hxc-move-names rom))

            move-count (count names)

            move-size 6

            types pkmn-types ;;; !! hardcoded types

            ]

        (zipmap (map format-name names)

                (map

                 (fn [[idx effect power type-id accuracy pp]]

                   {:name (names (dec idx))

                    :power power

                    :accuracy  accuracy

                    :pp pp

                    :type (types type-id)

                    :fx-id effect

                    :fx-txt (get move-effects effect) 

                    }

                   )

                 

                 (partition move-size

                            (take (* move-size move-count)

                                  (drop 0x38000 rom))))))))

   

 

 

 (defn hxc-move-data*

   "Like hxc-move-data, but reports numbers as hexadecimal symbols instead."

   ([]

      (hxc-move-data* com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [names (vec (hxc-move-names rom))

            move-count (count names)

            move-size 6

            format-name (fn [s]

                          (keyword (.toLowerCase

                                    (apply str

                                           (map #(if (= % \space) "-" %) s)))))

            ]

        (zipmap (map format-name names)

                (map

                 (fn [[idx effect power type accuracy pp]]

                   {:name (names (dec idx))

                    :power power

                    :accuracy (hex accuracy)

                    :pp pp

                    :fx-id (hex effect)

                    :fx-txt (get move-effects effect) 

                    }

                   )

                 

                 (partition move-size

                            (take (* move-size move-count)

                                  (drop 0x38000 rom))))))))

   

 

 (defn hxc-machines

   "The hardcoded moves taught by TMs and HMs. List begins at ROM@0x1232D."

   ([] (hxc-machines

        com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [moves (hxc-move-names rom)]

        (zipmap

         (range)

         (take-while

             (comp not nil?)

             (map (comp

                   format-name

                   (zipmap

                    (range)

                    moves)

               dec)

                  (take 100

                        (drop 0x1232D rom))))))))

   

 (defn hxc-pokenames

   "The hardcoded names of the 190 species in memory. List begins at

 ROM@E8000. Although names in memory are padded with 0x50 to be 10 characters

   long, these names are stripped of padding. See also, hxc-pokedex-names"

   ([]

      (hxc-pokenames com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [count-species 190

            name-length 10]

        (map character-codes->str

             (partition name-length

                        (map #(if (= 0x50 %) 0x00 %)

                             (take (* count-species name-length)

                                   (drop 0xE8000

                                         rom))))))))

 

 

 

 (defn hxc-pokedex-names

   "The names of the pokemon in hardcoded pokedex order. List begins at

 ROM@410B1. See also, hxc-pokenames."

   ([] (hxc-pokedex-names

        com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [names (hxc-pokenames rom)]

        (#(mapv %

                ((comp range count keys) %))

         (zipmap

          (take (count names)

                (drop 0x410b1 rom))

          

          (map format-name names))))))

 

 

 

 (defn internal-id

   ([rom]

      (zipmap 

       (map format-name (hxc-pokenames rom))

       (range)))

   ([]

      (internal-id com.aurellem.gb.gb-driver/original-rom)))

 

 

 

 

 

 ;; nidoran gender change upon levelup

 ;; (->

 ;;  @current-state

 ;;  rom

 ;;  vec

 ;;  (rewrite-memory

 ;;   (nth (hxc-ptrs-evolve) ((internal-id) :nidoran♂))

 ;;   [1 1 15])

 ;;  (rewrite-memory

 ;;   (nth (hxc-ptrs-evolve) ((internal-id) :nidoran♀))

 ;;   [1 1 3])

 ;;  (write-rom!)

 

 ;;  )

 

 

 

 

 (defn hxc-advantage

   "The hardcoded type advantages in memory, returned as tuples of atk-type def-type multiplier. By default (i.e. if not listed here),

 the multiplier is 1."

   ([] (hxc-advantage com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (map

       (fn [[atk def mult]] [(get pkmn-types atk (hex atk))

                             (get pkmn-types def (hex def))

                             (/ mult 10)])

       (partition 3

                  (take-while (partial not= 0xFF)

                              (drop 0x3E62D rom))))))

 

 

 

 (defn format-evo

   [coll]

   (let [method (first coll)]

     (cond (empty? coll) []

           (= 0 method) [] ;; just in case

           (= 1 method) ;; level-up evolution

           (conj (format-evo (drop 3 coll))

                             {:method :level-up

                              :min-level (nth coll 1)

                              :into (dec (nth coll 2))})

           

           (= 2 method) ;; item evolution

           (conj (format-evo (drop 4 coll))

                 {:method :item

                  :item (dec (nth coll 1))

                  :min-level (nth coll 2)

                  :into (dec (nth coll 3))})

 

           (= 3 method) ;; trade evolution

           (conj (format-evo (drop 3 coll))

                 {:method :trade

                  :min-level (nth coll 1) ;; always 1 for trade.

                  :into (dec (nth coll 2))}))))

 

 

 (defn hxc-ptrs-evolve

   "A hardcoded collection of 190 pointers to alternating evolution/learnset data,

 in internal order."

   ([]

      (hxc-ptrs-evolve com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [names (hxc-pokenames rom)

            pkmn-count (count names)

            ptrs

            (map (fn [[a b]] (low-high a b))

                 (partition 2

                            (take (* 2 pkmn-count)

                                  (drop 0x3b1e5 rom))))]

        (map (partial + 0x34000) ptrs)

 

        )))

 

 

 (defn hxc-learnsets

   "Hardcoded map associating pokemon names to lists of pairs [lvl

   move] of abilities they learn as they level up. The data

 exists at ROM@3400, sorted by internal order. Pointers to the data

   exist at ROM@3B1E5; see also, hxc-ptrs-evolve"

   ([] (hxc-learnsets com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (apply assoc

             {}

             (interleave

              (map format-name (hxc-pokenames rom))

              (map (comp

                    (partial map

                             (fn [[lvl mv]] [lvl (dec mv)]))

                    (partial partition 2)

                    ;; keep the learnset data

                    (partial take-while (comp not zero?))

                    ;; skip the evolution data

                    rest

                    (partial drop-while (comp not zero?)))

                   (map #(drop % rom) 

                        (hxc-ptrs-evolve rom)))))))

 

 (defn hxc-learnsets-pretty

   "Live hxc-learnsets except it reports the name of each move --- as

 it appears in rom --- rather than the move index."

   ([] (hxc-learnsets-pretty com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [moves (vec(map format-name (hxc-move-names)))]

        (into {}

              (map (fn [[pkmn learnset]]

                     [pkmn (map (fn [[lvl mv]] [lvl (moves mv)])

                                learnset)])

                   (hxc-learnsets rom))))))

              

                                   

 

 

 (defn hxc-evolution

   "Hardcoded evolution data in memory. The data exists at ROM@34000,

   sorted by internal order. Pointers to the data exist at ROM@3B1E5; see also, hxc-ptrs-evolve."

   ([] (hxc-evolution com.aurellem.gb.gb-driver/original-rom))

   ([rom]

        (apply assoc {}

                (interleave

                 (map format-name (hxc-pokenames rom))

                 (map

                  (comp

                   format-evo

                   (partial take-while (comp not zero?))

                   #(drop % rom))

                  (hxc-ptrs-evolve rom)

                  )))))

 

 (defn hxc-evolution-pretty

   "Like hxc-evolution, except it uses the names of items and pokemon

 --- grabbed from ROM --- rather than their numerical identifiers."

   ([] (hxc-evolution-pretty com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let

          [poke-names (vec (map format-name (hxc-pokenames rom)))

           item-names (vec (map format-name (hxc-items rom)))

           use-names

           (fn [m]

             (loop [ks (keys m) new-map m]

               (let [k (first ks)]

                 (cond (nil? ks) new-map

                       (= k :into)

                       (recur

                        (next ks)

                        (assoc new-map

                          :into

                          (poke-names

                           (:into

                            new-map))))

                       (= k :item)

                       (recur

                        (next ks)

                        (assoc new-map

                          :item

                          (item-names

                           (:item new-map))))

                       :else

                       (recur

                        (next ks)

                        new-map)

                       ))))]

 

        (into {}

              (map (fn [[pkmn evo-coll]]

                     [pkmn (map use-names evo-coll)])

                   (hxc-evolution rom))))))

        

 

 

 

 

 (defn hxc-pokemon-base

   ([] (hxc-pokemon-base com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [entry-size 28

            pkmn-count (count (hxc-pokedex-text rom))

            pokemon (rest (hxc-pokedex-names))

            types (apply assoc {}

                         (interleave

                          (range)

                          pkmn-types)) ;;!! softcoded

            moves (apply assoc {}

                         (interleave

                          (range)

                          (map format-name

                               (hxc-move-names rom))))

            ]

        (zipmap

         pokemon

         (map

          (fn [[n

                rating-hp

                rating-atk

                rating-def

                rating-speed

                rating-special

                type-1

                type-2

                rarity

                rating-xp

                pic-dimensions ;; tile_width|tile_height (8px/tile)

                ptr-pic-obverse-1

                ptr-pic-obverse-2

                ptr-pic-reverse-1

                ptr-pic-reverse-2

                move-1

                move-2

                move-3

                move-4

                growth-rate

                &

                TMs|HMs]]

            (let

                [base-moves

                 (mapv moves

                       ((comp

                         ;; since the game uses zero as a delimiter,

                         ;; it must also increment all move indices by 1.

                         ;; heren we decrement to correct this.

                         (partial map dec)

                         (partial take-while (comp not zero?)))

                        [move-1 move-2 move-3 move-4]))

                 

                 types

                 (set (list (types type-1)

                            (types type-2)))

                 TMs|HMs

                 (map

                  (comp

                   (partial map first)

                   (partial remove (comp zero? second)))

                  (split-at

                   50

                   (map vector

                        (rest(range))

                        (reduce concat

                                (map

                                 #(take 8

                                        (concat (bit-list %)

                                                (repeat 0)))

                                 

                                 TMs|HMs)))))

                 

                 TMs  (vec (first TMs|HMs))

                 HMs (take 5 (map (partial + -50) (vec (second TMs|HMs))))

                 

                 

                 ]

              

              

              {:dex# n

               :base-moves base-moves

               :types types

               :TMs TMs

               :HMs HMs

               :base-hp rating-hp

               :base-atk rating-atk

               :base-def rating-def

               :base-speed rating-speed

               :base-special rating-special

               }))

          

          (partition entry-size

                     (take (* entry-size pkmn-count)

                           (drop 0x383DE

                                 rom))))))))

   

   

   

 (defn hxc-item-prices

   "The hardcoded list of item prices in memory. List begins at ROM@4495"

   ([] (hxc-item-prices com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [items (map format-name (hxc-items rom))

            price-size 3]

        (zipmap items

                (map (comp

                      ;; zero-cost items are "priceless"

                      #(if (zero? %) :priceless %)

                      decode-bcd butlast)

                     (partition price-size

                                (take (* price-size (count items))

                                      (drop 0x4495 rom))))))))

 

 (defn hxc-shops

   ([] (hxc-shops com.aurellem.gb.gb-driver/original-rom))

   ([rom]

      (let [items (zipmap (range) (map format-name (hxc-items rom)))

 

            ;; temporarily softcode the TM items

            items (into

                   items

                   (map (juxt identity

                              (comp keyword

                                    (partial str "tm-")

                                    (partial + 1 -200)

                                    )) 

                        (take 200 (drop 200 (range)))))

                        

            ]

 

        ((fn parse-shop [coll [num-items & items-etc]]

           (let [inventory (take-while

                            (partial not= 0xFF)

                            items-etc)

                [separator & items-etc] (drop num-items (rest items-etc))]

            (if (= separator 0x50)

              (map (partial mapv (comp items dec)) (conj coll inventory))

              (recur (conj coll inventory) items-etc)

              )

          ))

 

         '()

         (drop 0x233C rom))

 

      

      )))

 

 

 

 ;; ********************** MANIPULATION FNS

 

 

 (defn same-type

   ([pkmn move]

      (same-type?

       com.aurellem.gb.gb-driver/original-rom pkmn move))

   ([rom pkmn move]

      (((comp :types (hxc-pokemon-base rom)) pkmn)

       ((comp :type (hxc-move-data rom)) move))))

 

 

 

 

 (defn submap?

   "Compares the two maps. Returns true if map-big has the same associations as map-small, otherwise false." 

   [map-small map-big]

   (cond (empty? map-small) true

         (and

          (contains? map-big (ffirst map-small))

          (= (get map-big (ffirst map-small))

             (second (first map-small))))

         (recur (next map-small) map-big)

 

         :else false))  

 

 

 (defn search-map [proto-map maps]

   "Returns all the maps that make the same associations as proto-map."

   (some (partial submap? proto-map) maps))

 

 (defn filter-vals

   "Returns a map consisting of all the pairs [key val] for

   which (pred key) returns true."

   [pred map]

   (reduce (partial apply assoc) {}

           (filter (fn [[k v]] (pred v)) map)))

 

 

 (defn search-moves

   "Returns a subcollection of all hardcoded moves with the

   given attributes. Attributes consist of :name :power

   :accuracy :pp :fx-id

   (and also :fx-txt, but it contains the same information

   as :fx-id)"

   ([attribute-map]

      (search-moves

       com.aurellem.gb.gb-driver/original-rom attribute-map))

   ([rom attribute-map]

      (filter-vals (partial submap? attribute-map)

                   (hxc-move-data rom))))

 

 

 

 

 

 ;; note: 0x2f31 contains the names "TM" "HM"?

 

 ;; note for later: credits start at F1290

 

 

 

 (comment 

 

 (def hxc-later

   "Running this code produces, e.g. hardcoded names NPCs give

 their pokemon. Will sort through it later."

 (print (character-codes->str(take 10000

                           (drop 0x71597

                                 (rom (root)))))))

 

 (let [dex

       (partition-by #(= 0x50 %)

                     (take 2540

                           (drop 0x40687

                                 (rom (root)))))]

   (def dex dex)

   (def hxc-species

     (map character-codes->str

          (take-nth 4 dex))))

 )