├── assets ├── mockup.png ├── tile_0.png ├── tile_1.png ├── tile_2.png ├── tile_3.png ├── tile_4.png ├── tile_5.png ├── tile_6.png ├── tile_7.png ├── tile_8.png ├── tile_empty.png ├── tile_flag.png ├── tile_mine.png ├── tile_uncleared.png ├── tile_0.xbm ├── tile_1.xbm ├── tile_2.xbm ├── tile_3.xbm ├── tile_4.xbm ├── tile_5.xbm ├── tile_6.xbm ├── tile_7.xbm ├── tile_8.xbm ├── tile_flag.xbm ├── tile_mine.xbm ├── tile_uncleared.xbm └── asset ├── img └── screenshot.png ├── minesweeper_icon.png ├── application.fam ├── README.md ├── assets.h ├── minesweeper.c └── LICENSE /assets/mockup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/mockup.png -------------------------------------------------------------------------------- /assets/tile_0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_0.png -------------------------------------------------------------------------------- /assets/tile_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_1.png -------------------------------------------------------------------------------- /assets/tile_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_2.png -------------------------------------------------------------------------------- /assets/tile_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_3.png -------------------------------------------------------------------------------- /assets/tile_4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_4.png -------------------------------------------------------------------------------- /assets/tile_5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_5.png -------------------------------------------------------------------------------- /assets/tile_6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_6.png -------------------------------------------------------------------------------- /assets/tile_7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_7.png -------------------------------------------------------------------------------- /assets/tile_8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_8.png -------------------------------------------------------------------------------- /img/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/img/screenshot.png -------------------------------------------------------------------------------- /assets/tile_empty.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_empty.png -------------------------------------------------------------------------------- /assets/tile_flag.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_flag.png -------------------------------------------------------------------------------- /assets/tile_mine.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_mine.png -------------------------------------------------------------------------------- /minesweeper_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/minesweeper_icon.png -------------------------------------------------------------------------------- /assets/tile_uncleared.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/panki27/minesweeper/HEAD/assets/tile_uncleared.png -------------------------------------------------------------------------------- /assets/tile_0.xbm: -------------------------------------------------------------------------------- 1 | #define tile_0_width 8 2 | #define tile_0_height 8 3 | static char tile_0_bits[] = { 4 | 0x00, 0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_1.xbm: -------------------------------------------------------------------------------- 1 | #define tile_1_width 8 2 | #define tile_1_height 8 3 | static uint8_t tile_1_bits[] = { 4 | 0x00, 0x10, 0x18, 0x10, 0x10, 0x10, 0x10, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_2.xbm: -------------------------------------------------------------------------------- 1 | #define tile_2_width 8 2 | #define tile_2_height 8 3 | static uint8_t tile_2_bits[] = { 4 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x04, 0x3C, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_3.xbm: -------------------------------------------------------------------------------- 1 | #define tile_3_width 8 2 | #define tile_3_height 8 3 | static uint8_t tile_3_bits[] = { 4 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x20, 0x1C, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_4.xbm: -------------------------------------------------------------------------------- 1 | #define tile_4_width 8 2 | #define tile_4_height 8 3 | static uint8_t tile_4_bits[] = { 4 | 0x00, 0x04, 0x14, 0x14, 0x3C, 0x10, 0x10, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_5.xbm: -------------------------------------------------------------------------------- 1 | #define tile_5_width 8 2 | #define tile_5_height 8 3 | static uint8_t tile_5_bits[] = { 4 | 0x00, 0x3C, 0x04, 0x1C, 0x20, 0x20, 0x1C, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_6.xbm: -------------------------------------------------------------------------------- 1 | #define tile_6_width 8 2 | #define tile_6_height 8 3 | static uint8_t tile_6_bits[] = { 4 | 0x00, 0x18, 0x24, 0x04, 0x1C, 0x24, 0x18, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_7.xbm: -------------------------------------------------------------------------------- 1 | #define tile_7_width 8 2 | #define tile_7_height 8 3 | static uint8_t tile_7_bits[] = { 4 | 0x00, 0x3C, 0x20, 0x20, 0x10, 0x08, 0x08, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_8.xbm: -------------------------------------------------------------------------------- 1 | #define tile_8_width 8 2 | #define tile_8_height 8 3 | static uint8_t tile_8_bits[] = { 4 | 0x00, 0x18, 0x24, 0x18, 0x24, 0x24, 0x18, 0x00, }; 5 | -------------------------------------------------------------------------------- /assets/tile_flag.xbm: -------------------------------------------------------------------------------- 1 | #define tile_flag_width 8 2 | #define tile_flag_height 8 3 | static uint8_t tile_flag_bits[] = { 4 | 0xFF, 0x81, 0xB9, 0x89, 0x89, 0x9D, 0x81, 0xFF, }; 5 | -------------------------------------------------------------------------------- /assets/tile_mine.xbm: -------------------------------------------------------------------------------- 1 | #define tile_mine_width 8 2 | #define tile_mine_height 8 3 | static uint8_t tile_mine_bits[] = { 4 | 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, }; 5 | -------------------------------------------------------------------------------- /assets/tile_uncleared.xbm: -------------------------------------------------------------------------------- 1 | #define tile_uncleared_width 8 2 | #define tile_uncleared_height 8 3 | static uint8_t tile_uncleared_bits[] = { 4 | 0xFF, 0x81, 0x81, 0x81, 0x81, 0x81, 0x81, 0xFF, }; 5 | -------------------------------------------------------------------------------- /application.fam: -------------------------------------------------------------------------------- 1 | App( 2 | appid="minesweeper", 3 | name="Minesweeper", 4 | apptype=FlipperAppType.PLUGIN, 5 | entry_point="minesweeper_app", 6 | cdefines=["APP_MINESWEEPER"], 7 | requires=["gui"], 8 | stack_size=8 * 1024, 9 | fap_category="Games", 10 | fap_icon="minesweeper_icon.png", 11 | order=35, 12 | ) 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Minesweeper 2 | 3 | This is a Minesweeper implementation for the Flipper Zero device. 4 | 5 | ![screenshot](img/screenshot.png) 6 | 7 | ## Controls 8 | 9 | - Arrow buttons to move 10 | - Push center button to open field 11 | - Hold center button to toggle flag 12 | - Push center button on an already open field that has the correct amount of flags surrounding it to auto-open the remaining ones (thanks @gelin!) 13 | 14 | ## Compiling 15 | 16 | ``` 17 | ./fbt firmware_minesweeper 18 | ``` 19 | -------------------------------------------------------------------------------- /assets.h: -------------------------------------------------------------------------------- 1 | #define tile_0_width 8 2 | #define tile_0_height 8 3 | static uint8_t tile_0_bits[] = { 4 | 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, }; 5 | #define tile_1_width 8 6 | #define tile_1_height 8 7 | static uint8_t tile_1_bits[] = { 8 | 0x00, 0x10, 0x18, 0x10, 0x10, 0x10, 0x10, 0x00, }; 9 | #define tile_2_width 8 10 | #define tile_2_height 8 11 | static uint8_t tile_2_bits[] = { 12 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x04, 0x3C, 0x00, }; 13 | #define tile_3_width 8 14 | #define tile_3_height 8 15 | static uint8_t tile_3_bits[] = { 16 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x20, 0x1C, 0x00, }; 17 | #define tile_4_width 8 18 | #define tile_4_height 8 19 | static uint8_t tile_4_bits[] = { 20 | 0x00, 0x04, 0x14, 0x14, 0x3C, 0x10, 0x10, 0x00, }; 21 | #define tile_5_width 8 22 | #define tile_5_height 8 23 | static uint8_t tile_5_bits[] = { 24 | 0x00, 0x3C, 0x04, 0x1C, 0x20, 0x20, 0x1C, 0x00, }; 25 | #define tile_6_width 8 26 | #define tile_6_height 8 27 | static uint8_t tile_6_bits[] = { 28 | 0x00, 0x18, 0x24, 0x04, 0x1C, 0x24, 0x18, 0x00, }; 29 | #define tile_7_width 8 30 | #define tile_7_height 8 31 | static uint8_t tile_7_bits[] = { 32 | 0x00, 0x3C, 0x20, 0x20, 0x10, 0x08, 0x08, 0x00, }; 33 | #define tile_8_width 8 34 | #define tile_8_height 8 35 | static uint8_t tile_8_bits[] = { 36 | 0x00, 0x18, 0x24, 0x18, 0x24, 0x24, 0x18, 0x00, }; 37 | #define tile_flag_width 8 38 | #define tile_flag_height 8 39 | static uint8_t tile_flag_bits[] = { 40 | 0xFF, 0x81, 0xB9, 0x89, 0x89, 0x9D, 0x81, 0xFF, }; 41 | #define tile_mine_width 8 42 | #define tile_mine_height 8 43 | static uint8_t tile_mine_bits[] = { 44 | 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, }; 45 | #define tile_uncleared_width 8 46 | #define tile_uncleared_height 8 47 | static uint8_t tile_uncleared_bits[] = { 48 | 0xFF, 0x81, 0x81, 0x81, 0x81, 0x81, 0x81, 0xFF, }; 49 | -------------------------------------------------------------------------------- /assets/asset: -------------------------------------------------------------------------------- 1 | #define tile_0_width 8 2 | #define tile_0_height 8 3 | static uint8_t tile_0_bits[] = { 4 | 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, }; 5 | #define tile_1_width 8 6 | #define tile_1_height 8 7 | static uint8_t tile_1_bits[] = { 8 | 0x00, 0x10, 0x18, 0x10, 0x10, 0x10, 0x10, 0x00, }; 9 | #define tile_2_width 8 10 | #define tile_2_height 8 11 | static uint8_t tile_2_bits[] = { 12 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x04, 0x3C, 0x00, }; 13 | #define tile_3_width 8 14 | #define tile_3_height 8 15 | static uint8_t tile_3_bits[] = { 16 | 0x00, 0x1C, 0x20, 0x20, 0x18, 0x20, 0x1C, 0x00, }; 17 | #define tile_4_width 8 18 | #define tile_4_height 8 19 | static uint8_t tile_4_bits[] = { 20 | 0x00, 0x04, 0x14, 0x14, 0x3C, 0x10, 0x10, 0x00, }; 21 | #define tile_5_width 8 22 | #define tile_5_height 8 23 | static uint8_t tile_5_bits[] = { 24 | 0x00, 0x3C, 0x04, 0x1C, 0x20, 0x20, 0x1C, 0x00, }; 25 | #define tile_6_width 8 26 | #define tile_6_height 8 27 | static uint8_t tile_6_bits[] = { 28 | 0x00, 0x18, 0x24, 0x04, 0x1C, 0x24, 0x18, 0x00, }; 29 | #define tile_7_width 8 30 | #define tile_7_height 8 31 | static uint8_t tile_7_bits[] = { 32 | 0x00, 0x3C, 0x20, 0x20, 0x10, 0x08, 0x08, 0x00, }; 33 | #define tile_8_width 8 34 | #define tile_8_height 8 35 | static uint8_t tile_8_bits[] = { 36 | 0x00, 0x18, 0x24, 0x18, 0x24, 0x24, 0x18, 0x00, }; 37 | #define tile_flag_width 8 38 | #define tile_flag_height 8 39 | static uint8_t tile_flag_bits[] = { 40 | 0xFF, 0x81, 0xB9, 0x89, 0x89, 0x9D, 0x81, 0xFF, }; 41 | #define tile_mine_width 8 42 | #define tile_mine_height 8 43 | static uint8_t tile_mine_bits[] = { 44 | 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, 0x55, 0xAA, }; 45 | #define tile_uncleared_width 8 46 | #define tile_uncleared_height 8 47 | static uint8_t tile_uncleared_bits[] = { 48 | 0xFF, 0x81, 0x81, 0x81, 0x81, 0x81, 0x81, 0xFF, }; 49 | -------------------------------------------------------------------------------- /minesweeper.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | 7 | #include 8 | #include 9 | #include 10 | 11 | #include "assets.h" 12 | 13 | #define PLAYFIELD_WIDTH 16 14 | #define PLAYFIELD_HEIGHT 7 15 | #define TILE_WIDTH 8 16 | #define TILE_HEIGHT 8 17 | 18 | #define MINECOUNT 20 19 | 20 | typedef enum { 21 | EventTypeTick, 22 | EventTypeKey, 23 | } EventType; 24 | 25 | typedef struct { 26 | EventType type; 27 | InputEvent input; 28 | } PluginEvent; 29 | 30 | typedef enum { 31 | TileType0, // this HAS to be in order, for hint assignment to be ez pz 32 | TileType1, 33 | TileType2, 34 | TileType3, 35 | TileType4, 36 | TileType5, 37 | TileType6, 38 | TileType7, 39 | TileType8, 40 | TileTypeUncleared, 41 | TileTypeFlag, 42 | TileTypeMine 43 | } TileType; 44 | 45 | typedef enum { 46 | FieldEmpty, 47 | FieldMine 48 | } Field; 49 | 50 | typedef struct { 51 | Field minefield[PLAYFIELD_WIDTH][PLAYFIELD_HEIGHT]; 52 | TileType playfield[PLAYFIELD_WIDTH][PLAYFIELD_HEIGHT]; 53 | FuriTimer* timer; 54 | int cursor_x; 55 | int cursor_y; 56 | int mines_left; 57 | int fields_cleared; 58 | int flags_set; 59 | bool game_started; 60 | uint32_t game_started_tick; 61 | } Minesweeper; 62 | 63 | static void timer_callback(void* ctx) { 64 | UNUSED(ctx); 65 | NotificationApp* notification = furi_record_open(RECORD_NOTIFICATION); 66 | notification_message(notification, &sequence_reset_vibro); 67 | furi_record_close(RECORD_NOTIFICATION); 68 | } 69 | 70 | static void input_callback(InputEvent* input_event, FuriMessageQueue* event_queue) { 71 | furi_assert(event_queue); 72 | 73 | PluginEvent event = {.type = EventTypeKey, .input = *input_event}; 74 | furi_message_queue_put(event_queue, &event, FuriWaitForever); 75 | } 76 | 77 | static void render_callback(Canvas* const canvas, void* ctx) { 78 | const Minesweeper* minesweeper_state = acquire_mutex((ValueMutex*)ctx, 25); 79 | if (minesweeper_state == NULL) { 80 | return; 81 | } 82 | FuriString* mineStr; 83 | FuriString* timeStr; 84 | mineStr = furi_string_alloc(); 85 | timeStr = furi_string_alloc(); 86 | 87 | furi_string_printf(mineStr, "Mines: %d", MINECOUNT - minesweeper_state->flags_set); 88 | canvas_set_font(canvas, FontSecondary); 89 | canvas_draw_str_aligned(canvas, 0, 0, AlignLeft, AlignTop, furi_string_get_cstr(mineStr)); 90 | 91 | int seconds = 0; 92 | int minutes = 0; 93 | if (minesweeper_state->game_started) { 94 | uint32_t ticks_elapsed = furi_get_tick() - minesweeper_state->game_started_tick; 95 | seconds = (int) ticks_elapsed / furi_kernel_get_tick_frequency(); 96 | minutes = (int) seconds / 60; 97 | seconds = seconds % 60; 98 | } 99 | furi_string_printf(timeStr, "%01d:%02d", minutes, seconds); 100 | canvas_draw_str_aligned(canvas, 128, 0, AlignRight, AlignTop, furi_string_get_cstr(timeStr)); 101 | 102 | uint8_t* tile_to_draw; 103 | 104 | for (int y = 0; y < PLAYFIELD_HEIGHT; y++) { 105 | for (int x = 0; x < PLAYFIELD_WIDTH; x++) { 106 | if ( x == minesweeper_state->cursor_x && y == minesweeper_state->cursor_y) { 107 | canvas_invert_color(canvas); 108 | } 109 | switch (minesweeper_state->playfield[x][y]) { 110 | case TileType0: 111 | tile_to_draw = tile_0_bits; 112 | break; 113 | case TileType1: 114 | tile_to_draw = tile_1_bits; 115 | break; 116 | case TileType2: 117 | tile_to_draw = tile_2_bits; 118 | break; 119 | case TileType3: 120 | tile_to_draw = tile_3_bits; 121 | break; 122 | case TileType4: 123 | tile_to_draw = tile_4_bits; 124 | break; 125 | case TileType5: 126 | tile_to_draw = tile_5_bits; 127 | break; 128 | case TileType6: 129 | tile_to_draw = tile_6_bits; 130 | break; 131 | case TileType7: 132 | tile_to_draw = tile_7_bits; 133 | break; 134 | case TileType8: 135 | tile_to_draw = tile_8_bits; 136 | break; 137 | case TileTypeFlag: 138 | tile_to_draw = tile_flag_bits; 139 | break; 140 | case TileTypeUncleared: 141 | tile_to_draw = tile_uncleared_bits; 142 | break; 143 | case TileTypeMine: 144 | tile_to_draw = tile_mine_bits; 145 | break; 146 | default: 147 | // this should never happen 148 | tile_to_draw = tile_mine_bits; 149 | break; 150 | } 151 | canvas_draw_xbm( 152 | canvas, 153 | x*TILE_HEIGHT, // x 154 | 8 + (y * TILE_WIDTH), // y 155 | TILE_WIDTH, 156 | TILE_HEIGHT, 157 | tile_to_draw); 158 | if ( x == minesweeper_state->cursor_x && y == minesweeper_state->cursor_y) { 159 | canvas_invert_color(canvas); 160 | } 161 | } 162 | } 163 | 164 | furi_string_free(mineStr); 165 | furi_string_free(timeStr); 166 | release_mutex((ValueMutex*)ctx, minesweeper_state); 167 | } 168 | 169 | static void setup_playfield(Minesweeper* minesweeper_state) { 170 | int mines_left = MINECOUNT; 171 | for (int y = 0; y < PLAYFIELD_HEIGHT; y++) { 172 | for (int x = 0; x < PLAYFIELD_WIDTH; x++){ 173 | minesweeper_state->minefield[x][y] = FieldEmpty; 174 | minesweeper_state->playfield[x][y] = TileTypeUncleared; 175 | } 176 | } 177 | while(mines_left > 0) { 178 | int rand_x = rand() % PLAYFIELD_WIDTH; 179 | int rand_y = rand() % PLAYFIELD_HEIGHT; 180 | // make sure first guess isn't a mine 181 | if (minesweeper_state->minefield[rand_x][rand_y] == FieldEmpty && 182 | (minesweeper_state->cursor_x != rand_x && minesweeper_state->cursor_y != rand_y )) { 183 | minesweeper_state->minefield[rand_x][rand_y] = FieldMine; 184 | mines_left--; 185 | } 186 | } 187 | minesweeper_state->mines_left = MINECOUNT; 188 | minesweeper_state->fields_cleared = 0; 189 | minesweeper_state->flags_set = 0; 190 | minesweeper_state->game_started_tick = furi_get_tick(); 191 | minesweeper_state->game_started = false; 192 | } 193 | 194 | static void place_flag(Minesweeper* minesweeper_state) { 195 | if (minesweeper_state->playfield[minesweeper_state->cursor_x][minesweeper_state->cursor_y] == TileTypeUncleared) { 196 | minesweeper_state->playfield[minesweeper_state->cursor_x][minesweeper_state->cursor_y] = TileTypeFlag; 197 | minesweeper_state->flags_set++; 198 | } else if (minesweeper_state->playfield[minesweeper_state->cursor_x][minesweeper_state->cursor_y] == TileTypeFlag) { 199 | minesweeper_state->playfield[minesweeper_state->cursor_x][minesweeper_state->cursor_y] = TileTypeUncleared; 200 | minesweeper_state->flags_set--; 201 | } 202 | } 203 | 204 | static bool game_lost(Minesweeper* minesweeper_state) { 205 | // returns true if the player wants to restart, otherwise false 206 | DialogsApp *dialogs = furi_record_open(RECORD_DIALOGS); 207 | 208 | DialogMessage* message = dialog_message_alloc(); 209 | const char* header_text = "Game Over"; 210 | const char* message_text = "You hit a mine!"; 211 | 212 | dialog_message_set_header(message, header_text, 64, 3, AlignCenter, AlignTop); 213 | dialog_message_set_text(message, message_text, 64, 32, AlignCenter, AlignCenter); 214 | dialog_message_set_buttons(message, NULL, "Play again", NULL); 215 | 216 | dialog_message_set_icon(message, NULL, 0, 10); 217 | 218 | NotificationApp* notifications = furi_record_open(RECORD_NOTIFICATION); 219 | notification_message(notifications, &sequence_set_vibro_on); 220 | furi_record_close(RECORD_NOTIFICATION); 221 | furi_timer_start(minesweeper_state->timer, (uint32_t) furi_kernel_get_tick_frequency() * 0.2); 222 | 223 | DialogMessageButton choice = dialog_message_show(dialogs, message); 224 | dialog_message_free(message); 225 | furi_record_close(RECORD_DIALOGS); 226 | 227 | return choice == DialogMessageButtonCenter; 228 | } 229 | 230 | static bool game_won(Minesweeper* minesweeper_state) { 231 | DialogsApp *dialogs = furi_record_open(RECORD_DIALOGS); 232 | 233 | FuriString* tempStr; 234 | tempStr = furi_string_alloc(); 235 | 236 | int seconds = 0; 237 | int minutes = 0; 238 | uint32_t ticks_elapsed = furi_get_tick() - minesweeper_state->game_started_tick; 239 | seconds = (int) ticks_elapsed / furi_kernel_get_tick_frequency(); 240 | minutes = (int) seconds / 60; 241 | seconds = seconds % 60; 242 | 243 | DialogMessage* message = dialog_message_alloc(); 244 | const char* header_text = "Game won!"; 245 | furi_string_cat_printf(tempStr, "Minefield cleared in %01d:%02d", minutes, seconds); 246 | dialog_message_set_header(message, header_text, 64, 3, AlignCenter, AlignTop); 247 | dialog_message_set_text(message, furi_string_get_cstr(tempStr), 64, 32, AlignCenter, AlignCenter); 248 | dialog_message_set_buttons(message, NULL, "Play again", NULL); 249 | dialog_message_set_icon(message, NULL, 72, 17); 250 | 251 | DialogMessageButton choice = dialog_message_show(dialogs, message); 252 | dialog_message_free(message); 253 | furi_string_free(tempStr); 254 | furi_record_close(RECORD_DIALOGS); 255 | return choice == DialogMessageButtonCenter; 256 | } 257 | 258 | // returns false if the move loses the game - otherwise true 259 | static bool play_move(Minesweeper* minesweeper_state, int cursor_x, int cursor_y) { 260 | if (minesweeper_state->playfield[cursor_x][cursor_y] == TileTypeFlag) { 261 | // we're on a flagged field, do nothing 262 | return true; 263 | } 264 | if (minesweeper_state->minefield[cursor_x][cursor_y] == FieldMine) { 265 | // player loses - draw mine 266 | minesweeper_state->playfield[cursor_x][cursor_y] = TileTypeMine; 267 | return false; 268 | } 269 | 270 | if (minesweeper_state->playfield[cursor_x][cursor_y] >= TileType1 && minesweeper_state->playfield[cursor_x][cursor_y] <= TileType8) { 271 | // click on a cleared cell with a number 272 | // count the flags around 273 | int flags = 0; 274 | for (int y = cursor_y-1; y <= cursor_y+1; y++) { 275 | for (int x = cursor_x-1; x <= cursor_x+1; x++) { 276 | if ( x == cursor_x && y == cursor_y ) { 277 | // we're on the cell the user selected, so ignore. 278 | continue; 279 | } 280 | // make sure we don't go OOB 281 | if ( x >= 0 && x < PLAYFIELD_WIDTH && y >= 0 && y < PLAYFIELD_HEIGHT) { 282 | if (minesweeper_state->playfield[x][y] == TileTypeFlag) { 283 | flags ++; 284 | } 285 | } 286 | } 287 | } 288 | int mines = minesweeper_state->playfield[cursor_x][cursor_y]; // ¯\_(ツ)_/¯ 289 | if (flags == mines) { 290 | // auto uncover all non-flags around (to win faster ;) 291 | for (int auto_y = cursor_y-1; auto_y <= cursor_y+1; auto_y++) { 292 | for (int auto_x = cursor_x-1; auto_x <= cursor_x+1; auto_x++) { 293 | if ( auto_x == cursor_x && auto_y == cursor_y ) { 294 | continue; 295 | } 296 | if ( auto_x >= 0 && auto_x < PLAYFIELD_WIDTH && auto_y >= 0 && auto_y < PLAYFIELD_HEIGHT) { 297 | if (minesweeper_state->playfield[auto_x][auto_y] == TileTypeUncleared) { 298 | if(!play_move(minesweeper_state, auto_x, auto_y)) { 299 | // flags were wrong, we got a mine! 300 | return false; 301 | } 302 | } 303 | } 304 | } 305 | } 306 | // we're done without hitting a mine - so return 307 | return true; 308 | } 309 | } 310 | 311 | // calculate number of surrounding mines. 312 | int hint = 0; 313 | for (int y = cursor_y-1; y <= cursor_y+1; y++) { 314 | for (int x = cursor_x-1; x <= cursor_x+1; x++) { 315 | if ( x == cursor_x && y == cursor_y ) { 316 | // we're on the cell the user selected, so ignore. 317 | continue; 318 | } 319 | // make sure we don't go OOB 320 | if ( x >= 0 && x < PLAYFIELD_WIDTH && y >= 0 && y < PLAYFIELD_HEIGHT) { 321 | if(minesweeper_state->minefield[x][y] == FieldMine) { 322 | hint ++; 323 | } 324 | } 325 | } 326 | } 327 | // 〜(￣▽￣〜) don't judge me (〜￣▽￣)〜 328 | minesweeper_state->playfield[cursor_x][cursor_y] = hint; 329 | minesweeper_state->fields_cleared++; 330 | FURI_LOG_D("Minesweeper", "Setting %d,%d to %d", cursor_x, cursor_y, hint); 331 | if (hint == 0) { 332 | // the field is "empty" 333 | // auto open surrounding fields. 334 | for (int auto_y = cursor_y-1; auto_y <= cursor_y+1; auto_y++) { 335 | for (int auto_x = cursor_x-1; auto_x <= cursor_x+1; auto_x++) { 336 | if ( auto_x == cursor_x && auto_y == cursor_y ) { 337 | continue; 338 | } 339 | if ( auto_x >= 0 && auto_x < PLAYFIELD_WIDTH && auto_y >= 0 && auto_y < PLAYFIELD_HEIGHT) { 340 | if (minesweeper_state->playfield[auto_x][auto_y] == TileTypeUncleared) { 341 | play_move(minesweeper_state, auto_x, auto_y); 342 | } 343 | } 344 | } 345 | } 346 | } 347 | return true; 348 | } 349 | 350 | static void minesweeper_state_init(Minesweeper* const minesweeper_state) { 351 | minesweeper_state->cursor_x = minesweeper_state->cursor_y = 0; 352 | minesweeper_state->game_started = false; 353 | for (int y = 0; y < PLAYFIELD_HEIGHT; y++) { 354 | for (int x = 0; x < PLAYFIELD_WIDTH; x++){ 355 | minesweeper_state->playfield[x][y] = TileTypeUncleared; 356 | } 357 | } 358 | } 359 | 360 | int32_t minesweeper_app(void* p) { 361 | UNUSED(p); 362 | DialogsApp *dialogs = furi_record_open(RECORD_DIALOGS); 363 | 364 | DialogMessage* message = dialog_message_alloc(); 365 | const char* header_text = "Minesweeper"; 366 | const char* message_text = "Hold OK pressed to toggle flags.\ngithub.com/panki27"; 367 | 368 | dialog_message_set_header(message, header_text, 64, 3, AlignCenter, AlignTop); 369 | dialog_message_set_text(message, message_text, 64, 32, AlignCenter, AlignCenter); 370 | dialog_message_set_buttons(message, NULL, "Play", NULL); 371 | 372 | dialog_message_set_icon(message, NULL, 0, 10); 373 | 374 | dialog_message_show(dialogs, message); 375 | dialog_message_free(message); 376 | furi_record_close(RECORD_DIALOGS); 377 | 378 | FuriMessageQueue* event_queue = furi_message_queue_alloc(8, sizeof(PluginEvent)); 379 | 380 | Minesweeper* minesweeper_state = malloc(sizeof(Minesweeper)); 381 | // setup 382 | minesweeper_state_init(minesweeper_state); 383 | 384 | ValueMutex state_mutex; 385 | if (!init_mutex(&state_mutex, minesweeper_state, sizeof(minesweeper_state))) { 386 | FURI_LOG_E("Minesweeper", "cannot create mutex\r\n"); 387 | free(minesweeper_state); 388 | return 255; 389 | } 390 | // BEGIN IMPLEMENTATION 391 | 392 | // Set system callbacks 393 | ViewPort* view_port = view_port_alloc(); 394 | view_port_draw_callback_set(view_port, render_callback, &state_mutex); 395 | view_port_input_callback_set(view_port, input_callback, event_queue); 396 | minesweeper_state->timer = furi_timer_alloc(timer_callback, FuriTimerTypeOnce, &state_mutex); 397 | 398 | // Open GUI and register view_port 399 | Gui* gui = furi_record_open("gui"); 400 | gui_add_view_port(gui, view_port, GuiLayerFullscreen); 401 | 402 | PluginEvent event; 403 | for (bool processing = true; processing;) { 404 | FuriStatus event_status = furi_message_queue_get(event_queue, &event, 100); 405 | Minesweeper* minesweeper_state = (Minesweeper*)acquire_mutex_block(&state_mutex); 406 | if(event_status == FuriStatusOk) { 407 | // press events 408 | if(event.type == EventTypeKey) { 409 | if(event.input.type == InputTypeShort) { 410 | switch(event.input.key) { 411 | case InputKeyUp: 412 | minesweeper_state->cursor_y--; 413 | if(minesweeper_state->cursor_y < 0) { 414 | minesweeper_state->cursor_y = PLAYFIELD_HEIGHT - 1; 415 | } 416 | break; 417 | case InputKeyDown: 418 | minesweeper_state->cursor_y++; 419 | if(minesweeper_state->cursor_y >= PLAYFIELD_HEIGHT) { 420 | minesweeper_state->cursor_y = 0; 421 | } 422 | break; 423 | case InputKeyRight: 424 | minesweeper_state->cursor_x++; 425 | if(minesweeper_state->cursor_x >= PLAYFIELD_WIDTH) { 426 | minesweeper_state->cursor_x = 0; 427 | } 428 | break; 429 | case InputKeyLeft: 430 | minesweeper_state->cursor_x--; 431 | if(minesweeper_state->cursor_x < 0) { 432 | minesweeper_state->cursor_x = PLAYFIELD_WIDTH-1; 433 | } 434 | break; 435 | case InputKeyOk: 436 | if (!minesweeper_state->game_started) { 437 | setup_playfield(minesweeper_state); 438 | minesweeper_state->game_started = true; 439 | } 440 | if (!play_move(minesweeper_state, minesweeper_state->cursor_x, minesweeper_state->cursor_y)) { 441 | // ooops. looks like we hit a mine! 442 | if (game_lost(minesweeper_state)) { 443 | // player wants to restart. 444 | setup_playfield(minesweeper_state); 445 | } else { 446 | // player wants to exit :( 447 | processing = false; 448 | } 449 | } else { 450 | // check win condition. 451 | if (minesweeper_state->fields_cleared == (PLAYFIELD_HEIGHT*PLAYFIELD_WIDTH) - MINECOUNT){ 452 | if (game_won(minesweeper_state)) { 453 | //player wants to restart 454 | setup_playfield(minesweeper_state); 455 | } else { 456 | processing = false; 457 | } 458 | } 459 | } 460 | break; 461 | case InputKeyBack: 462 | // Exit the plugin 463 | processing = false; 464 | break; 465 | case InputKeyMAX: 466 | break; 467 | } 468 | } else if (event.input.type == InputTypeLong) { 469 | // hold events 470 | FURI_LOG_D("Minesweeper", "Got a long press!"); 471 | switch(event.input.key) { 472 | case InputKeyUp: 473 | case InputKeyDown: 474 | case InputKeyRight: 475 | case InputKeyLeft: 476 | break; 477 | case InputKeyOk: 478 | FURI_LOG_D("Minesweeper", "Toggling flag"); 479 | place_flag(minesweeper_state); 480 | break; 481 | case InputKeyBack: 482 | processing = false; 483 | break; 484 | case InputKeyMAX: 485 | break; 486 | } 487 | } 488 | } 489 | } else { 490 | // event timeout 491 | ; 492 | } 493 | view_port_update(view_port); 494 | release_mutex(&state_mutex, minesweeper_state); 495 | } 496 | view_port_enabled_set(view_port, false); 497 | gui_remove_view_port(gui, view_port); 498 | furi_record_close("gui"); 499 | view_port_free(view_port); 500 | furi_message_queue_free(event_queue); 501 | delete_mutex(&state_mutex); 502 | furi_timer_free(minesweeper_state->timer); 503 | free(minesweeper_state); 504 | 505 | return 0; 506 | } 507 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------