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 package Readme of all available command options.

One the project is configured you are ready to being development. For N64 run the following command to copy the VSCode devcontainer:

npm run prepare-n64-modernsdk-development