└── README.md


/README.md:
--------------------------------------------------------------------------------
  1 | # Spiritualized NES
  2 | NES core for openFPGA on Analogue Pocket
  3 | -
  4 | 
  5 | NSF playing, FDS games, Vs. Games, and everything else should be supported by this core.
  6 | 
  7 | If you wish to play FDS games, make sure the file "fds.bios" is present in your
  8 | /nes/common/ folder!  If not, you will get a "file not found" error. 
  9 | 
 10 | When loading an FDS file for the first time, it must be processed.  This can
 11 | take several seconds. Subsequent loading will be nearly instant.
 12 | 
 13 | Loading NSFs can take 2-3 seconds as well.
 14 | 
 15 | For Vs. games, press the left trigger (default) to insert coins.
 16 | 
 17 | The following interact menu items are present:
 18 | 
 19 | Region:
 20 | 
 21 | This lets you select one of three regions.  NTSC, PAL, or Dendy.  
 22 | 
 23 | The selected region can be overridden if the "auto region"
 24 | checkbox is checked.  This setting will allow NES 2.0 headered
 25 | games to override the region.
 26 | 
 27 | The following types of results can happen:
 28 | 
 29 | If the region is set to NTSC, and a PAL game is run, it will be
 30 | autoswitched to PAL for that game.  No user interaction is required.
 31 | 
 32 | Vice-versa is also true- If the region is set to PAL, and an NTSC
 33 | game is run, it will run in NTSC.
 34 | 
 35 | Note that the 2.0 header can specify "multiregion".  Codemasters
 36 | games are known for their ability to modify behavior based on which system
 37 | it is running on.  If a multiregion game is loaded, it will use the
 38 | region that you have selected, and will not override it.  
 39 | 
 40 | Overscan:
 41 | 
 42 | Checking this box will reduce the visible area of the screen, cutting
 43 | some of the top, bottom, and sides off, while resizing the screen so that
 44 | dead screen realestate is minimized.
 45 | 
 46 | Looped Noise Off:
 47 | 
 48 | Checking this box will simulate what a first run Famicom sounds like.
 49 | This is audible on games like the Metal Man stage on Megaman 2.  The
 50 | metallic instrument will turn into white noise instead.
 51 | 
 52 | Square Reset Off:
 53 | 
 54 | Checking this will disable the phase reset when the square wave
 55 | frequency is reloaded.  Some homebrew games/music don't sound quite as
 56 | good if they reload the frequency high byte each frame.  This is also
 57 | what gives the Super Mario Bros time countdown that "gritty" sound.
 58 | Toggle it on and off during the countdown to hear the difference.
 59 | 
 60 | 16 Sprites/Line:
 61 | 
 62 | Selecting this will allow up to 16 sprites to be visible per line.
 63 | It can reduce sprite flicker on certain games.  Beware that some games
 64 | actually use the sprite limit to hide things. 
 65 | 
 66 | Multicart Mode:
 67 | 
 68 | Some multicarts have solder pads on them which can be jumpered to show
 69 | different game counts.  This lets you change that.
 70 | 
 71 | 4 Player Mode:
 72 | 
 73 | Using a dock, up to 4 players can play games.  The type of 4 player adapter
 74 | can be selected here:  None, Four Score, or Famicom style 4 players.
 75 | 
 76 | The 4 player adapter is only enabled if 3 or more controllers are
 77 | hooked up to the dock.
 78 | 
 79 | FDS Mode:
 80 | 
 81 | Selects if automatic or manual disk change is used.
 82 | 
 83 | For automatic mode, the disk is automatically flipped and the user does
 84 | not have to do anything.
 85 | 
 86 | Manual mode requires the user to press the right trigger to change disks.
 87 | 
 88 | Most games are fine with automatic mode, but a few do not like it and 
 89 | will constantly think the disk is being ejected.  Select this mode if
 90 | you run into that.
 91 | 
 92 | Enjoy
 93 | 
 94 | This core is for the [Analogue Pocket](https://www.analogue.co/pocket) via [openFPGA](https://www.analogue.co/developer).
 95 | 
 96 | ## Release Notes
 97 | 
 98 | * First public release
 99 | 
100 | ## Installation
101 | To play NES on your Pocket follow these instructions. 
102 | 1. Download and install the latest Pocket firmware here https://analogue.link/pocket-firmware
103 | 2. Unzip the contents onto the root of your Pocket SD Card in the appropriate folders. 
104 | 3. You will need to add a FDS bios to your sd card. Name the FDS bios file "fds.bios" and place it in the assets/nes/common folder.
105 | 4. Place rom files in the assets/nes/common folder.
106 | 5. Power on Pocket and select openFPGA to run the core.
107 | 


--------------------------------------------------------------------------------