infloot

A simple Doodle-Jump-like game to test the waters. Also, the name infloot has nothing to do with this, just haven't changed the name.

How to compile

This rom uses create-nes-game to build. Download a copy of that to start.

First time setup

1. Download create-nes-game, if you haven't already.
2. (Optional) Run ./create-nes-game install to install the tool globally
3. Run create-nes-game download-dependencies to download dependencies of this game into this folder
4. Proceed to the next section to build the rom.

Building the game

To build the rom, run create-nes-game build in the same directory as this readme file.

You can run the game using the selected emulator (if available on your operating system) using the create-nes-game run command. Alternatively, the rom is available in the rom/ folder.

Running unit tests

This rom includes unit tests that can be used to verify that the game works. Run them using the create-nes-game test command.

The tests are located in the test/ folder.

Directory layout

infloot
└─ config/                  - Configuration for the assembler/compiler
└─ graphics/                - Graphics data - backgrounds, palettes, and nametables
|    graphics.config.asm    - Add references to new graphics files here to use them from code
|    YOUR_FILE_NAME.chr     - Graphics data in binary form, such as exported from nesst
|                             Will automatically be run-length encoded into files with the .rle.chr suffix
|    YOUR_FILE_NAME.nam     - Nametable data in binary form, such as exported from nesst
|                             Will automatically be run-length encoded into files with the .rle.nam suffix
└─ rom/
|    YOUR_GAME.nes          - The game rom
|    YOUR_GAME.dbg          - Debugging information for the game - Mesen can use this to debug your code directly
└─ source/
|    assembly/              - All game code lives here 
|        main.asm           - This is the main entrypoint of the game
|        system-defines.asm - Constants and symbols commonly used in nes development
└─ temp/                    - Temporary storage for the compiler. Usually safe to ignore
└─ test/                    - Test files for the game, written in javascript. Uses nes-test
└─ tools/                   - Compile and emulation tools required by the game, downloaded by nes-test

Music

Music is created using Famitracker 0.4.6. Once you have music you like, you'll need to export it for use with this engine. Follow these steps to do so:

1. In the File menu, select Export Text
2. Save the generated file into the sound/ folder as music.txt

Next time you run create-nes-game build your new music will be added to the game.

---

This rom uses create-nes-game!