Merge branch 'master' into ProtoBrad

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

app/build.gradle

@@ -0,0 +1,41 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * This generated file contains a sample Java application project to get you started.
+ * For more details take a look at the 'Building Java & JVM projects' chapter in the Gradle
+ * User Manual available at https://docs.gradle.org/8.0/userguide/building_java_projects.html
+ */
+
+plugins {
+    // Apply the application plugin to add support for building a CLI application in Java.
+    id 'application'
+    id 'org.openjfx.javafxplugin' version '0.0.13'
+}
+
+repositories {
+    // Use Maven Central for resolving dependencies.
+    mavenCentral()
+}
+
+dependencies {
+    // Use JUnit Jupiter for testing.
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.1'
+
+    // This dependency is used by the application.
+    implementation 'com.google.guava:guava:31.1-jre'
+}
+
+application {
+    // Define the main class for the application.
+    mainClass = 'school_project.App'
+}
+
+javafx {
+    version = "19"
+    modules = [ 'javafx.controls' ]
+}
+
+tasks.named('test') {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}

app/src/main/java/school_project/App.java

@@ -0,0 +1,14 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package school_project;
+
+public class App {
+    public String getGreeting() {
+        return "Hello World!";
+    }
+
+    public static void main(String[] args) {
+        System.out.println(new App().getGreeting());
+    }
+}

app/src/test/java/school_project/AppTest.java

@@ -0,0 +1,14 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package school_project;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+class AppTest {
+    @Test void appHasAGreeting() {
+        App classUnderTest = new App();
+        assertNotNull(classUnderTest.getGreeting(), "app should have a greeting");
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,244 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,92 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

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 <map_name>.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
+

prototypes/saves_prototypes/parser.py

@@ -0,0 +1,197 @@
+#!/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.map_shape = [[0]]
+        self.pieces = []
+
+    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_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 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):]
+
+        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):
+        """
+        save parsed info to the file
+        """
+        save_data = b''
+        save_data += b'SMS'
+        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(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(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")
+    print("6) quit")
+    item = int(input("Select an option :"))
+    cls()
+    match item:
+        case 1:
+            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:
+            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:
+            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"
+            P.save(filename)
+        case 5:
+            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()
+    while menu(P):
+        pass

settings.gradle

@@ -0,0 +1,11 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * The settings file is used to specify which projects to include in your build.
+ *
+ * Detailed information about configuring a multi-project build in Gradle can be found
+ * in the user manual at https://docs.gradle.org/8.0/userguide/multi_project_builds.html
+ */
+
+rootProject.name = 'School_Project'
+include('app')