Merge pull request #573 from mid-kid/master

 text_jump → text_far

docs/assembly_programming.md

@@ -4,16 +4,20 @@
    - [**GBZ80 instructions**][gbz80-instructions]: List of CPU instructions and their effects.
    - [**RGBASM features**][rgbasm-features]: How to use the assembler features: constants, labels, sections, macros, etc.
    - [**RGBLINK features**][rgblink-features]: How to use the linker, including the [pokecrystal.link](/pokecrystal.link) linkerscript.
+- [**ASMSchool**][asmschool]: A gameboy assembly tutorial.
+- [**GB ASM Tutorial**][gb-asm-tutorial]: A newer but still in-progress asm tutorial.
 - [**Pan Docs**][pan-docs]: Everything You Always Wanted To Know About GAMEBOY (but were afraid to ask).
 - [**GameBoy Programming Manual**][gb-manual]: The official GameBoy programming and hardware manual by Nintendo.
 - [**GameBoy Opcode Summary**][gb-opcodes]: Describes the opcodes of GameBoy assembly language.
 - [**GameBoy Memory Map**][gb-memory-map]: Describes the GameBoy Color address space.
 - [**awesome-gbdev**][awesome-gbdev]: A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.
 
-[rgbds-doc]: https://rednex.github.io/
+[rgbds-doc]: https://rednex.github.io/rgbds/
 [rgbasm-features]: https://rednex.github.io/rgbds/rgbasm.5.html
 [rgblink-features]: https://rednex.github.io/rgbds/rgblink.5.html
 [gbz80-instructions]: https://rednex.github.io/rgbds/gbz80.7.html
+[asmschool]: http://gameboy.mongenel.com/asmschool.html
+[gb-asm-tutorial]: https://eldred.fr/gb-asm-tutorial/
 [pan-docs]: http://bgb.bircd.org/pandocs.htm
 [gb-manual]: https://ia801906.us.archive.org/19/items/GameBoyProgManVer1.1/GameBoyProgManVer1.1.pdf
 [gb-opcodes]: http://www.devrs.com/gb/files/opcodes.html

engine/battle/ai/items.asm

@@ -708,7 +708,7 @@ AI_Switch:
 	ret
 
 TextJump_EnemyWithdrew:
-	text_jump Text_EnemyWithdrew
+	text_far Text_EnemyWithdrew
 	db "@"
 
 Function384d5: ; This appears to be unused
@@ -828,5 +828,5 @@ PrintText_UsedItemOn:
 	jp PrintText
 
 TextJump_EnemyUsedOn:
-	text_jump Text_EnemyUsedOn
+	text_far Text_EnemyUsedOn
 	db "@"

engine/battle/core.asm

@@ -7398,7 +7398,7 @@ BoostExp:
 	ret
 
 Text_MonGainedExpPoint:
-	text_jump Text_Gained
+	text_far Text_Gained
 	start_asm
 	ld hl, TextJump_StringBuffer2ExpPoints
 	ld a, [wStringBuffer2 + 2] ; IsTradedMon
@@ -7409,11 +7409,11 @@ Text_MonGainedExpPoint:
 	ret
 
 TextJump_ABoostedStringBuffer2ExpPoints:
-	text_jump Text_ABoostedStringBuffer2ExpPoints
+	text_far Text_ABoostedStringBuffer2ExpPoints
 	db "@"
 
 TextJump_StringBuffer2ExpPoints:
-	text_jump Text_StringBuffer2ExpPoints
+	text_far Text_StringBuffer2ExpPoints
 	db "@"
 
 AnimateExpBar:
@@ -7664,37 +7664,37 @@ SendOutMonText:
 	jp BattleTextBox
 
 JumpText_GoMon:
-	text_jump Text_GoMon
+	text_far Text_GoMon
 	start_asm
 	jr Function_TextJump_BattleMonNick01
 
 JumpText_DoItMon:
-	text_jump Text_DoItMon
+	text_far Text_DoItMon
 	start_asm
 	jr Function_TextJump_BattleMonNick01
 
 JumpText_GoForItMon:
-	text_jump Text_GoForItMon
+	text_far Text_GoForItMon
 	start_asm
 	jr Function_TextJump_BattleMonNick01
 
 JumpText_YourFoesWeakGetmMon:
-	text_jump Text_YourFoesWeakGetmMon
+	text_far Text_YourFoesWeakGetmMon
 	start_asm
 Function_TextJump_BattleMonNick01:
 	ld hl, TextJump_BattleMonNick01
 	ret
 
 TextJump_BattleMonNick01:
