From 56cde5623e79d6811c44f1ca61a2b732ecb58f43 Mon Sep 17 00:00:00 2001 From: Debucquoy Date: Tue, 14 Feb 2023 15:21:43 +0100 Subject: [PATCH 1/4] WIP: prototype for saves --- prototypes/saves_prototypes/README | 35 +++++++++++++++++ prototypes/saves_prototypes/parser.py | 56 +++++++++++++++++++++++++++ prototypes/saves_prototypes/test.map | 1 + 3 files changed, 92 insertions(+) create mode 100644 prototypes/saves_prototypes/README create mode 100644 prototypes/saves_prototypes/parser.py create mode 100644 prototypes/saves_prototypes/test.map diff --git a/prototypes/saves_prototypes/README b/prototypes/saves_prototypes/README new file mode 100644 index 0000000..606b9f6 --- /dev/null +++ b/prototypes/saves_prototypes/README @@ -0,0 +1,35 @@ +# Prototypes Saves files + +This prototype is aiming at defining a structure for saving "map" files. + +The objective is to have it quite modular so that if we want to add more level we can easily do so. + +Another objective is that theses files are as small as possible without missing information. + +## What needs to be saved + +We need to have the shape of the map itself and the shape and number of each pieces it is a minimum + +I also want to define an header (and maybe a footer) to the file so that it is easier to recover if any corruption occure to a drive +(we all been trough that) + +## Method + +I would like to save a file as byte so I need to have a bitewise parser. This is the objective of this prototype + +## Structure + +The map file should have the following structure: +- The file should be named .shmap (where shmap stand for shape map) +- The file should start with the ascii characters S, M then S (0x534D53) +- The file should end with the ascii characters S, M then E (0x534D45) +- First we define the map shape + 1) the map should always be a square. the lenght of this square will be the first octet after the header. + 2) next we have s x s (where s is the size of the square) bits (1/0) where + - 0 represent an empty cell (where we can place a shape) + - 1 represent a filled cell (where we can't place a shape) +- Next we define the amount of shape for this level with a number on one octet +- Next we define each shapes with the same method defined previously for a map + +With all that we should have all that is needed for a level to work... further information could be added later this is just a prototype atm + diff --git a/prototypes/saves_prototypes/parser.py b/prototypes/saves_prototypes/parser.py new file mode 100644 index 0000000..78a96ba --- /dev/null +++ b/prototypes/saves_prototypes/parser.py @@ -0,0 +1,56 @@ +class MapNotSquareException(Exception): + pass + +class PieceNotSquareException(Exception): + pass + +class save_Parser: + def __init__(self, filename:str ): + self.filename = filename + self.map_shape = [[0]] + self.pieces = list() + + def define_map(self, map_shape): + size = len(map_shape) + for row in map_shape: + if size != len(row): + raise MapNotSquareException + self.map_shape = map_shape + + def add_piece(self, piece_shape): + size = len(piece_shape) + for row in piece_shape: + if size != len(row): + raise PieceNotSquareException + self.pieces.append(piece_shape) + + def __str__(self): + return str(self.map_shape) + + def shape_to_bytes(self, shape): + bytes_ammount = len(shape) // 8 + bytes_trash = len(shape) % 8 + tray = 0 + + def load(self): + """ + load the file and prepare to parse informations + """ + + def save(self): + """ + save parsed info to the file + """ + save_data = b'' + save_data += b'SMS' + save_data += bytes(len(map_shape)) + save_data += shape_to_bytes(self.map_shape) + save_data += bytes() + save_data += b'SME' + with open(self.filename, mode='bw') as file: + file.write(save_data) + +if __name__ == "__main__": + p = save_Parser('test.map') + p.define_map([[0,1],[0,1]]) + p.save() diff --git a/prototypes/saves_prototypes/test.map b/prototypes/saves_prototypes/test.map new file mode 100644 index 0000000..406295c --- /dev/null +++ b/prototypes/saves_prototypes/test.map @@ -0,0 +1 @@ +SMSSME \ No newline at end of file From c6d7e148df518fc2bbd20130ee1a7e02fd13d5bd Mon Sep 17 00:00:00 2001 From: Debucquoy Date: Tue, 14 Feb 2023 16:27:02 +0100 Subject: [PATCH 2/4] save parser finished --- prototypes/saves_prototypes/parser.py | 23 ++++++++++++++++------- prototypes/saves_prototypes/test.map | 2 +- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/prototypes/saves_prototypes/parser.py b/prototypes/saves_prototypes/parser.py index 78a96ba..6adf531 100644 --- a/prototypes/saves_prototypes/parser.py +++ b/prototypes/saves_prototypes/parser.py @@ -27,10 +27,14 @@ class save_Parser: def __str__(self): return str(self.map_shape) - def shape_to_bytes(self, shape): - bytes_ammount = len(shape) // 8 - bytes_trash = len(shape) % 8 + def shape_to_bytes(self, shape_matrix): + shape_list = [b for r in shape_matrix for b in r] + byte_ammount = len(shape_list) // 8 + 1 tray = 0 + for i in shape_list: + tray = (tray << 1) | i + return tray.to_bytes(byte_ammount, 'big') + def load(self): """ @@ -43,14 +47,19 @@ class save_Parser: """ save_data = b'' save_data += b'SMS' - save_data += bytes(len(map_shape)) - save_data += shape_to_bytes(self.map_shape) - save_data += bytes() + save_data += len(self.map_shape).to_bytes(1, 'big') + save_data += self.shape_to_bytes(self.map_shape) + save_data += len(self.pieces).to_bytes(1, 'big') + for piece in self.pieces: + save_data +=len(piece).to_bytes(1, 'big') + save_data += self.shape_to_bytes(piece) save_data += b'SME' with open(self.filename, mode='bw') as file: file.write(save_data) if __name__ == "__main__": p = save_Parser('test.map') - p.define_map([[0,1],[0,1]]) + p.define_map([[1,0,1],[1,1,1], [1,0,0]]) + p.add_piece([[0, 1],[0, 1]]) p.save() + # print(p.shape_to_bytes([[1,0,1],[1,1,1], [1,0,0]])) diff --git a/prototypes/saves_prototypes/test.map b/prototypes/saves_prototypes/test.map index 406295c..fff7b49 100644 --- a/prototypes/saves_prototypes/test.map +++ b/prototypes/saves_prototypes/test.map @@ -1 +1 @@ -SMSSME \ No newline at end of file +SMS|SME \ No newline at end of file From 56ee3e943cd1aea61d9bd08965bb38f54a7b8489 Mon Sep 17 00:00:00 2001 From: Debucquoy Date: Fri, 17 Feb 2023 17:02:34 +0100 Subject: [PATCH 3/4] wip: menu --- prototypes/saves_prototypes/parser.py | 64 ++++++++++++++++++++++----- prototypes/saves_prototypes/test.map | 1 - 2 files changed, 53 insertions(+), 12 deletions(-) delete mode 100644 prototypes/saves_prototypes/test.map diff --git a/prototypes/saves_prototypes/parser.py b/prototypes/saves_prototypes/parser.py index 6adf531..f08c2ae 100644 --- a/prototypes/saves_prototypes/parser.py +++ b/prototypes/saves_prototypes/parser.py @@ -1,11 +1,20 @@ +import os + class MapNotSquareException(Exception): - pass + """ + Matrix used is not a Square and cannot be interpretted as a piece + """ -class PieceNotSquareException(Exception): - pass +class PieceNotSquareException(Exception): + """ + Matrix used is not a Square and cannot be interpretted as a piece + """ -class save_Parser: - def __init__(self, filename:str ): +class SaveParser: + """ + Parser for the game file + """ + def __init__(self): self.filename = filename self.map_shape = [[0]] self.pieces = list() @@ -41,7 +50,7 @@ class save_Parser: load the file and prepare to parse informations """ - def save(self): + def save(self, filename): """ save parsed info to the file """ @@ -54,12 +63,45 @@ class save_Parser: save_data +=len(piece).to_bytes(1, 'big') save_data += self.shape_to_bytes(piece) save_data += b'SME' - with open(self.filename, mode='bw') as file: + with open(filename, mode='bw') as file: file.write(save_data) +def cls(): + 'clear the screen' + for _ in range(os.get_terminal_size()[1]): + print() + +def menu(): + """draw a simple menu to test the SaveParser class""" + + P = SaveParser() + + print("1) define terrain") + print("2) add a piece") + print("3) show data") + print("4) save data") + print("5) load data") + item = input("Select an option :") + cls() + match item: + case 1: + pass + case 2: + pass + case 3: + pass + case 4: + filename = input('enter the file name (default: default.smap):') + filename = filename if filename else "default.smap" + P.save(filename) + case 5: + filename = input('enter the file name (default: default.smap):') + filename = filename if filename else "default.smap" + P.load(filename) if __name__ == "__main__": - p = save_Parser('test.map') - p.define_map([[1,0,1],[1,1,1], [1,0,0]]) - p.add_piece([[0, 1],[0, 1]]) - p.save() + cls() + # p = SaveParser('test.smap') + # p.define_map([[1,0,1],[1,1,1], [1,0,0]]) + # p.add_piece([[0, 1],[0, 1]]) + # p.save() # print(p.shape_to_bytes([[1,0,1],[1,1,1], [1,0,0]])) diff --git a/prototypes/saves_prototypes/test.map b/prototypes/saves_prototypes/test.map deleted file mode 100644 index fff7b49..0000000 --- a/prototypes/saves_prototypes/test.map +++ /dev/null @@ -1 +0,0 @@ -SMS|SME \ No newline at end of file From a74c78d8a9573c99476697440805897d7de493d8 Mon Sep 17 00:00:00 2001 From: Anthony Debucquoy Date: Mon, 20 Feb 2023 12:37:04 +0100 Subject: [PATCH 4/4] finishing prototype --- prototypes/saves_prototypes/parser.py | 122 ++++++++++++++++++++++---- 1 file changed, 106 insertions(+), 16 deletions(-) mode change 100644 => 100755 prototypes/saves_prototypes/parser.py diff --git a/prototypes/saves_prototypes/parser.py b/prototypes/saves_prototypes/parser.py old mode 100644 new mode 100755 index f08c2ae..736c426 --- a/prototypes/saves_prototypes/parser.py +++ b/prototypes/saves_prototypes/parser.py @@ -1,23 +1,26 @@ +#!/bin/python import os + class MapNotSquareException(Exception): """ Matrix used is not a Square and cannot be interpretted as a piece """ + class PieceNotSquareException(Exception): """ Matrix used is not a Square and cannot be interpretted as a piece """ + class SaveParser: """ Parser for the game file """ def __init__(self): - self.filename = filename self.map_shape = [[0]] - self.pieces = list() + self.pieces = [] def define_map(self, map_shape): size = len(map_shape) @@ -44,11 +47,49 @@ class SaveParser: tray = (tray << 1) | i return tray.to_bytes(byte_ammount, 'big') + def bytes_to_shape(self, bytes_list, map_size): + list_octet = [] + for octet in bytes_list: + octet_data = list(f"{octet:08b}") + [list_octet.append(d) for d in octet_data] + list_octet = list_octet[-(map_size**2):] - def load(self): + matrix = [] + for i in range(map_size): + matrix.append([]) + for j in range(map_size): + matrix[i].append(list_octet.pop(0)) + return matrix + + def load(self, filename): """ load the file and prepare to parse informations """ + with open(filename, mode='br') as file: + data = list(file.read()) + + data_pos = [0, 0] + for i in range(len(data)): + if data[i] == 83 and data[i+1] == 77 and data[i+2] == 83: # SMS + data_pos[0] = i+3 + break + for i in range(data_pos[0], len(data)): + if data[i] == 83 and data[i+1] == 77 and data[i+2] == 69: # SME + data_pos[1] = i + break + map_data = data[data_pos[0]:data_pos[1]] + self.define_map(self.bytes_to_shape(map_data[1:((map_data[0]**2)//8)+2], map_data[0])) + map_data = map_data[(map_data[0]**2) // 8 + 2:] + pieces_ammount = map_data.pop(0) + for i in range(pieces_ammount): + print(map_data) + piece_size = map_data.pop(0) + print(piece_size) + piece_data = map_data[:(piece_size**2) // 8 + 1] + print(piece_data) + map_data = map_data[(map_data[0]**2) // 8 + 2:] + print(map_data) + self.add_piece(self.bytes_to_shape(piece_data, piece_size)) def save(self, filename): """ @@ -60,36 +101,82 @@ class SaveParser: save_data += self.shape_to_bytes(self.map_shape) save_data += len(self.pieces).to_bytes(1, 'big') for piece in self.pieces: - save_data +=len(piece).to_bytes(1, 'big') + save_data += len(piece).to_bytes(1, 'big') save_data += self.shape_to_bytes(piece) save_data += b'SME' with open(filename, mode='bw') as file: file.write(save_data) + +def show_matrix(matrix, highlight: tuple = None): + """ + :matrix: matrix to draw + :highlight: tuple of the coordinates to hightligh + """ + size = len(matrix) + h_x, h_y = None, None + if highlight: + h_x, h_y = highlight + if size != len(matrix[0]): + print("ERROR: The matrix is not square") + return + + line_str = "+" + ''.join(['-+' for _ in range(size)]) + + for k, x in enumerate(matrix): + print(line_str) + print('|', end="") + for l, y in enumerate(x): + if k == h_x and l == h_y: + print("\033[42m", end="") + print(str(y) + "\033[00m" + '|', end="") + print() + print(line_str) + + def cls(): 'clear the screen' for _ in range(os.get_terminal_size()[1]): print() -def menu(): - """draw a simple menu to test the SaveParser class""" - P = SaveParser() +def menu(P): + """draw a simple menu to test the SaveParser class""" print("1) define terrain") print("2) add a piece") print("3) show data") print("4) save data") print("5) load data") - item = input("Select an option :") + print("6) quit") + item = int(input("Select an option :")) cls() match item: case 1: - pass + size = int(input("what is the size of the map: ")) + P.map_shape = [[0 for _ in range(size)] for _ in range(size)] + for i in range(size): + for j in range(size): + cls() + show_matrix(P.map_shape, (i,j)) + P.map_shape[i][j] = int(input("0: empty; 1: filled :")) case 2: - pass + size = int(input("what is the size of the piece: ")) + temp = [[0 for _ in range(size)] for _ in range(size)] + for i in range(size): + for j in range(size): + cls() + show_matrix(temp, (i,j)) + temp[i][j] = int(input("0: empty; 1: filled :")) + P.add_piece(temp) case 3: - pass + if P.map_shape: + print("map:") + show_matrix(P.map_shape) + for i, v in enumerate(P.pieces): + print() + print(f"piece {i+1}") + show_matrix(v) case 4: filename = input('enter the file name (default: default.smap):') filename = filename if filename else "default.smap" @@ -98,10 +185,13 @@ def menu(): filename = input('enter the file name (default: default.smap):') filename = filename if filename else "default.smap" P.load(filename) + case 6: + return False + return True + + if __name__ == "__main__": cls() - # p = SaveParser('test.smap') - # p.define_map([[1,0,1],[1,1,1], [1,0,0]]) - # p.add_piece([[0, 1],[0, 1]]) - # p.save() - # print(p.shape_to_bytes([[1,0,1],[1,1,1], [1,0,0]])) + P = SaveParser() + while menu(P): + pass