Develop

.gitignore

@@ -1,2 +1,3 @@
 *.pyc
-output.txt
+output.txt
+*.json

README.md

@@ -1,26 +1,38 @@
 # Ophidian
 This game allows you to control an ever-increasingly growing ophidian in a virtual environment. 
 
+## Running the Game
+To run the game:
+```
+python run.py
+``` 
+
+## Running Tests
+To run the test suite:
+```
+python -m pytest tests
+``` 
+
 ## Controls
-Key | Action
------------- | -------------
-w | move up
-a | move left
-s | move down
-d | move right
-f11 | fullscreen
-l | toggle tick speed limit
-r | restart
-q | quit
+| Key | Action                  |
+|-----|-------------------------|
+| w   | move up                 |
+| a   | move left               |
+| s   | move down               |
+| d   | move right              |
+| f11 | fullscreen              |
+| l   | toggle tick speed limit |
+| r   | restart                 |
+| q   | quit                    |
 
 ## Support
 You can find the support discord server [here](https://discord.gg/49J4RHQxhy).
 
 ## Authors and acknowledgement
 ### Developers
-Name | Main Contributions
------------- | -------------
-Daniel Stephenson | Creator
+| Name              | Main Contributions |
+|-------------------|--------------------|
+| Daniel Stephenson | Creator            |
 
 ## Libraries
-This project makes use of [graphik](https://github.com/Preponderous-Software/graphik) and [py_env_lib](https://github.com/Preponderous-Software/py_env_lib).
+This project makes use of [graphik](https://github.com/Preponderous-Software/graphik) and [py_env_lib](https://github.com/Preponderous-Software/py_env_lib).

run.py

@@ -0,0 +1,11 @@
+import sys
+import os
+
+# Add the project root directory to Python path
+sys.path.append(os.path.dirname(os.path.abspath(__file__)))
+
+from src.ophidian import Ophidian
+
+if __name__ == "__main__":
+    ophidian = Ophidian()
+    ophidian.run()

src/config/config.py

@@ -7,26 +7,24 @@
 class Config:
     def __init__(self):
         # display
-        self.displayWidth = 500
-        self.displayHeight = 500
+        self.display_width = 500
+        self.display_height = 500
         self.fullscreen = False
         self.black = (0, 0, 0)
         self.white = (255, 255, 255)
         self.green = (0, 255, 0)
         self.red = (255, 0, 0)
         self.yellow = (255, 255, 0)
-        self.textSize = 50
+        self.text_size = 50
 
         # grid size
-        self.gridSize = 5
-        self.minGridSize = 5
-        self.maxGridSize = 12
+        self.initial_grid_size = 5
 
         # tick speed
-        self.limitTickSpeed = True
-        self.tickSpeed = 0.1
+        self.limit_tick_speed = True
+        self.tick_speed = 0.1
 
         # misc
         self.debug = False
-        self.restartUponCollision = True
-        self.levelProgressPercentageRequired = 0.5
+        self.restart_upon_collision = True
+        self.level_progress_percentage_required = 0.25

src/environment/environmentRepository.py

@@ -0,0 +1,107 @@
+from abc import ABC, abstractmethod
+from typing import Optional, Any
+
+
+class EnvironmentRepository(ABC):
+    """Interface defining environment operations for the game"""
+
+    @abstractmethod
+    def get_rows(self) -> int:
+        """Returns the number of rows in the environment grid"""
+        pass
+
+    @abstractmethod
+    def get_columns(self) -> int:
+        """Returns the number of columns in the environment grid"""
+        pass
+
+    @abstractmethod
+    def get_locations(self) -> list:
+        """Returns all locations in the environment"""
+        pass
+
+    @abstractmethod
+    def get_location(self, x: int, y: int) -> Any:
+        """Returns location at the specified coordinates"""
+        pass
+
+    @abstractmethod
+    def get_num_locations(self):
+        pass
+
+    @abstractmethod
+    def get_location_of_entity(self, entity) -> Optional[Any]:
+        """Returns the location of the specified entity"""
+        pass
+
+    @abstractmethod
+    def get_location_above_entity(self, entity):
+        pass
+
+    @abstractmethod
+    def get_location_left_of_entity(self, entity):
+        pass
+
+    @abstractmethod
+    def get_location_below_entity(self, entity):
+        pass
+
+    @abstractmethod
+    def get_location_right_of_entity(self, entity):
+        pass
+
+    @abstractmethod
+    def get_location_in_random_direction(self, location):
+        pass
+
+    @abstractmethod
+    def get_location_in_direction_of_entity(self, param, snakePart):
+        pass
+
+    @abstractmethod
+    def get_random_location(self) -> Any:
+        """Returns a random location in the environment"""
+        pass
+
+    @abstractmethod
+    def add_entity_to_random_location(self, selectedSnakePart):
+        pass
+
+    @abstractmethod
+    def add_entity_to_location(self, entity, location: Any) -> None:
+        """Adds an entity to the specified location"""
+        pass
+
+    @abstractmethod
+    def remove_entity_from_location(self, entity) -> None:
+        """Removes an entity from its current location"""
+        pass
+
+    @abstractmethod
+    def get_location_by_id(self, locationId):
+        pass
+
+
+    @abstractmethod
+    def spawn_snake_part(self, snake_part, color):
+        pass
+
+    @abstractmethod
+    def spawn_food(self):
+        pass
+
+    @abstractmethod
+    def move_entity(self, entity, direction):
+        pass
+
+    @abstractmethod
+    def move_previous_snake_part(self, snake_part):
+        pass
+
+    @abstractmethod
+    def clear(self):
+        pass
+
+    @abstractmethod
+    def reinitialize(self, level: int) -> None:
+        pass