-	text_jump Text_BattleMonNick01
+	text_far Text_BattleMonNick01
 	db "@"
 
 WithdrawMonText:
 	ld hl, .WithdrawMonText
 	jp BattleTextBox
 
 .WithdrawMonText:
-	text_jump Text_BattleMonNickComma
+	text_far Text_BattleMonNickComma
 	start_asm
 ; Print text to withdraw mon
 ; depending on HP the message is different
@@ -7745,15 +7745,15 @@ WithdrawMonText:
 	ret
 
 TextJump_ThatsEnoughComeBack:
-	text_jump Text_ThatsEnoughComeBack
+	text_far Text_ThatsEnoughComeBack
 	db "@"
 
 TextJump_OKComeBack:
-	text_jump Text_OKComeBack
+	text_far Text_OKComeBack
 	db "@"
 
 TextJump_GoodComeBack:
-	text_jump Text_GoodComeBack
+	text_far Text_GoodComeBack
 	db "@"
 
 Unreferenced_TextJump_ComeBack:
@@ -7762,7 +7762,7 @@ Unreferenced_TextJump_ComeBack:
 	ret
 
 TextJump_ComeBack:
-	text_jump Text_ComeBack
+	text_far Text_ComeBack
 	db "@"
 
 Unreferenced_HandleSafariAngerEatingStatus:

engine/battle/effect_commands.asm

@@ -4542,7 +4542,7 @@ BattleCommand_StatUpMessage:
 	jp BattleTextBox
 
 .stat
-	text_jump UnknownText_0x1c0cc6
+	text_far UnknownText_0x1c0cc6
 	start_asm
 	ld hl, .up
 	ld a, [wLoweredStat]
@@ -4552,11 +4552,11 @@ BattleCommand_StatUpMessage:
 	ret
 
 .wayup
-	text_jump UnknownText_0x1c0cd0
+	text_far UnknownText_0x1c0cd0
 	db "@"
 
 .up
-	text_jump UnknownText_0x1c0ce0
+	text_far UnknownText_0x1c0ce0
 	db "@"
 
 BattleCommand_StatDownMessage:
@@ -4572,7 +4572,7 @@ BattleCommand_StatDownMessage:
 	jp BattleTextBox
 
 .stat
-	text_jump UnknownText_0x1c0ceb
+	text_far UnknownText_0x1c0ceb
 	start_asm
 	ld hl, .fell
 	ld a, [wLoweredStat]
@@ -4582,10 +4582,10 @@ BattleCommand_StatDownMessage:
 	ret
 
 .sharplyfell
-	text_jump UnknownText_0x1c0cf5
+	text_far UnknownText_0x1c0cf5
 	db "@"
 .fell
-	text_jump UnknownText_0x1c0d06
+	text_far UnknownText_0x1c0d06
 	db "@"
 
 TryLowerStat:
@@ -5636,7 +5636,7 @@ BattleCommand_Charge:
 	jp EndMoveEffect
 
 .UsedText:
-	text_jump UnknownText_0x1c0d0e ; "<USER>"
+	text_far UnknownText_0x1c0d0e ; "<USER>"
 	start_asm
 	ld a, BATTLE_VARS_MOVE_ANIM
 	call GetBattleVar
@@ -5668,32 +5668,32 @@ BattleCommand_Charge:
 
 .RazorWind:
 ; 'made a whirlwind!'
-	text_jump UnknownText_0x1c0d12
+	text_far UnknownText_0x1c0d12
 	db "@"
 
 .Solarbeam:
 ; 'took in sunlight!'
-	text_jump UnknownText_0x1c0d26
+	text_far UnknownText_0x1c0d26
 	db "@"
 
 .SkullBash:
 ; 'lowered its head!'
-	text_jump UnknownText_0x1c0d3a
+	text_far UnknownText_0x1c0d3a
 	db "@"
 
 .SkyAttack:
 ; 'is glowing!'
-	text_jump UnknownText_0x1c0d4e
+	text_far UnknownText_0x1c0d4e
 	db "@"
 
 .Fly:
 ; 'flew up high!'
-	text_jump UnknownText_0x1c0d5c
+	text_far UnknownText_0x1c0d5c
 	db "@"
 
 .Dig:
 ; 'dug a hole!'
-	text_jump UnknownText_0x1c0d6c
+	text_far UnknownText_0x1c0d6c
 	db "@"
 
 BattleCommand3c:

engine/battle/used_move_text.asm

