1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
Examples for the Famicom/NES. These examples are not full blown games nor
standalone projects. Rather, they should be seen as learning material and
experiments. If you want to check out standalone projects that I have written,
check out [this list](#other-projects).
## Build
You can build everything by just calling `make` and binaries will then be
available in the `out` directory. Before doing that, though, you will need a
compiler for the 6052 platform. A good option is
[cc65](https://github.com/cc65/cc65), which is available on all major platforms.
Otherwise, if you want to use another compiler, you can pass the `CC65` and
`CCOPTS` variables to the Makefile.
After that, it's recommended that you run the ROMs with an emulator with
debugging support or at least some form of memory visualization. This is because
some examples have nothing to show for other than updating some values on the
NES memory. A safe bet is to go with either
[fceux](https://fceux.com/web/home.html) or
[Mesen](https://github.com/SourMesen/Mesen2/), which provide tools like RAM
watchers or a full debugger.
## Examples
The examples are distributed like this:
- `basics`: simple examples which cover basic stuff for NES development. These
examples are self-contained and supposed to be read by absolute newcomers. The
description for each example is covered by an initial comment on each file,
and you can also find more info in the [basics/README.md](./basics/README.md)
file.
- `space`: example in which you can move a spaceship with subpixel movement and
shoot bullets. Consider this an evolution from the `basics/sprite.s` and
`basics/input.s` examples. That is, we are no longer just showing a sprite,
but we make it move and perform an action like shooting bullets.
- `scroll`: different scrolling tactics. Read the
[scroll/README.md](./scroll/README.md) file for more info.
- `fx`: miscellanous effects that can be achieved with this humble machine.
## Other projects
- Full games: [jetpac.nes](https://github.com/mssola/jetpac.nes).
- Libraries: [list.nes](https://github.com/mssola/list.nes).
- Misc: [Advent of Code 2023](https://github.com/mssola/aoc2023.nes).
## License
Released under the [GPLv3+](http://www.gnu.org/licenses/gpl-3.0.txt), Copyright
(C) 2023-<i>Ω</i> Miquel Sabaté Solà.
I have taken lots of ideas from different developers and open source projects.
Most notably, I have taken lots of notes from the [Famicom Party
Book](https://famicom.party/book/),
[NESHacker](https://www.youtube.com/c/neshacker) and, of course, from the
awesome [NES Dev wiki](https://www.nesdev.org/wiki/Nesdev_Wiki).
|
