User:Zero/Nomolos and PPU registers: Difference between pages

From NESdev Wiki
(Difference between pages)
Jump to navigationJump to search
 
(→‎Status ($2002) < read: Sprite 0 will redirect here)
 
Line 1: Line 1:
I began this project in late 08' when I finally realized what I really wanted to do with programming as a hobby. I realized that making a game for one of the video game consoles I dearly loved as a child would likely motivate me more than anything else. I had a couple of ideas when I was a kid, and partially developed those ideas in QuickBASIC. But now that I'm a little older and wiser I thought it'd be way cooler to put those ideas on a real video game console and actually finish them.
The PPU exposes eight memory-mapped registers to the CPU. These nominally sit at $2000 through $2007 in the CPU's address space, but because they're incompletely decoded, they're [[Mirroring|mirrored]] in every 8 bytes from $2008 through $3FFF, so a write to $3456 is the same as a write to $2006.


Nomolos is a constrained right-scrolling action platformer game that borrows elements from the original Castlevania, Super Mario Bros. and other well known games. It stars an orange cat in armor named Nomolos (this is Solomon backwards, the name of one of my cats), and the setting is renaissance/baroque era. The soundtrack will consist entirely of baroque music by Domenico Scarlatti, but I may throw in a couple of pieces I've written also. My goal is to make a simple and fun game---I have no intention or desire to break new ground with it. I'm all about nostalgia and that "classic" feel.
Immediately after powerup, the PPU isn't necessarily in a usable state.
The program needs to do a few things to get it going; see [[PPU power up state]] and [[Init code]].  


