Quickstart Guide

Creating a new game is easy using the @matthewcpp/framework64-cli NPM package.

Begin by creating a new folder and initializing a new git repository:

mkdir mygame
git init mygame

Alternatively clone an existing git repository:

git clone https://github.com/matthewcpp/mygame

Now that your git repository is setup, run the following command to configure the directory as a new framework64 game:

cd mygame
npm install @matthewcpp/framework64-cli
npx framework64-cli create

By default the project is configured in the working directory. The directory name is used as the game name. Refer to the framework64-cli Readme for all available command options.

Install the asset pipeline dependencies:

npm install

For N64 run the following command to copy the VSCode devcontainer for the N64 modern SDK:

npm run configure_environment n64_libultra

Build game assets:

npm run prepare_assets n64_libultra

One the project is configured you are ready to begin development by opening the project folder in VS Code