datel_codes.h

Go to the documentation of this file.

 
#ifndef DATEL_CODES_H__
#define DATEL_CODES_H__
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
// The maximum number of cheat codes to support is dependent on the available space in the N64 RAM.
// However, for simplicity, we will hardcode it to 64 for now, as this number of codes should handle most games (keeping it low allows us to collect caveats).
// The Krikzz official menu only supports upto 34 codes, so this is already an improvement.
#define MAX_CHEAT_CODES (64) // Maximum number of cheat codes to support. This can be changed later if needed.
#define MAX_CHEAT_CODE_ARRAYLIST_SIZE (MAX_CHEAT_CODES * 2 + 2) // Maximum size of the cheat code list (address/value pairs + two trailing zeros)
 
typedef struct {
    uint32_t address; 
    uint16_t value; 
    bool enabled; 
    char description[32]; 
} cheat_file_code_t;
 
 
typedef enum {
    CHEAT_FILE_LOAD_OK,
    CHEAT_FILE_LOAD_ERR_MEMORY_ALLOC_FAIL,
    CHEAT_FILE_LOAD_ERR_FILE_OPEN_FAIL,
    CHEAT_FILE_LOAD_ERR_FILE_STAT_FAIL,
    CHEAT_FILE_LOAD_ERR_FILE_EMPTY,
    CHEAT_FILE_LOAD_ERR_FILE_TOO_BIG,
    CHEAT_FILE_LOAD_ERR_FILE_CONTENTS_ALLOC_FAIL,
    CHEAT_FILE_LOAD_ERR_FILE_READ_FAIL,
    CHEAT_FILE_LOAD_ERR_FILE_CLOSE_FAIL,
    CHEAT_FILE_LOAD_ERR_UNKNOWN
} cheat_file_load_err_t;
 
 
size_t generate_enabled_cheats_array(cheat_file_code_t *cheats_in, uint32_t *cheats_out);
 
cheat_file_code_t *get_cheat_codes(void);
 
void set_cheat_codes(cheat_file_code_t *cheats);
 
void load_cheats_from_file(char *path);
 
void save_cheats_to_file(char *path);
 
#endif /* DATEL_CODES_H__ */