Thursday!

Author: primal-coder

.gitignore

@@ -158,5 +158,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-src/grid/grid.py
 src/profiler.txt

.idea/.gitignore

@@ -0,0 +1 @@
+3.12-dev

.idea/grid-engine.iml

@@ -1 +1,59 @@
-# grid-engine
+# grid-engine
+
+## Description
+
+The **grid-engine** package provides classes for generating and manipulating grids. The grid-engine package is divided into two subpackages: **grid blueprint** and **grid**. The **grid blueprint** subpackage provides classes for generating and manipulating blueprints, which are the foundation of Grid objects created using this module. The **grid** subpackage provides classes for generating and manipulating Grid objects, which are the foundation of the grid engine.
+
+## Usage
+
+To use this package, import the necessary classes and functions. Here's an example:
+
+```python
+import grid_engine
+from grid_engine import grid
+
+# Create a grid
+grid = grid.Grid(cell_size=10, grid_dimensions=(1000, 1000))
+
+# Save a grid
+grid.save_grid()
+
+# Load a grid
+loaded_grid = grid.Grid.load_grid(1)
+```
+
+grid-engine also provides a command line interface. To use it, run the following command:
+
+```bash
+python -m grid_engine --help
+
+# Output:
+# usage: grid [-h] [-i] [-b BLUEPRINT] [--ascii] [-l LOAD] [-t] [-ns NOISE_SCALE] [-no NOISE_OCTAVES] [-nr NOISE_ROUGHNESS] [-r ROWS] [-c COLUMNS] [-s SIZE] [-S] [-T TYPE] [-v]
+
+# Generate a visualized grid from a blueprint. For producing a blueprint, see the blueprint module.
+
+# options:
+#   -h, --help            show this help message and exit
+#   -i, --interactive     Run an interactive session
+#   -b BLUEPRINT, --blueprint BLUEPRINT
+#                         Load a blueprint from a file
+#   --ascii               Print the grid as ascii
+#   -l LOAD, --load LOAD  Load a grid from a file
+#   -t, --terrain         Whether to generate terrain with the grid.
+#   -ns NOISE_SCALE, --noise-scale NOISE_SCALE
+#                         Noise scale
+#   -no NOISE_OCTAVES, --noise-octaves NOISE_OCTAVES
+#                         Noise octaves
+#   -nr NOISE_ROUGHNESS, --noise-roughness NOISE_ROUGHNESS
+#                         Noise roughness
+#   -r ROWS, --rows ROWS  Number of rows in the grid
+#   -c COLUMNS, --columns COLUMNS
+#                         Number of columns in the grid
+#   -s SIZE, --size SIZE  Size of each cell in the grid
+#   -S, --save            Save the grid object to a file
+#   -T TYPE, --type TYPE  Type of file to save the grid as
+#   -v, --verbose         Verbose output
+``````
+
+![grid](src/grid/terrain_grids/test_joe6.png)
+

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1 @@
+3.12-dev

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,104 @@
+# Blueprint Package
+
+## Description
+
+The **Blueprint** package provides classes for generating and manipulating blueprints, which are the foundation of Grid objects created using the parent module, [grid engine](https://github.com/primal-coder/grid-engine.git).
+
+## Usage
+To use this package, import the necessary classes and functions. Here's an example:
+
+```
+from grid_engine.blueprint.grid_blueprint import BaseGridBlueprint, TerrainGridBlueprint
+
+# Create a base grid blueprint
+base_blueprint = BaseGridBlueprint(cell_size=10, grid_dimensions=(1000, 1000))
+
+# Create a terrain grid blueprint
+terrain_blueprint = TerrainGridBlueprint(cell_size=10, grid_dimensions=(1000, 1000), noise_scale=25, noise_octaves=38, noise_roughness=0.35)
+
+# Save a blueprint
+base_blueprint.save_blueprint()
+
+# Load a blueprint
+loaded_blueprint = BaseGridBlueprint.load_blueprint(1)
+```
+
+# Classes
+## BaseGridBlueprint
+
+The BaseGridBlueprint class represents a base blueprint. It provides methods for initializing, setting the dimensions and size of the grid, and accessing and modifying the grid's cells and layers. The coordinates of the cells, by default, extend from the bottom left corner of the grid. The grid is divided into quadrants, which are used to facilitate the processing of the grid. The grid is also represented as a graph, which is used to facilitate pathfinding.
+
+### Properties
+- cell_size: Returns the size of a cell.
+- grid_dimensions: Returns the dimensions of the grid.
+- col_count: Returns the number of columns in the grid.
+- grid_width: Returns the width of the grid.
+- row_count: Returns the number of rows in the grid.
+- grid_height: Returns the height of the grid.
+- rank: Returns the rank(rows) of the grid.
+- file: Returns the file(columns) of the grid.
+- cell_list: Returns the list of cells.
+- array: Returns the array of cells.
+- dictGrid: Returns the dictionary of cells.
+- dictTerrain: Returns the dictionary of terrain information.
+- cell_coordinates: Returns the coordinates of the cells.
+- quadrants: Returns the quadrants of the grid.
+- graph: Returns the graph of the grid.
+
+## TerrainGridBlueprint
+
+The TerrainGridBlueprint class represents a terrain grid blueprint. It inherits from the BaseGridBlueprint class and adds methods for initializing the terrain layer of the blueprint and adjusting the passability of cells based on terrain.
+
+### Properties
+Inherits all properties from the BaseGridBlueprint class.
+
+# Extras 
+
+The grid_blueprint makes use of the following modules and files:
+
+## grid_processing
+
+The grid_processing module is used by grid_blueprint to facilitate the processing of grids. It provides functions for generating many of the characteristics of the blueprint object.
+
+### Functions
+
+- generate_row_strings: Generates a list of row strings. (i.e. ['a', 'b', 'c', ... , 'z', 'aa', 'ab', ... , 'az', 'ba', 'bb', ...])
+- generate_column_strings: Generates a list of column strings. Column strings are padded to 5 characters. (i.e. ['00001', '00002', '00003', ... , '00009', '00010', '00011', ... , '00099', '00100', '00101', ...])
+- generate_cell_strings: Generates a list of cells. (i.e. ['a00001', 'a00002', 'a00003', ... , 'a00009', 'a00010', 'a00011', ... , 'a00099', 'a00100', 'a00101', ...])
+- get_cell_coordinates: Returns the coordinates of a cell.
+- get_grid_dict: Returns a dictionary of cells.
+- generate_quadrant_coordinates: Calculates the coordinates of the quadrants for the grid.
+- get_quadrant_indices: Assigns quadrant indices.
+- generate_adjacency: Generates the adjacency data for the grid.
+- get_graph: Returns the graph of the grid.
+- process_grid: Performs all grid processing functions and returns a dictionary containing the processed grid data.
+
+## terrain_processing
+
+The terrain_processing module is used by grid_blueprint to facilitate the processing of terrain data. It provides functions for generating the terrain layer of the blueprint object.
+
+### Functions
+
+- load_terrain: Loads terrain data from a file.
+- diamond_square: Generates a height map using the diamond-square algorithm.
+- perlin_noise: Generates a height map using the perlin noise algorithm.
+- generate_terrain_dict: Generates a dictionary of terrain data.
+
+## terrains.json
+
+The terrains.json file contains the terrain data used by the terrain_processing module. It is a dictionary of terrain types. The data is structured as follows:
+
+```
+{
+    "terrain_type": {
+        "raw_max" : 0.0,
+        "int": 0,
+        "color": "COLOR_IDENTIFIER",
+        "cost_in": 0,
+        "cost_out": 0,
+        "char": ""
+    }
+}
+```
+
+You can add or remove terrain types from this file to change the terrain types available to the terrain_processing module. Colors can be specified using a color identifier (i.e. "GRASS_GREEN") or a RGBA tuple (i.e (255, 255, 255, 255)).

.idea/misc.xml

@@ -175,7 +175,7 @@ def get_grid_dict(cell_strings: List[str], row_strings: List[str], col_strings:
         } for i, cell in enumerate(cell_strings)
     }
 
-def get_quadrant_coordinates(row_count: int, col_count: int) -> List[List[Tuple[int, int]]]:
+def generate_quadrant_coordinates(row_count: int, col_count: int) -> List[List[Tuple[int, int]]]:
     """
     Get the coordinates of each quadrant in a grid.
 
@@ -242,7 +242,7 @@ def get_quadrant_indices(quadrant_coords: List[List[Tuple[int,int]]], grid_dict:
                 grid_dict[cell]['quadrant_index'] = i
     return grid_dict
 
-def get_adjacency(grid_dict: Dict[str, any], row_count: int, col_count: int) -> Dict[str, Any]:
+def generate_adjacency(grid_dict: Dict[str, any], row_count: int, col_count: int) -> Dict[str, Any]:
     """
     Assign adjacent cells to each cell in a grid.
 

.idea/modules.xml

@@ -11,8 +11,10 @@
     'GRASS_GREEN': (84, 139, 84, 255),
     'PLAIN_GREEN': (90, 154, 90, 255),
     'FOOTHILL_GREEN': (82, 144, 78, 255),
-    'SEASHELL_WHITE': (255, 245, 238, 255),
-    'SANDY_GREY': (169, 169, 169, 255),
+    'BEACH_GREEN': (99, 170, 112, 255),
+    'SEASHELL_WHITE': (249, 235, 231, 255),
+    'SANDSTONE_GREY': (169, 169, 169, 255),
+    'SANDY_GREY': (188, 182, 134),
     'MOUND_GREY': (105, 105, 105, 255),
     'BASE_GREY': (112, 128, 136, 255),
     'SIDE_GREY': (79, 83, 72, 255),

.idea/vcs.xml

@@ -1,7 +1,7 @@
 {
     "default": {
         "MOUNTAIN_PEAK": {
-            "raw_max": 0.12,
+            "raw_max": 0.1,
             "int": 0,
             "color": "SNOW_WHITE",
             "cost_in": Infinity,
@@ -17,39 +17,39 @@
             "char": "|"
         },
         "MOUNTAIN_SIDE": {
-            "raw_max": 0.18,
+            "raw_max": 0.2,
             "int": 1,
             "color": "SIDE_GREY",
             "cost_in": Infinity,
             "cost_out": 5,
             "char": "/"
         },
         "MOUNTAIN_BASE": {
-            "raw_max": 0.23,
+            "raw_max": 0.25,
             "int": 2,
             "color": "BASE_GREY",
             "cost_in": Infinity,
             "cost_out": 0,
             "char": "-"
         },
         "MOUND": {
-            "raw_max": 0.28,
+            "raw_max": 0.3,
             "int": 3,
             "color": "MOUND_GREY",
             "cost_in": 2,
             "cost_out": 0,
             "char": "_"
         },
         "FOOTHILL": {
-            "raw_max": 0.43,
+            "raw_max": 0.45,
             "int": 3,
             "color": "FOOTHILL_GREEN",
             "cost_in": 1,
             "cost_out": 0,
             "char": " "
         },
         "GRASS0": {
-            "raw_max": 0.448,
+            "raw_max": 0.475,
             "int": 4,
             "color": "GRASS_GREEN",
             "cost_in": 1,
@@ -64,18 +64,18 @@
             "cost_out": 1,
             "char": " "
         },
-        "GRASS2": {
+        "BEACH_GRASS": {
             "raw_max": 0.488,
             "int": 4,
-            "color": "GRASS_GREEN",
+            "color": "BEACH_GREEN",
             "cost_in": 1,
             "cost_out": 0,
             "char": " "
         },
-        "GRASS3": {
+        "SANDSTONE": {
             "raw_max": 0.495,
             "int": 4,
-            "color": "PLAIN_GREEN",
+            "color": "SANDSTONE_GREY",
             "cost_in": 0,
             "cost_out": 1,
             "char": " "
@@ -89,7 +89,7 @@
             "char": "."
         },
         "SEASHELL": {
-            "raw_max": 0.519,
+            "raw_max": 0.518,
             "int": 6,
             "color": "SEASHELL_WHITE",
             "cost_in": 1.5,