== Overview ==
<noinclude>
*Project owner: Gradualore
__TOC__
*Developer: Gradualore
</noinclude>
*Artist: [http://www.ravenwolfdesign.com/ Ravenwolf ]
*Compiler : [http://www.cc65.org/ CA65]
*Sound driver: [http://famitracker.shoodot.net/ Famitracker]
*Soundtrack by: Domenico Scarlatti
*Started on: ~November 08
*Current status: working on it consistently but gradually.
*Expected date: before Dec. 21st, 2012 so people can play it before we all die =)
*Will make cart: Considering as possibility.


== Current status ==
=== Controller ($2000) > write ===  
'''2010-1-9'''


Nomolos now has a dying animation. I tried to make it slightly less cliche looking than when most platformer characters die, but I won't tell you what it looks like, that'd spoil it! =). There's also a "level out" transition which fades out the palette. I completed some routines for dealing with strings and converting a number to a decimal string (for displaying lives left etc.). Before long, I should have a complete framework in place of title screen, main gameplay, level out/in transition, and game over screen. When that's done, the game should be ready to be fleshed out with a lot more content. I hope to spend most of 2010 working on some new enemies and maybe a couple of powerups. If I'm lucky and everything goes smoothly I may get around to a boss.
Is often referred as PPUCTRL.


'''2009-12-13'''
Various flags controlling PPU operation
7654 3210
|||| ||||
|||| ||++- Base nametable address
|||| ||    (0 = $2000; 1 = $2400; 2 = $2800; 3 = $2C00)
|||| |+--- VRAM address increment per CPU read/write of PPUDATA
|||| |    (0: increment by 1, going across; 1: increment by 32, going down)
|||| +---- Sprite pattern table address for 8x8 sprites
||||      (0: $0000; 1: $1000; ignored in 8x16 mode)
|||+------ Background pattern table address (0: $0000; 1: $1000)
||+------- Sprite size (0: 8x8; 1: 8x16)
|+-------- PPU master/slave select (has no effect on the NES)
+--------- Generate an [[NMI]] at the start of the
            [[wikipedia:Vertical blanking interval|vertical blanking interval]] (0: off; 1: on)


Meta sprite clipping is now working and integrated for Nomolos, and the few entities I currently have implemented for testing (mouse powerup, "Deentle" spider, and explosion entity). Ravenwolf finished a "dying" graphic for Nomolos. Hopefully in a few weeks or so I'll have the dying graphic integrated for when Nomolos loses all his hearts, and some kind of transition to a level saying what level you are on and how many lives you have left.
Equivalently, bits 0 and 1 are the most significant bit of the scrolling coordinates (see [[PPU_nametables|Nametables]] and [[#Scroll ($2005) >> write x2|PPU scroll]]):
7654 3210
        ||
        |+- 1: Add 256 to the X scroll position
        +-- 1: Add 240 to the Y scroll position


'''2009-11-14'''
==== Note ====
Another way of seeing the explanation above is that when you reach the end of a nametable, you must switch to the next one, hence, changing the nametable address.


I recently completed some code for switching between levels that may have graphics or PRG data residing in seperate banks using MMC1. Some very basic game play mechanics are in place, a single enemy and a single item. Development is going to start getting exciting soon as I begin to flesh it out with more enemies, more items, possibly a couple of powerups, a boss, etc. I hope within a year to have a worthy demo to show others.
[[PPU power up state|After power/reset]], writes to this register are ignored for about 30000 cycles.


== Screenshots ==
=== Mask ($2001) > write ===
'''2009-12-14'''
<br/>
[[File:Nomolos_003.png‎|100px|2009-10-30]]


== Other links ==
Is often referred as PPUMASK.
Coming soon
 
This register controls screen enable, masking, and intensity.
Write $00 here if you want to turn rendering off so that you can update the pattern tables or nametables outside of vertical blanking.
Write $1E when you're done to turn rendering back on.
The other bits do special effects with the colors.
76543210
||||||||
|||||||+- Grayscale (0: normal color; 1: produce a monochrome display)
||||||+-- 1: Show background in leftmost 8 pixels of screen; 0: Hide
|||||+--- 1: Show sprites in leftmost 8 pixels of screen; 0: Hide
||||+---- 1: Show background
|||+----- 1: Show sprites
||+------ Intensify reds (and darken other colors)
|+------- Intensify greens (and darken other colors)
+-------- Intensify blues (and darken other colors)
 
When grayscale is turned on, the PPU ignores the lower nibble of each palette entry.
This causes a bitwise AND with $30 on any value read from PPU $3F00-$3FFF, both on the display and through PPUDATA ($2007).
 
Hiding the leftmost 8 pixels is often done to cover [[mirroring]] artifacts when done horizontally.
Sprite 0 hit does not trigger in any area where the background or sprites are hidden.
If both the background and sprites are hidden, the PPU enters "forced blank" state, where it stops rendering and releases control of the address and data bus.
 
[[NTSC video]] describes how bits D7-D5 (the "emphasis" bits or the "tint" bits) work on NTSC and PAL PPUs.
Each bit's color have been confirmed on an NES; some older documents have them wrong.
'''Caution:''' The RGB PPU (used on PlayChoice, Famicom Titler, and a couple Japanese TVs) treats the tint bits differently: instead of darkening other RGB components, it forces one RGB component to maximum brightness.
A few games, which set all three tint bits to darken all colors, are unplayable on these PPUs.
In either case, the tint bits are applied after grayscale, which means they still tint the gray image.
 
=== Status ($2002) < read ===
 
Is often referred as PPUSTATUS.
 
This register reflects the state of various functions inside the PPU.
It is often used for determining timing.
<span id="Sprite_0">To determine when the PPU has reached a given pixel of the screen, put an opaque pixel of sprite 0 there.</span>
 
76543210
||||||||
|||+++++- Least significant bits previously written into a PPU register
|||      (due to register not being updated for this address)
||+------ Sprite overflow. The PPU can handle only eight sprites on one
||        scanline and sets this bit if it starts dropping sprites.
||        Normally, this triggers when there are 9 sprites on a scanline,
||        but the actual behavior is significantly more complicated.
|+------- Sprite 0 Hit.  Set when a nonzero pixel of sprite 0 overlaps
|        a nonzero background pixel, cleared at start of pre-render line.
|        Used for raster timing.
+-------- Vertical blank has started (0: not in VBLANK; 1: in VBLANK)
 
==== Notes ====
* Reading the status register will clear D7 mentioned above and also the address latch used by [[#Scroll ($2005) >> write x2|PPUSCROLL]] and [[#Address ($2006) >> write x2|PPUADDR]].
* When the sprite 0 hit flag is set on a frame, it will not be cleared until the vertical blank has ended on the next frame.  If attempting to use this flag for raster timing, it is important to ensure that the sprite 0 hit check happens outside of vertical blank, otherwise the CPU will "leak" through and the check will fail.  The easiest way to do this is to place an earlier check for D6 = 0.
* '''Caution:''' Reading PPUSTATUS at the exact start of vertical blank will return a 0 in D7 but clear the latch anyway, causing the program to miss frames. See [[NMI]] for details.
 
=== OAM address ($2003) > write ===
 
Is often referred as OAMADDR.
 
 
Write the address of [[PPU_OAM |OAM]] you want to access here.  Most games just write $00 here and then use OAM_DMA ($4014).
 
This register also seems to affect Sprite 0 Hit, though it is not yet understood exactly how it does. The upper 5 bits of this register seem to select which SPR-RAM data is used for sprites 0 and 1 (instead of the first 8 bytes of SPR-RAM), though actual behavior varies between resets.
 
=== OAM data ($2004) <> read/write ===
 
OAM data port, often referred as OAMDATA.
 
Write OAM data here. Writes will increment [[#OAM address ($2003) > write|OAMADDR]] after the write; reads during vertical or forced blanking return the value from OAM at that address but do not increment.
 
Most games access this register through $4014 instead. Reading OAMDATA while the PPU is rendering will expose internal OAM accesses during sprite evaluation and loading; Micro Machines does this.
 
Note that reading OAM data isn't reliable in many cases, even when rendering is disabled. It is best to treat this as a write-only register.
 
=== Scroll ($2005) >> write x2 ===
 
Is often referred as PPUSCROLL.
 
This register is used to tell the PPU which pixel of the nametable selected through [[#Controller ($2000) > write|PPUCTRL]] should be at the top left corner of the rendered screen. Typically, this register is written to during VBlank, so that the next frame starts rendering from the desired location, but it can also be modified during rendering in order to split the screen. Changes made to the vertical scroll during rendering will only take effect on the next frame.
 
After reading [[#Status ($2002) < read|PPUSTATUS]] to reset the address latch, write the horizontal and vertical scroll offsets here just before turning on the screen:
  bit PPUSTATUS
  ; possibly other code goes here
  lda cam_position_x
  sta PPUSCROLL
  lda cam_position_y
  sta PPUSCROLL
Horizontal offsets range from 0 to 255. "Normal" vertical offsets range from 0 to 239, while values of 240 to 255 are treated as -16 through -1 in a way, but tile data is incorrectly fetched from the attribute table.
 
By writing different values here across several frames and modifying the nametables accordingly one can achieve the effect of a camera panning over a large background.
 
=== Address ($2006) >> write x2 ===
 
Is often referred as PPUADDR.
 
Because the CPU and the PPU are on separate buses, neither has direct access to the other's memory.
The CPU writes to VRAM through a pair of registers on the PPU.
First it loads an address into PPUADDR, and then it writes repeatedly to PPUDATA to fill VRAM.
 
After reading [[#Status ($2002) < read|PPUSTATUS]] to reset the address latch, write the 16-bit address of VRAM you want to access here, upper byte first.
For example, to set the VRAM address to $2108:
  lda #$21
  sta PPUADDR
  lda #$08
  sta PPUADDR
 
Valid addresses are $0000-$3FFF; higher addresses will be [[mirroring|mirrored]] down.
 
==== note ====
Access to [[#Scroll ($2005) >> write x2|PPUSCROLL]] and PPUADDR during screen refresh produces interesting raster effects; the starting position of each scanline can be set to any pixel position in nametable memory. For more information, see "The Skinny on NES Scrolling" by loopy, available from [http://nesdev.parodius.com/ the main site], and [http://nesdev.parodius.com/bbs/viewtopic.php?p=64111#64111 tokumaru's sample code on the BBS].
 
''' Editor's note:''' Last comment about external page should be re-directed to the getting started section instead.
 
=== Data ($2007) <> read/write ===
 
Is often referred as PPUDATA.
 
VRAM data register.
 
When the screen is turned off by disabling the background/sprite rendering flag with the [[#Mask ($2001) >> write|PPUMASK]] or during vertical blank, you can read or write data from VRAM through this port.
 
==== Note ====
When reading while the VRAM address is in the range 0-$3EFF, the read will return the contents of an internal buffer. After the CPU reads, the PPU will then immediately read the byte at the current VRAM address into this internal buffer. Thus, after setting the VRAM address, one should first read this register and discard the result. This behavior doesn't occur when the VRAM address is in the $3F00-$3FFF palette range; reads come directly from palette RAM and don't affect the internal buffer.
 
Since accessing this register increments the VRAM address, it should not be accessed outside vblank when rendering is enabled, because it will cause graphical glitches, and if writing, write to an unpredictable address in VRAM.

Revision as of 19:14, 23 April 2012

The PPU exposes eight memory-mapped registers to the CPU. These nominally sit at $2000 through $2007 in the CPU's address space, but because they're incompletely decoded, they're mirrored in every 8 bytes from $2008 through $3FFF, so a write to $3456 is the same as a write to $2006.

Immediately after powerup, the PPU isn't necessarily in a usable state. The program needs to do a few things to get it going; see PPU power up state and Init code.



Controller ($2000) > write

Is often referred as PPUCTRL.

Various flags controlling PPU operation

7654 3210
|||| ||||
|||| ||++- Base nametable address
|||| ||    (0 = $2000; 1 = $2400; 2 = $2800; 3 = $2C00)
|||| |+--- VRAM address increment per CPU read/write of PPUDATA
|||| |     (0: increment by 1, going across; 1: increment by 32, going down)
|||| +---- Sprite pattern table address for 8x8 sprites
||||       (0: $0000; 1: $1000; ignored in 8x16 mode)
|||+------ Background pattern table address (0: $0000; 1: $1000)
||+------- Sprite size (0: 8x8; 1: 8x16)
|+-------- PPU master/slave select (has no effect on the NES)
+--------- Generate an NMI at the start of the
           vertical blanking interval (0: off; 1: on)

Equivalently, bits 0 and 1 are the most significant bit of the scrolling coordinates (see Nametables and PPU scroll):

7654 3210
       ||
       |+- 1: Add 256 to the X scroll position
       +-- 1: Add 240 to the Y scroll position

Note

Another way of seeing the explanation above is that when you reach the end of a nametable, you must switch to the next one, hence, changing the nametable address.

After power/reset, writes to this register are ignored for about 30000 cycles.

Mask ($2001) > write

Is often referred as PPUMASK.

This register controls screen enable, masking, and intensity. Write $00 here if you want to turn rendering off so that you can update the pattern tables or nametables outside of vertical blanking. Write $1E when you're done to turn rendering back on. The other bits do special effects with the colors.

76543210
||||||||
|||||||+- Grayscale (0: normal color; 1: produce a monochrome display)
||||||+-- 1: Show background in leftmost 8 pixels of screen; 0: Hide
|||||+--- 1: Show sprites in leftmost 8 pixels of screen; 0: Hide
||||+---- 1: Show background
|||+----- 1: Show sprites
||+------ Intensify reds (and darken other colors)
|+------- Intensify greens (and darken other colors)
+-------- Intensify blues (and darken other colors)

When grayscale is turned on, the PPU ignores the lower nibble of each palette entry. This causes a bitwise AND with $30 on any value read from PPU $3F00-$3FFF, both on the display and through PPUDATA ($2007).

Hiding the leftmost 8 pixels is often done to cover mirroring artifacts when done horizontally. Sprite 0 hit does not trigger in any area where the background or sprites are hidden. If both the background and sprites are hidden, the PPU enters "forced blank" state, where it stops rendering and releases control of the address and data bus.

NTSC video describes how bits D7-D5 (the "emphasis" bits or the "tint" bits) work on NTSC and PAL PPUs. Each bit's color have been confirmed on an NES; some older documents have them wrong. Caution: The RGB PPU (used on PlayChoice, Famicom Titler, and a couple Japanese TVs) treats the tint bits differently: instead of darkening other RGB components, it forces one RGB component to maximum brightness. A few games, which set all three tint bits to darken all colors, are unplayable on these PPUs. In either case, the tint bits are applied after grayscale, which means they still tint the gray image.

Status ($2002) < read

Is often referred as PPUSTATUS.

This register reflects the state of various functions inside the PPU. It is often used for determining timing. To determine when the PPU has reached a given pixel of the screen, put an opaque pixel of sprite 0 there.

76543210
||||||||
|||+++++- Least significant bits previously written into a PPU register
|||       (due to register not being updated for this address)
||+------ Sprite overflow. The PPU can handle only eight sprites on one
||        scanline and sets this bit if it starts dropping sprites.
||        Normally, this triggers when there are 9 sprites on a scanline,
||        but the actual behavior is significantly more complicated.
|+------- Sprite 0 Hit.  Set when a nonzero pixel of sprite 0 overlaps
|         a nonzero background pixel, cleared at start of pre-render line.
|         Used for raster timing.
+-------- Vertical blank has started (0: not in VBLANK; 1: in VBLANK)

Notes

  • Reading the status register will clear D7 mentioned above and also the address latch used by PPUSCROLL and PPUADDR.
  • When the sprite 0 hit flag is set on a frame, it will not be cleared until the vertical blank has ended on the next frame. If attempting to use this flag for raster timing, it is important to ensure that the sprite 0 hit check happens outside of vertical blank, otherwise the CPU will "leak" through and the check will fail. The easiest way to do this is to place an earlier check for D6 = 0.
  • Caution: Reading PPUSTATUS at the exact start of vertical blank will return a 0 in D7 but clear the latch anyway, causing the program to miss frames. See NMI for details.

OAM address ($2003) > write

Is often referred as OAMADDR.


Write the address of OAM you want to access here. Most games just write $00 here and then use OAM_DMA ($4014).

This register also seems to affect Sprite 0 Hit, though it is not yet understood exactly how it does. The upper 5 bits of this register seem to select which SPR-RAM data is used for sprites 0 and 1 (instead of the first 8 bytes of SPR-RAM), though actual behavior varies between resets.

OAM data ($2004) <> read/write

OAM data port, often referred as OAMDATA.

Write OAM data here. Writes will increment OAMADDR after the write; reads during vertical or forced blanking return the value from OAM at that address but do not increment.

Most games access this register through $4014 instead. Reading OAMDATA while the PPU is rendering will expose internal OAM accesses during sprite evaluation and loading; Micro Machines does this.

Note that reading OAM data isn't reliable in many cases, even when rendering is disabled. It is best to treat this as a write-only register.

Scroll ($2005) >> write x2

Is often referred as PPUSCROLL.

This register is used to tell the PPU which pixel of the nametable selected through PPUCTRL should be at the top left corner of the rendered screen. Typically, this register is written to during VBlank, so that the next frame starts rendering from the desired location, but it can also be modified during rendering in order to split the screen. Changes made to the vertical scroll during rendering will only take effect on the next frame.

After reading PPUSTATUS to reset the address latch, write the horizontal and vertical scroll offsets here just before turning on the screen:

 bit PPUSTATUS
 ; possibly other code goes here
 lda cam_position_x
 sta PPUSCROLL
 lda cam_position_y
 sta PPUSCROLL

Horizontal offsets range from 0 to 255. "Normal" vertical offsets range from 0 to 239, while values of 240 to 255 are treated as -16 through -1 in a way, but tile data is incorrectly fetched from the attribute table.

By writing different values here across several frames and modifying the nametables accordingly one can achieve the effect of a camera panning over a large background.

Address ($2006) >> write x2

Is often referred as PPUADDR.

Because the CPU and the PPU are on separate buses, neither has direct access to the other's memory. The CPU writes to VRAM through a pair of registers on the PPU. First it loads an address into PPUADDR, and then it writes repeatedly to PPUDATA to fill VRAM.

After reading PPUSTATUS to reset the address latch, write the 16-bit address of VRAM you want to access here, upper byte first. For example, to set the VRAM address to $2108:

  lda #$21
  sta PPUADDR
  lda #$08
  sta PPUADDR

Valid addresses are $0000-$3FFF; higher addresses will be mirrored down.

note

Access to PPUSCROLL and PPUADDR during screen refresh produces interesting raster effects; the starting position of each scanline can be set to any pixel position in nametable memory. For more information, see "The Skinny on NES Scrolling" by loopy, available from the main site, and tokumaru's sample code on the BBS.

Editor's note: Last comment about external page should be re-directed to the getting started section instead.

Data ($2007) <> read/write

Is often referred as PPUDATA.

VRAM data register.

When the screen is turned off by disabling the background/sprite rendering flag with the PPUMASK or during vertical blank, you can read or write data from VRAM through this port.

Note

When reading while the VRAM address is in the range 0-$3EFF, the read will return the contents of an internal buffer. After the CPU reads, the PPU will then immediately read the byte at the current VRAM address into this internal buffer. Thus, after setting the VRAM address, one should first read this register and discard the result. This behavior doesn't occur when the VRAM address is in the $3F00-$3FFF palette range; reads come directly from palette RAM and don't affect the internal buffer.

Since accessing this register increments the VRAM address, it should not be accessed outside vblank when rendering is enabled, because it will cause graphical glitches, and if writing, write to an unpredictable address in VRAM.