Reply to thread

Message

<blockquote data-quote="Mildanner" data-source="post: 6520" data-attributes="member: 7577">Original Guide by Mildanner (ft. RetroKoH)In game development, the developers didn&#039;t know how to make a simple scrolling HUD and decided to make the HUD pop in the screen without any doubts. In this guide, you will learn how to make a simple scrolling HUD.<h3>Hivebrain 2005 (ASM68K)</h3>In the Hivebrain 2005, the object for HUD was still in sonic1.asm file. You should find the Obj21_Main label and replace this entire routine with this:[CODE]Obj21_Main:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; XREF: Obj21_Main&nbsp; &nbsp; &nbsp; &nbsp; addq.b&nbsp; &nbsp; #4,$24(a0)&nbsp; &nbsp; ; Advance to Routine 4 (Obj21_Move) on the next frame&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #0,8(a0)&nbsp; &nbsp; ; Start offscreen (X = 0)&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #$108,$a(a0)&nbsp; &nbsp; ; Set Y coordinate (obScreenY)&nbsp; &nbsp; &nbsp; &nbsp; move.l&nbsp; &nbsp; #Map_obj21,4(a0); Set mappings pointer (obMap)&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #$6ca,2(a0)&nbsp; &nbsp; ; Set VRAM art tile (obGfx)&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #0,1(a0)&nbsp; &nbsp; ; Set render settings (obRender)&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #0,$18(a0)&nbsp; &nbsp; ; Set display priority (obPriority)&nbsp; &nbsp; &nbsp; &nbsp; rts; ===========================================================================Obj21_Move:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; Routine 4&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; 8(a0),d0&nbsp; &nbsp; ; Load current X position&nbsp; &nbsp; &nbsp; &nbsp; cmpi.w&nbsp; &nbsp; #$90,d0&nbsp; &nbsp; &nbsp; &nbsp; ; Has it reached position $90?&nbsp; &nbsp; &nbsp; &nbsp; bge.s&nbsp; &nbsp; @reached&nbsp; &nbsp; ; If greater or equal, finalize movement&nbsp; &nbsp; &nbsp; &nbsp; addq.w&nbsp; &nbsp; #5,d0&nbsp; &nbsp; &nbsp; &nbsp; ; Move 5 pixels to the right&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; d0,8(a0)&nbsp; &nbsp; ; Update X coordinate directly&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; DisplaySprite@reached:&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #2,$24(a0)&nbsp; &nbsp; ; Set routine status to Routine 2&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; DisplaySprite[/CODE]If the code doesn&#039;t work, you should go above Obj21_Index and after the line. Insert this (After the Obj21_Move label)[CODE]&nbsp; &nbsp; &nbsp; &nbsp; dc.w Obj21_Move-Obj21_Index[/CODE]Done! Now your hack has a fellow HUD scrolling.<h3>(OPTIONAL) Adding sound effect if HUD is in the position</h3>Hivebrain 2005 has no macros, so you should modify it simply and paste this in the label you pasted below @reached[CODE]&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #$C5,d0&nbsp; &nbsp; ;&nbsp; &nbsp; set sound to cash&nbsp; &nbsp; &nbsp; &nbsp; jsr&nbsp; &nbsp; (PlaySound_Special).l ;&nbsp; &nbsp; play it[/CODE]Okay, now it will play a sound once the HUD scrolling is completed.<h3>Hivebrain 2022</h3>Also, Hivebrain 2022 is a upgraded version of Hivebrain 2005 but better version and more documented by following the current version of Sonic 1 disassembly from Sonic Retro.In your disassembly, go to the Objects/HUD.asm and find the label HUD_Main:Replace the entire routine with this[CODE]HUD_Main:&nbsp; &nbsp; ; Routine 0&nbsp; &nbsp; &nbsp; &nbsp; addq.b&nbsp; &nbsp; #4,ost_routine(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Advance to Routine 4 (HUD_Move)&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #screen_left-80,ost_x_pos(a0)&nbsp; &nbsp; ; Start HUD far off-screen to the left&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #screen_top+136,ost_y_screen(a0) ; Set Y position coordinate&nbsp; &nbsp; &nbsp; &nbsp; move.l&nbsp; &nbsp; #Map_HUD,ost_mappings(a0)&nbsp; &nbsp; ; Set mappings pointer&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #tile_Nem_Hud,ost_tile(a0)&nbsp; &nbsp; ; Set art tile pattern index&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #render_abs,ost_render(a0)&nbsp; &nbsp; ; Use absolute rendering screen space&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #0,ost_priority(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Set sprite layout priority&nbsp; &nbsp; &nbsp; &nbsp; rtsHUD_Move:&nbsp; &nbsp; ; Routine 4&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; ost_x_pos(a0),d0&nbsp; &nbsp; &nbsp; &nbsp; ; Get current HUD X position&nbsp; &nbsp; &nbsp; &nbsp; cmpi.w&nbsp; &nbsp; #screen_left+16,d0&nbsp; &nbsp; &nbsp; &nbsp; ; Has it reached the classic target position ($10)?&nbsp; &nbsp; &nbsp; &nbsp; bge.s&nbsp; &nbsp; .reached&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; If yes, branch to lock movement&nbsp; &nbsp; &nbsp; &nbsp; addq.w&nbsp; &nbsp; #5,d0&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; Shift 5 pixels to the right&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; d0,ost_x_pos(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Update object X position&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; (DisplaySprite).l.reached:&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #2,ost_routine(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Set to static state routine (Routine 2 / HUD_Flash)&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; (DisplaySprite).l[/CODE]If there&#039;s a issue and it is not working, you should go below the pointer of HUD_Flash and insert this below the line.[CODE]&nbsp; &nbsp; &nbsp; &nbsp; ptr HUD_Move[/CODE]Done! Now your fellow HUD scrolling is now functional, enjoy your new HUD scrolling.(OPTIONAL) Adding sound effect if HUD is in the positionSo, if you want a sound effect that simply plays when the HUD is moved at the correct position, just go to the &quot;.reached&quot; label and add this below the label:[CODE]&nbsp; &nbsp; &nbsp; &nbsp; play.w&nbsp; &nbsp; 1, jsr, sfx_Register&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; play &quot;ker-ching&quot; sound[/CODE]Done! Now your HUD has a sound every time it finishes scrolling, happy hacking! <img class="smilie smilie--emoji" alt="😃" src="https://cdn.jsdelivr.net/gh/twitter/twemoji@14.0.2/assets/72x72/1f603.png" title="Grinning face with big eyes&nbsp; &nbsp; :smiley:" data-shortname=":smiley:" loading="lazy" width="72" height="72" /><h3>GitHub version</h3>For getting started, you want to go in the _incObj/21 HUD.asm and go at the routine HUD_Main and replace it entirely with this new routine:[CODE]HUD_Main:&nbsp; &nbsp; ; Routine 0&nbsp; &nbsp; &nbsp; &nbsp; addq.b&nbsp; &nbsp; #4,obRoutine(a0)&nbsp; ; Advances to Routine 4 (HUD_Move) on the next frame&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #0,obX(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Starts the HUD offscreen (X = 0)&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #$108,obScreenY(a0)&nbsp; &nbsp; &nbsp; &nbsp; move.l&nbsp; &nbsp; #Map_HUD,obMap(a0)&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; #ArtTile_HUD,obGfx(a0)&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #0,obRender(a0)&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #0,obPriority(a0)&nbsp; &nbsp; &nbsp; &nbsp; rtsHUD_Move:&nbsp; &nbsp; ; Routine 4&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; obX(a0),d0&nbsp; &nbsp; &nbsp; &nbsp; ; Loads the current HUD X position&nbsp; &nbsp; &nbsp; &nbsp; cmpi.w&nbsp; &nbsp; #$90,d0&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; ; Has it reached position $90?&nbsp; &nbsp; &nbsp; &nbsp; bge.s&nbsp; &nbsp; .reached&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; If greater or equal, finalize the movement&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; addq.w&nbsp; &nbsp; #5,d0&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp; ; Move 5 pixels to the right&nbsp; &nbsp; &nbsp; &nbsp; move.w&nbsp; &nbsp; d0,obX(a0)&nbsp; &nbsp; &nbsp; &nbsp; ; Update the object&#039;s X coordinate directly&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; &nbsp;&nbsp; DisplaySprite.reached:&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #2,obRoutine(a0)&nbsp; &nbsp; &nbsp; &nbsp; jmp&nbsp; &nbsp; &nbsp;&nbsp; DisplaySprite[/CODE]Optional: You can change the scrolling speed to what you want, just simply replace the 5 with the number you think it&#039;s better.If the code mentioned in particular doesn&#039;t work, you did some mistake! Just go ahead in HUD_Index: label and insert this line below the HUD_Flash-HUD_Index[CODE]&nbsp; &nbsp; &nbsp; &nbsp; dc.w HUD_Move-HUD_Index[/CODE]Did you like it? Now your hack&#039;s HUD is scrolling like how it would be.(OPTIONAL) Adding sound effect if HUD is in the positionSo, if you want a sound effect that simply plays when the HUD is moved at the correct position, just go to the &quot;.reached&quot; label and add this below the label:[CODE]&nbsp; &nbsp; &nbsp; &nbsp; move.b&nbsp; &nbsp; #sfx_Cash,d0&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; set cash sound to be played&nbsp; &nbsp; &nbsp; &nbsp; jsr&nbsp; &nbsp; QueueSound2&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ; play it[/CODE]I hope you enjoyed this tutorial, now your hack has a HUD scrolling once the game starts.</blockquote>

