/UltraEd

A level editor/game engine for the Nintendo 64.

Primary LanguageCMIT LicenseMIT

A level editor/game engine for the Nintendo 64

Codacy Badge

Setup

Due to the project using Git LFS the zipped version from GitHub won't contain all necessary files. Clone the project using Git and then run git lfs pull to hydrate all of the pointer files. After that make sure that the Windows 10 SDK is installed and then open the editor solution file in Visual Studio 2019. Set the solution to build as a x64 application and then all should build fine. Make sure to also install OpenAL so you can test your rom out in the cen64 emulator included. I've included it in Editor/Vendor. Also if you so happen to have the excellent 64drive you can test on that too.

Notes

UltraEd isn't finished and is not a fully polished tool yet. It has enough functionality to throw a few models in a scene, texture them, script them and have some fun. I have many ideas and things I'm excited to implement in the future. I have a full-time job and other life commitments so I work on this tool in my free time. I love the N64! :0)

Quick Start

UltraEd is now project based so a new project must be created before creating a scene with assets. Click File > New Project. Enter a name and select where the project should live on your drive. After your project folder has been created you can add assets to your project by dropping them in the newly created folder. Everything placed in the folder is accessible from the editor and is tracked. So when a model or texture is changed the scene will auto-update with the changes.

Programming API

The feature set is currently very small but it will expand over time. Here is the current set of methods available:

  1. actor *FindActorByName(const char *name) Pass the name of an actor and the first matching one will be returned.

  2. void SetActiveCamera(actor *camera) Pass a camera actor to become the new focused camera.

  3. actor *Instantiate(actor *other) Allows "copying" of an actor. There's no remove method yet and I'm currently trying to find an effcient dynamic array algorithm for the actors.

Each actor includes a default script that contains empty function implementations. Here's the template:

void $start()
{
    // Called upon startup
}

void $update()
{
    // Called once every frame
}

void $input(NUContData gamepads[4])
{
    // Called when any input from the controller is detected
}

void $collide(actor *other)
{
    // Called when a collision is detected only if both actors have a collider added.
}

The dollar signs are necessary to allow correct namespacing of all defined functions.

Donations

If you would like... you can donate to UltraEd's development! Give any amount. Even $0.00 lol! ^_^

paypal