Project Hikari is the code name for a yet-to-be-named open-source Mega Man/Rockman game clone written in C++. The goal of this project is to create a faithful clone of the classic NES title "Mega Man" ("Rockman" in Japan). The feature set of the game consists of elements from various Mega Man titles, but is strongly influenced by Mega Man 3.

The game is designed to be as data-driven as possible and as such it allows for customization and extension:

• Animations are JSON structures
• Items, Enemies, Projectiles, etc are JSON structures
• Behavior of Items and Enemies is controlled by Squirrel scripts
• Stages are JSON structures
• Music and sound effects are NSF files

Most things are customizable. Not everything, but most things.

Project Hikari uses CMake to generate platform and compiler-specific build files.

Before building Hikari, make sure that the following libraries are compiled and installed:

• SFML
• PhysicsFS

Also note that this project uses C++11 features such as auto, decltype, and lambdas, and therefore requires a somewhat compliant compiler in order to build successfully.

1. Ensure SFML and PhysicsFS are installed.

2. Clone the repository.

    git clone https://github.com/zackthehuman/hikari.git hikari
   

3. Generate the build files.

    mkdir hikari-build
    cd hikari-build
    cmake -G "Visual Studio 10" ../hikari
   

4. Open the .sln in Visual Studio and build the ALL_BUILD target.

1. Ensure SFML and PhysicsFS are installed.

2. Clone the repository.

    git clone https://github.com/zackthehuman/hikari.git hikari
   

3. Generate the build files.

    mkdir hikari-build
    cd hikari-build
    cmake -G "Unix Makefiles" ../hikari
   

4. Build the application.

    make
   

"Hikari" is the Japanese word for "light". Since Dr. Light is the creator of Mega Man, we figured that a word associated with him would be an appropriate code name for a project like this. Originally "hikari" was going to be the name of the engine used to power the game, but focus has shifted away from a separate engine/game architecture.