How can I write my own Mode Module?

[c64emulator]

Is there some information about writing my own Mode Module?

[JanPetterMG]

Hi! There isn’t any dedicated documentation yet, but writing an mode module isn’t too hard once you get familiar with the structure. The exact steps depend a bit on what you want to build and whether it’s for personal use or something you’d like to share upstream.

For a simple, personal mode you can start by:

• Adding your code in firmware/include/modes/CustomMode.h and firmware/src/modes/CustomMode.cpp.
• Including and initializing it in firmware/include/services/ModesService.h.

If you plan to contribute it back, there are a few extra pieces—like adding a toggle in firmware/include/config/modes.h, updating firmware/src/services/ModesService.cpp, and possibly making changes in the webapp/ UI if it needs controls there.

As a good starting point, check out the changes made in #40

If you’re new to coding, feel free to open a draft PR even if it’s rough — I’m happy to give pointers and help you get started.