Skip to content

User Guide

Introduction

Warning

The asset editors built into ERA-3D are still in early development, and are missing important functionality.

It is currently recommended to use external editors for creating assets like textures and 3D models.

General Controls

The following keyboard shortcuts are always available, except while an asset import dialog or the console is open:

  • Ctrl+Left / Right: Switch editors
  • Ctrl+R: Run cart
  • Ctrl+Enter: Open/close console
  • Ctrl+O: Load cart file
  • Ctrl+S: Save cart
  • Ctrl+Shift+S: Save cart as

Editor Screens

TODO

Code Editor

This screen is where the ERA-C code for the current cart is written.

Code Editor Controls

  • Left / Right / Up / Down: Move cursor
  • Home: Move cursor to the beginning of the line
  • End: Move cursor to the end of the line
  • Page Up: Move cursor up several lines
  • Page Down: Move cursor down several lines
  • Alt+Up: Move line up
  • Alt+Down: Move line down
  • Ctrl+D: Duplicate line
  • Shift+Tab: Deindent line
  • Ctrl+I: Import code text file (current code is replaced!)

Audio Sequencer (Tracker)

Warning

Many important features of the Tracker have not been implemented yet.

The Audio Sequencer allows audio samples stored on the cartridge to be sequenced and played back by the soundchip.

General Tracker Controls

  • Left / Right / Up / Down: Move cursor
  • Tab: Move cursor to next track
  • Shift+Tab: Move cursor to previous track
  • Alt+Up / Down: Switch views
  • Space: Play/stop song
  • Ctrl+I Import an audio file (.wav) into the selected WAVBANK

Song View Controls

  • 0-9, A-F: Change pattern hex value

Pattern View Controls

TODO

Instrument View Controls

TODO

Model Editor

Warning

The Model Editor has not been implemented yet.

However, on the Model Editor screen, you can press Ctrl+I to import a 3D model file (.obj, .gltf/glb) into OBJBANK 0.

TODO

Texture Editor

TODO

Texture Editor Controls

  • Ctrl+I Import an image file (.png) into the selected TEXBANK (the image being imported MUST be 1024x1024!)

Console

The console allows the user to run commands to configure ERA-3D's settings, as well as view API documentation.

Warning

The API documentation accessed using the console is not up-to-date with the online version.

For now, it is recommended to use the API Reference page instead.

Console Controls

  • Enter: Run command`