From 7ffa5fda8dd370d012d8ea37a553eefbdcec5711 Mon Sep 17 00:00:00 2001 From: JuanJakobo Date: Mon, 24 Oct 2022 18:17:18 +0200 Subject: [PATCH 1/3] Snake Plugin: Move structs to types header --- .../plugins/snake_game/helpers/snake_types.h | 49 +++++++++++++++++++ applications/plugins/snake_game/snake_game.c | 48 +----------------- 2 files changed, 51 insertions(+), 46 deletions(-) create mode 100644 applications/plugins/snake_game/helpers/snake_types.h diff --git a/applications/plugins/snake_game/helpers/snake_types.h b/applications/plugins/snake_game/helpers/snake_types.h new file mode 100644 index 000000000..da3638970 --- /dev/null +++ b/applications/plugins/snake_game/helpers/snake_types.h @@ -0,0 +1,49 @@ +#pragma once + +#include + +typedef struct { + // +-----x + // | + // | + // y + uint8_t x; + uint8_t y; +} Point; + +typedef enum { + GameStateLife, + + // https://melmagazine.com/en-us/story/snake-nokia-6110-oral-history-taneli-armanto + // Armanto: While testing the early versions of the game, I noticed it was hard + // to control the snake upon getting close to and edge but not crashing — especially + // in the highest speed levels. I wanted the highest level to be as fast as I could + // possibly make the device "run," but on the other hand, I wanted to be friendly + // and help the player manage that level. Otherwise it might not be fun to play. So + // I implemented a little delay. A few milliseconds of extra time right before + // the player crashes, during which she can still change the directions. And if + // she does, the game continues. + GameStateLastChance, + + GameStateGameOver, +} GameState; + +// Note: do not change without purpose. Current values are used in smart +// orthogonality calculation in `snake_game_get_turn_snake`. +typedef enum { + DirectionUp, + DirectionRight, + DirectionDown, + DirectionLeft, +} Direction; + +#define MAX_SNAKE_LEN 253 + +typedef struct { + Point points[MAX_SNAKE_LEN]; + uint16_t len; + Direction currentMovement; + Direction nextMovement; // if backward of currentMovement, ignore + Point fruit; + GameState state; +} SnakeState; diff --git a/applications/plugins/snake_game/snake_game.c b/applications/plugins/snake_game/snake_game.c index 283d017ed..fdd87b504 100644 --- a/applications/plugins/snake_game/snake_game.c +++ b/applications/plugins/snake_game/snake_game.c @@ -1,3 +1,5 @@ +#include "helpers/snake_types.h" + #include #include #include @@ -6,52 +8,6 @@ #include #include -typedef struct { - // +-----x - // | - // | - // y - uint8_t x; - uint8_t y; -} Point; - -typedef enum { - GameStateLife, - - // https://melmagazine.com/en-us/story/snake-nokia-6110-oral-history-taneli-armanto - // Armanto: While testing the early versions of the game, I noticed it was hard - // to control the snake upon getting close to and edge but not crashing — especially - // in the highest speed levels. I wanted the highest level to be as fast as I could - // possibly make the device "run," but on the other hand, I wanted to be friendly - // and help the player manage that level. Otherwise it might not be fun to play. So - // I implemented a little delay. A few milliseconds of extra time right before - // the player crashes, during which she can still change the directions. And if - // she does, the game continues. - GameStateLastChance, - - GameStateGameOver, -} GameState; - -// Note: do not change without purpose. Current values are used in smart -// orthogonality calculation in `snake_game_get_turn_snake`. -typedef enum { - DirectionUp, - DirectionRight, - DirectionDown, - DirectionLeft, -} Direction; - -#define MAX_SNAKE_LEN 253 - -typedef struct { - Point points[MAX_SNAKE_LEN]; - uint16_t len; - Direction currentMovement; - Direction nextMovement; // if backward of currentMovement, ignore - Point fruit; - GameState state; -} SnakeState; - typedef enum { EventTypeTick, EventTypeKey, From 1a34dac8bac68d95e0af5d4f8c96b2804030f74f Mon Sep 17 00:00:00 2001 From: JuanJakobo Date: Mon, 24 Oct 2022 18:20:03 +0200 Subject: [PATCH 2/3] Snake Plugin: Implement #1041, save game state on pause --- .../plugins/snake_game/application.fam | 8 +- .../snake_game/helpers/snake_file_handler.c | 143 ++++++++++++++++++ .../snake_game/helpers/snake_file_handler.h | 20 +++ applications/plugins/snake_game/snake_game.c | 6 +- 4 files changed, 174 insertions(+), 3 deletions(-) create mode 100644 applications/plugins/snake_game/helpers/snake_file_handler.c create mode 100644 applications/plugins/snake_game/helpers/snake_file_handler.h diff --git a/applications/plugins/snake_game/application.fam b/applications/plugins/snake_game/application.fam index d55f53bb1..d0378ac11 100644 --- a/applications/plugins/snake_game/application.fam +++ b/applications/plugins/snake_game/application.fam @@ -4,8 +4,12 @@ App( apptype=FlipperAppType.PLUGIN, entry_point="snake_game_app", cdefines=["APP_SNAKE_GAME"], - requires=["gui"], - stack_size=1 * 1024, + requires=[ + "gui", + "notification", + "storage", + ], + stack_size=2 * 1024, order=30, fap_icon="snake_10px.png", fap_category="Games", diff --git a/applications/plugins/snake_game/helpers/snake_file_handler.c b/applications/plugins/snake_game/helpers/snake_file_handler.c new file mode 100644 index 000000000..415c840de --- /dev/null +++ b/applications/plugins/snake_game/helpers/snake_file_handler.c @@ -0,0 +1,143 @@ +#include "snake_file_handler.h" + +#include +#include + +static void snake_game_close_file(FlipperFormat* file) { + if(file == NULL){ + furi_record_close(RECORD_STORAGE); + return; + } + flipper_format_file_close(file); + flipper_format_free(file); + furi_record_close(RECORD_STORAGE); +} + +static FlipperFormat* snake_game_open_file(Storage* storage) { + FlipperFormat* file = flipper_format_file_alloc(storage); + + if(storage_common_stat(storage, SNAKE_GAME_FILE_PATH, NULL) == FSE_OK) { + if(!flipper_format_file_open_existing(file, SNAKE_GAME_FILE_PATH)) { + snake_game_close_file(file); + return NULL; + } + } else { + if(!flipper_format_file_open_new(file, SNAKE_GAME_FILE_PATH)) { + snake_game_close_file(file); + return NULL; + } + + flipper_format_write_header_cstr(file, SNAKE_GAME_FILE_HEADER, SNAKE_GAME_FILE_ACTUAL_VERSION); + flipper_format_rewind(file); + } + return file; +} + +void snake_game_save_game_to_file(SnakeState* const snake_state) { + Storage* storage = furi_record_open(RECORD_STORAGE); + FlipperFormat* file = snake_game_open_file(storage); + + uint32_t temp = snake_state->len; + if(!flipper_format_insert_or_update_uint32(file, SNAKE_GAME_CONFIG_KEY_LEN,&temp, 1)){ + snake_game_close_file(file); + return; + } + + uint16_t array_size = snake_state->len * 2; + uint32_t temp_array[array_size]; + for(int16_t i = 0, a = 0; a < array_size && i < snake_state->len; i++){ + temp_array[a++] = snake_state->points[i].x; + temp_array[a++] = snake_state->points[i].y; + } + if(!flipper_format_insert_or_update_uint32(file, SNAKE_GAME_CONFIG_KEY_POINTS, temp_array, array_size)){ + snake_game_close_file(file); + return; + } + + temp = snake_state->currentMovement; + if(!flipper_format_insert_or_update_uint32(file, SNAKE_GAME_CONFIG_KEY_CURRENT_MOVEMENT,&temp, 1)){ + snake_game_close_file(file); + return; + } + + temp = snake_state->nextMovement; + if(!flipper_format_insert_or_update_uint32(file, SNAKE_GAME_CONFIG_KEY_NEXT_MOVEMENT,&temp, 1)){ + snake_game_close_file(file); + return; + } + + array_size = 2; + uint32_t temp_point_array[array_size]; + temp_point_array[0] = snake_state->fruit.x; + temp_point_array[1] = snake_state->fruit.y; + if(!flipper_format_insert_or_update_uint32(file, SNAKE_GAME_CONFIG_KEY_FRUIT_POINTS, temp_point_array, array_size)){ + snake_game_close_file(file); + return; + } + + snake_game_close_file(file); +} + +bool snake_game_init_game_from_file(SnakeState* const snake_state) { + Storage* storage = furi_record_open(RECORD_STORAGE); + FlipperFormat* file = snake_game_open_file(storage); + + FuriString* file_type = furi_string_alloc(); + uint32_t version = 1; + if(!flipper_format_read_header(file, file_type, &version)) { + furi_string_free(file_type); + snake_game_close_file(file); + return false; + } + furi_string_free(file_type); + + uint32_t temp; + if(!flipper_format_read_uint32(file, SNAKE_GAME_CONFIG_KEY_LEN, &temp, 1)){ + snake_game_close_file(file); + return false; + } + snake_state->len = temp; + flipper_format_delete_key(file, SNAKE_GAME_CONFIG_KEY_LEN); + + uint16_t array_size = snake_state->len * 2; + uint32_t temp_array[array_size]; + if(!flipper_format_read_uint32(file, SNAKE_GAME_CONFIG_KEY_POINTS, temp_array, array_size)){ + snake_game_close_file(file); + return false; + } + + for(int16_t i = 0, a = 0; a < array_size && i < snake_state->len; i++){ + snake_state->points[i].x = temp_array[a++]; + snake_state->points[i].y = temp_array[a++]; + } + flipper_format_delete_key(file, SNAKE_GAME_CONFIG_KEY_POINTS); + + if(!flipper_format_read_uint32(file, SNAKE_GAME_CONFIG_KEY_CURRENT_MOVEMENT, &temp, 1)){ + snake_game_close_file(file); + return false; + } + snake_state->currentMovement = temp; + flipper_format_delete_key(file, SNAKE_GAME_CONFIG_KEY_CURRENT_MOVEMENT); + + if(!flipper_format_read_uint32(file, SNAKE_GAME_CONFIG_KEY_NEXT_MOVEMENT, &temp, 1)){ + snake_game_close_file(file); + return false; + } + snake_state->nextMovement = temp; + flipper_format_delete_key(file, SNAKE_GAME_CONFIG_KEY_NEXT_MOVEMENT); + + + array_size = 2; + uint32_t temp_point_array[array_size]; + if(!flipper_format_read_uint32(file, SNAKE_GAME_CONFIG_KEY_FRUIT_POINTS, temp_point_array, array_size)){ + snake_game_close_file(file); + return false; + } + snake_state->fruit.x = temp_point_array[0]; + snake_state->fruit.y = temp_point_array[1]; + flipper_format_delete_key(file, SNAKE_GAME_CONFIG_KEY_FRUIT_POINTS); + + snake_game_close_file(file); + + return true; +} diff --git a/applications/plugins/snake_game/helpers/snake_file_handler.h b/applications/plugins/snake_game/helpers/snake_file_handler.h new file mode 100644 index 000000000..3a89114c3 --- /dev/null +++ b/applications/plugins/snake_game/helpers/snake_file_handler.h @@ -0,0 +1,20 @@ +#pragma once + +#include "snake_types.h" +#include +#include + +#define SNAKE_GAME_FILE_PATH "/ext/apps/games/snake.stat" + +#define SNAKE_GAME_FILE_HEADER "Flipper Snake plugin run file" +#define SNAKE_GAME_FILE_ACTUAL_VERSION 1 + +#define SNAKE_GAME_CONFIG_KEY_POINTS "SnakePoints" +#define SNAKE_GAME_CONFIG_KEY_LEN "SnakeLen" +#define SNAKE_GAME_CONFIG_KEY_CURRENT_MOVEMENT "CurrentMovement" +#define SNAKE_GAME_CONFIG_KEY_NEXT_MOVEMENT "NextMovement" +#define SNAKE_GAME_CONFIG_KEY_FRUIT_POINTS "FruitPoints" + +void snake_game_save_game_to_file(SnakeState* const snake_state); + +bool snake_game_init_game_from_file(SnakeState* const snake_state); diff --git a/applications/plugins/snake_game/snake_game.c b/applications/plugins/snake_game/snake_game.c index fdd87b504..0b6cd85f3 100644 --- a/applications/plugins/snake_game/snake_game.c +++ b/applications/plugins/snake_game/snake_game.c @@ -1,3 +1,4 @@ +#include "helpers/snake_file_handler.h" #include "helpers/snake_types.h" #include @@ -279,7 +280,8 @@ int32_t snake_game_app(void* p) { FuriMessageQueue* event_queue = furi_message_queue_alloc(8, sizeof(SnakeEvent)); SnakeState* snake_state = malloc(sizeof(SnakeState)); - snake_game_init_game(snake_state); + if(!snake_game_init_game_from_file(snake_state)) + snake_game_init_game(snake_state); ValueMutex state_mutex; if(!init_mutex(&state_mutex, snake_state, sizeof(SnakeState))) { @@ -334,6 +336,8 @@ int32_t snake_game_app(void* p) { } break; case InputKeyBack: + if(snake_state->state == GameStateLife) + snake_game_save_game_to_file(snake_state); processing = false; break; } From 47cbdac7b1b713e7a8ba9eeb317060cf7ba43cb1 Mon Sep 17 00:00:00 2001 From: JuanJakobo Date: Mon, 24 Oct 2022 18:20:57 +0200 Subject: [PATCH 3/3] Snake Plugin: Add highscore info --- .../snake_game/helpers/snake_file_handler.c | 26 +++++++++++++++++++ .../snake_game/helpers/snake_file_handler.h | 3 +++ .../plugins/snake_game/helpers/snake_types.h | 1 + applications/plugins/snake_game/snake_game.c | 12 ++++++--- 4 files changed, 39 insertions(+), 3 deletions(-) diff --git a/applications/plugins/snake_game/helpers/snake_file_handler.c b/applications/plugins/snake_game/helpers/snake_file_handler.c index 415c840de..efc3b2e94 100644 --- a/applications/plugins/snake_game/helpers/snake_file_handler.c +++ b/applications/plugins/snake_game/helpers/snake_file_handler.c @@ -33,6 +33,32 @@ static FlipperFormat* snake_game_open_file(Storage* storage) { return file; } +int16_t snake_game_save_score_to_file(int32_t len) { + Storage* storage = furi_record_open(RECORD_STORAGE); + FlipperFormat* file = snake_game_open_file(storage); + + len = len - 7; + int32_t temp; + if(!flipper_format_read_int32(file, SNAKE_GAME_CONFIG_HIGHSCORE, &temp, 1)){ + if(!flipper_format_insert_or_update_int32(file, SNAKE_GAME_CONFIG_HIGHSCORE, &len, 1)){ + snake_game_close_file(file); + return -1; + } + }else{ + if(len > temp){ + flipper_format_rewind(file); + if(!flipper_format_insert_or_update_int32(file, SNAKE_GAME_CONFIG_HIGHSCORE, &len, 1)){ + snake_game_close_file(file); + return -1; + } + }else{ + len = temp; + } + } + snake_game_close_file(file); + return len; +} + void snake_game_save_game_to_file(SnakeState* const snake_state) { Storage* storage = furi_record_open(RECORD_STORAGE); FlipperFormat* file = snake_game_open_file(storage); diff --git a/applications/plugins/snake_game/helpers/snake_file_handler.h b/applications/plugins/snake_game/helpers/snake_file_handler.h index 3a89114c3..fbcc7131e 100644 --- a/applications/plugins/snake_game/helpers/snake_file_handler.h +++ b/applications/plugins/snake_game/helpers/snake_file_handler.h @@ -14,6 +14,9 @@ #define SNAKE_GAME_CONFIG_KEY_CURRENT_MOVEMENT "CurrentMovement" #define SNAKE_GAME_CONFIG_KEY_NEXT_MOVEMENT "NextMovement" #define SNAKE_GAME_CONFIG_KEY_FRUIT_POINTS "FruitPoints" +#define SNAKE_GAME_CONFIG_HIGHSCORE "Highscore" + +int16_t snake_game_save_score_to_file(int32_t length); void snake_game_save_game_to_file(SnakeState* const snake_state); diff --git a/applications/plugins/snake_game/helpers/snake_types.h b/applications/plugins/snake_game/helpers/snake_types.h index da3638970..f5768311f 100644 --- a/applications/plugins/snake_game/helpers/snake_types.h +++ b/applications/plugins/snake_game/helpers/snake_types.h @@ -42,6 +42,7 @@ typedef enum { typedef struct { Point points[MAX_SNAKE_LEN]; uint16_t len; + int16_t highscore; Direction currentMovement; Direction nextMovement; // if backward of currentMovement, ignore Point fruit; diff --git a/applications/plugins/snake_game/snake_game.c b/applications/plugins/snake_game/snake_game.c index 0b6cd85f3..b316fb77d 100644 --- a/applications/plugins/snake_game/snake_game.c +++ b/applications/plugins/snake_game/snake_game.c @@ -77,18 +77,21 @@ static void snake_game_render_callback(Canvas* const canvas, void* ctx) { if(snake_state->state == GameStateGameOver) { // Screen is 128x64 px canvas_set_color(canvas, ColorWhite); - canvas_draw_box(canvas, 34, 20, 62, 24); + canvas_draw_box(canvas, 32, 20, 64, 34); canvas_set_color(canvas, ColorBlack); - canvas_draw_frame(canvas, 34, 20, 62, 24); + canvas_draw_frame(canvas, 32, 20, 64, 34); canvas_set_font(canvas, FontPrimary); canvas_draw_str(canvas, 37, 31, "Game Over"); canvas_set_font(canvas, FontSecondary); - char buffer[12]; + char buffer[18]; snprintf(buffer, sizeof(buffer), "Score: %u", snake_state->len - 7); canvas_draw_str_aligned(canvas, 64, 41, AlignCenter, AlignBottom, buffer); + + snprintf(buffer, sizeof(buffer), "Highscore: %d", snake_state->highscore); + canvas_draw_str_aligned(canvas, 64, 51, AlignCenter, AlignBottom, buffer); } release_mutex((ValueMutex*)ctx, snake_state); @@ -239,6 +242,7 @@ static void return; } else if(snake_state->state == GameStateLastChance) { snake_state->state = GameStateGameOver; + snake_state->highscore = snake_game_save_score_to_file(snake_state->len); notification_message_block(notification, &sequence_fail); return; } @@ -251,6 +255,7 @@ static void crush = snake_game_collision_with_tail(snake_state, next_step); if(crush) { snake_state->state = GameStateGameOver; + snake_state->highscore = snake_game_save_score_to_file(snake_state->len); notification_message_block(notification, &sequence_fail); return; } @@ -260,6 +265,7 @@ static void snake_state->len++; if(snake_state->len >= MAX_SNAKE_LEN) { snake_state->state = GameStateGameOver; + snake_state->highscore = snake_game_save_score_to_file(snake_state->len); notification_message_block(notification, &sequence_fail); return; }