[QUOTE="Mildanner, post: 6520, member: 7577"] [B][I]Original Guide by [COLOR=rgb(44, 130, 201)]Mildanner[/COLOR] (ft. [COLOR=rgb(29, 19, 232)]RetroKoH[/COLOR])[/I][/B] In game development, the developers didn't know how to make a simple scrolling HUD and decided to make the HUD pop in the screen without any doubts. In this guide, you will learn how to make a simple scrolling HUD. [HEADING=2]Hivebrain 2005 (ASM68K)[/HEADING] In the Hivebrain 2005, the object for HUD was still in sonic1.asm file. You should find the Obj21_Main label and replace this entire routine with this: [CODE]Obj21_Main: ; XREF: Obj21_Main addq.b #4,$24(a0) ; Advance to Routine 4 (Obj21_Move) on the next frame move.w #0,8(a0) ; Start offscreen (X = 0) move.w #$108,$a(a0) ; Set Y coordinate (obScreenY) move.l #Map_obj21,4(a0); Set mappings pointer (obMap) move.w #$6ca,2(a0) ; Set VRAM art tile (obGfx) move.b #0,1(a0) ; Set render settings (obRender) move.b #0,$18(a0) ; Set display priority (obPriority) rts ; =========================================================================== Obj21_Move: ; Routine 4 move.w 8(a0),d0 ; Load current X position cmpi.w #$90,d0 ; Has it reached position $90? bge.s @reached ; If greater or equal, finalize movement addq.w #5,d0 ; Move 5 pixels to the right move.w d0,8(a0) ; Update X coordinate directly jmp DisplaySprite @reached: move.b #2,$24(a0) ; Set routine status to Routine 2 jmp DisplaySprite[/CODE] If the code doesn't work, you should go above Obj21_Index and after the line. Insert this (After the Obj21_Move label) [CODE] dc.w Obj21_Move-Obj21_Index[/CODE] Done! Now your hack has a fellow HUD scrolling. [HEADING=2][COLOR=rgb(209, 209, 209)][SIZE=7][B](OPTIONAL) Adding sound effect if HUD is in the position[/B][/SIZE][/COLOR][/HEADING] Hivebrain 2005 has no macros, so you should modify it simply and paste this in the label you pasted below @reached [CODE] move.b #$C5,d0 ; set sound to cash jsr (PlaySound_Special).l ; play it[/CODE] Okay, now it will play a sound once the HUD scrolling is completed. [HEADING=2]Hivebrain 2022[/HEADING] Also, Hivebrain 2022 is a upgraded version of Hivebrain 2005 but better version and more documented by following the current version of Sonic 1 disassembly from Sonic Retro. In your disassembly, go to the [B]Objects/HUD.asm[/B] and find the label [B]HUD_Main:[/B] Replace the entire routine with this [CODE]HUD_Main: ; Routine 0 addq.b #4,ost_routine(a0) ; Advance to Routine 4 (HUD_Move) move.w #screen_left-80,ost_x_pos(a0) ; Start HUD far off-screen to the left move.w #screen_top+136,ost_y_screen(a0) ; Set Y position coordinate move.l #Map_HUD,ost_mappings(a0) ; Set mappings pointer move.w #tile_Nem_Hud,ost_tile(a0) ; Set art tile pattern index move.b #render_abs,ost_render(a0) ; Use absolute rendering screen space move.b #0,ost_priority(a0) ; Set sprite layout priority rts HUD_Move: ; Routine 4 move.w ost_x_pos(a0),d0 ; Get current HUD X position cmpi.w #screen_left+16,d0 ; Has it reached the classic target position ($10)? bge.s .reached ; If yes, branch to lock movement addq.w #5,d0 ; Shift 5 pixels to the right move.w d0,ost_x_pos(a0) ; Update object X position jmp (DisplaySprite).l .reached: move.b #2,ost_routine(a0) ; Set to static state routine (Routine 2 / HUD_Flash) jmp (DisplaySprite).l[/CODE] If there's a issue and it is not working, you should go below the pointer of [B]HUD_Flash[/B] and insert this below the line. [CODE] ptr HUD_Move[/CODE] Done! Now your fellow HUD scrolling is now functional, enjoy your new HUD scrolling. [COLOR=rgb(209, 209, 209)][SIZE=7][B](OPTIONAL) Adding sound effect if HUD is in the position[/B][/SIZE] So, if you want a sound effect that simply plays when the HUD is moved at the correct position, just go to the ".reached" label and add this below the label: [CODE] play.w 1, jsr, sfx_Register ; play "ker-ching" sound[/CODE] Done! Now your HUD has a sound every time it finishes scrolling, happy hacking! 😃[/COLOR] [HEADING=2]GitHub version[/HEADING] [COLOR=rgb(209, 209, 209)]For getting started, you want to go in the _incObj/21 HUD.asm and go at the routine HUD_Main and replace it entirely with this new routine: [CODE]HUD_Main: ; Routine 0 addq.b #4,obRoutine(a0) ; Advances to Routine 4 (HUD_Move) on the next frame move.w #0,obX(a0) ; Starts the HUD offscreen (X = 0) move.w #$108,obScreenY(a0) move.l #Map_HUD,obMap(a0) move.w #ArtTile_HUD,obGfx(a0) move.b #0,obRender(a0) move.b #0,obPriority(a0) rts HUD_Move: ; Routine 4 move.w obX(a0),d0 ; Loads the current HUD X position cmpi.w #$90,d0 ; Has it reached position $90? bge.s .reached ; If greater or equal, finalize the movement addq.w #5,d0 ; Move 5 pixels to the right move.w d0,obX(a0) ; Update the object's X coordinate directly jmp DisplaySprite .reached: move.b #2,obRoutine(a0) jmp DisplaySprite [/CODE] [B]Optional:[/B] You can change the scrolling speed to what you want, just simply replace the 5 with the number you think it's better. If the code mentioned in particular doesn't work, you did some mistake! Just go ahead in [B]HUD_Index:[/B] label and insert this line below the HUD_Flash-HUD_Index [CODE] dc.w HUD_Move-HUD_Index[/CODE] Did you like it? Now your hack's HUD is scrolling like how it would be. [SIZE=7][B](OPTIONAL) Adding sound effect if HUD is in the position[/B][/SIZE] So, if you want a sound effect that simply plays when the HUD is moved at the correct position, just go to the ".reached" label and add this below the label: [CODE] move.b #sfx_Cash,d0 ; set cash sound to be played jsr QueueSound2 ; play it[/CODE] I hope you enjoyed this tutorial, now your hack has a HUD scrolling once the game starts.[/COLOR] [/QUOTE]

Verification