change README

This commit is contained in:
Moon Man 2024-06-16 06:44:03 -04:00
parent ae0f787453
commit f0a4d35599
1 changed files with 2 additions and 46 deletions

View File

@ -1,36 +1,6 @@
# **NES Boilerplate Game** # **NES MM5 Demo Game**
A NES game that serves as a base for starting a new NES project. A NES game that does the minimum to bootstrap MM5.
-----------------
- [**Features**](#features)
- [**Prerequisite**](#prerequisite)
- [**Project configuration**](#project-configuration)
- [**Source configuration**](#source-configuration)
- [**Makefile configuration**](#makefile-configuration)
- [**FamiStudio configuration**](#famistudio-configuration)
- [**Building the game**](#building-the-game)
- [**Running the game**](#running-the-game)
-----------------
## **Features**
This project has/can:
- Compile the game from assembly code.
- Compile the game from c code.
- A reset handler that reset memory to 0 and call the main function.
- A general NMI handler to draw stuff on the screen.
- An IRQ handler (that does nothing, but we need one).
- Support for the FamiStudio Sound Engine (<https://famistudio.org>)
- Some defined constant (PPU, APU, etc.).
- Compile the game with the MMC5 mapper. (<https://www.nesdev.org/wiki/MMC5>)
Note: *This project has by default 32K of PRG and 8K of CHR.*
-----------------
## **Prerequisite** ## **Prerequisite**
@ -39,26 +9,12 @@ Note: *This project has by default 32K of PRG and 8K of CHR.*
You will need to have CC65 and the files that comes with it. You will need to have CC65 and the files that comes with it.
It can be downloaded here: <https://cc65.github.io> It can be downloaded here: <https://cc65.github.io>
### **Emulator**
You theoretically don't need a NES emulator,
but unless your developing on hardware without testing on software (why ?),
I recommend the Mesen emulator because of these debugging features: <https://www.mesen.ca>
### **Other (Optional)** ### **Other (Optional)**
#### **NesDev Wiki** #### **NesDev Wiki**
In case you don't know this website exist, it is **THE most useful** website about how to program on the NES and many other things: <https://wiki.nesdev.org> In case you don't know this website exist, it is **THE most useful** website about how to program on the NES and many other things: <https://wiki.nesdev.org>
#### **Text Editor**
Choose any software you want to write your code, I personally like VS Code because of the syntax highlight and error checking, but use what you are comfortable with.
#### **Hexdump**
You can download "Hexdump for Windows" if you need to output files in hexadecimal: <https://www.di-mgt.com.au/hexdump-for-windows.html>
#### **YY-CHR** #### **YY-CHR**
YY-CHR is an editor that you can use to edit the background and sprites in your CHR of your game: <https://w.atwiki.jp/yychr> YY-CHR is an editor that you can use to edit the background and sprites in your CHR of your game: <https://w.atwiki.jp/yychr>