@@ -6,7 +6,7 @@ DisplayUsedMoveText:
 
 UsedMoveText:
 ; this is a stream of text and asm from 105db9 to 105ef6
-	text_jump _ActorNameText
+	text_far _ActorNameText
 	start_asm
 	ldh a, [hBattleTurn]
 	and a
@@ -58,12 +58,12 @@ UsedMoveText:
 	ret
 
 UsedMove1Text:
-	text_jump _UsedMove1Text
+	text_far _UsedMove1Text
 	start_asm
 	jr UsedMoveText_CheckObedience
 
 UsedMove2Text:
-	text_jump _UsedMove2Text
+	text_far _UsedMove2Text
 	start_asm
 UsedMoveText_CheckObedience:
 ; check obedience
@@ -75,14 +75,14 @@ UsedMoveText_CheckObedience:
 	ret
 
 .UsedInsteadText:
-	text_jump _UsedInsteadText
+	text_far _UsedInsteadText
 	start_asm
 .GetMoveNameText:
 	ld hl, MoveNameText
 	ret
 
 MoveNameText:
-	text_jump _MoveNameText
+	text_far _MoveNameText
 	start_asm
 ; get start address
 	ld hl, .endusedmovetexts
@@ -115,19 +115,19 @@ MoveNameText:
 	dw EndUsedMove5Text
 
 EndUsedMove1Text:
-	text_jump _EndUsedMove1Text
+	text_far _EndUsedMove1Text
 	db "@"
 EndUsedMove2Text:
-	text_jump _EndUsedMove2Text
+	text_far _EndUsedMove2Text
 	db "@"
 EndUsedMove3Text:
-	text_jump _EndUsedMove3Text
+	text_far _EndUsedMove3Text
 	db "@"
 EndUsedMove4Text:
-	text_jump _EndUsedMove4Text
+	text_far _EndUsedMove4Text
 	db "@"
 EndUsedMove5Text:
-	text_jump _EndUsedMove5Text
+	text_far _EndUsedMove5Text
 	db "@"
 
 GetMoveGrammar:

engine/events/battle_tower/rules.asm

@@ -22,7 +22,7 @@ CheckForMobileBattleRules:
 
 .ExcuseMeText:
 	; Excuse me!
-	text_jump UnknownText_0x1c5937
+	text_far UnknownText_0x1c5937
 	db "@"
 
 _CheckForBattleTowerRules:
@@ -57,7 +57,7 @@ _CheckForBattleTowerRules:
 
 JumpText_ExcuseMeYoureNotReady:
 	; Excuse me. You're not ready.
-	text_jump Text_ExcuseMeYoureNotReady
+	text_far Text_ExcuseMeYoureNotReady
 	db "@"
 
 BattleTower_PleaseReturnWhenReady:
@@ -67,37 +67,37 @@ BattleTower_PleaseReturnWhenReady:
 
 .PleaseReturnWhenReady:
 	; Please return when you're ready.
-	text_jump UnknownText_0x1c5962
+	text_far UnknownText_0x1c5962
 	db "@"
 
 JumpText_NeedAtLeastThreeMon:
 	; You need at least three #MON.
-	text_jump UnknownText_0x1c5983
+	text_far UnknownText_0x1c5983
 	db "@"
 
 JumpText_EggDoesNotQualify:
 	; Sorry, an EGG doesn't qualify.
-	text_jump UnknownText_0x1c59a3
+	text_far UnknownText_0x1c59a3
 	db "@"
 
 JumpText_OnlyThreeMonMayBeEntered:
 	; Only three #MON may be entered.
-	text_jump Text_OnlyThreeMonMayBeEntered
+	text_far Text_OnlyThreeMonMayBeEntered
 	db "@"
 
 JumpText_TheMonMustAllBeDifferentKinds:
 	; The @  #MON must all be different kinds.
-	text_jump Text_TheMonMustAllBeDifferentKinds
+	text_far Text_TheMonMustAllBeDifferentKinds
 	db "@"
 
 JumpText_TheMonMustNotHoldTheSameItems:
 	; The @  #MON must not hold the same items.
-	text_jump Text_TheMonMustNotHoldTheSameItems
+	text_far Text_TheMonMustNotHoldTheSameItems
 	db "@"
 
 JumpText_YouCantTakeAnEgg:
 	; You can't take an EGG!
-	text_jump Text_YouCantTakeAnEgg
+	text_far Text_YouCantTakeAnEgg
 	db "@"
 
 BattleTower_ExecuteJumptable: