Unit Tests & Minimap Toggle

.gitignore

@@ -4,4 +4,8 @@ saves/*/*.json
 saves/*/rooms/*.json
 saves/*/roompngs/*.png
 saves/*/mapImage.png
-output.txt
+output.txt
+.coverage
+tests/stats/*.json
+cov.xml
+tests/*/*.json

format.sh

@@ -0,0 +1,4 @@
+black src
+black tests
+autoflake --in-place --remove-all-unused-imports --remove-unused-variables -r src
+autoflake --in-place --remove-all-unused-imports --remove-unused-variables -r tests

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+pythonpath = .
+            src
+            src/entity

run.sh

@@ -1,18 +1,60 @@
-# get the latest version of the code
-echo "Pulling latest version of code from GitHub"
-git pull
+# /bin/bash
+# Usage: ./run.sh
 
-# print branch status
-echo "Current branch: $(git branch --show-current)"
+getLatest() {
+    # get the latest version of the code
+    echo "Pulling latest version of code from GitHub"
+    git pull
+    echo ""
+}
 
-# read in and print version
-echo "Current version: $(cat version.txt)"
+printBranchStatus() {
+    # print the current branch
+    echo "Current branch: $(git branch --show-current)"
+    echo ""
+}
 
-# check that dependencies are installed
-echo "Checking dependencies"
-pip install pygame --pre --quiet
-pip install -r requirements.txt --quiet
+printVersion() {
+    # print the current version
+    echo "Current version: $(cat version.txt)"
+    echo ""
+}
 
-# start program
-echo "Starting program"
-python src/roam.py > output.txt
+checkDependencies() {
+    # check that dependencies are installed
+    echo "Checking dependencies"
+    if ! command -v python &> /dev/null
+    then
+        echo "Python could not be found. Download it from https://www.python.org/downloads/"
+        exit
+    fi
+    if ! command -v pip &> /dev/null
+    then
+        echo "Pip could not be found. Download it from https://pip.pypa.io/en/stable/installation/ or run 'python -m ensurepip' in a terminal"
+        exit
+    fi
+    pip install pygame --pre --quiet
+    pip install -r requirements.txt --quiet
+    echo ""
+}
+
+runTests() {
+    # run tests
+    echo "Running tests"
+    python -m pytest
+    echo ""
+}
+
+startProgram() {
+    # start program
+    echo "Starting program"
+    python src/roam.py > output.txt
+}
+
+# main
+getLatest
+printBranchStatus
+printVersion
+checkDependencies
+runTests
+startProgram

src/config/config.py

@@ -8,21 +8,21 @@ def __init__(self):
         # static (cannot be changed in game)
         self.displayWidth = pygame.display.Info().current_h * 0.90
         self.displayHeight = pygame.display.Info().current_h * 0.90
-        self.black = (0,0,0)
-        self.white = (255,255,255)
+        self.black = (0, 0, 0)
+        self.white = (255, 255, 255)
         self.playerMovementEnergyCost = 0.2
-        self.playerInteractionEnergyCost= 0.05
+        self.playerInteractionEnergyCost = 0.05
         self.runSpeedFactor = 2
         self.energyDepletionRate = 0.01
         self.playerInteractionDistanceLimit = 5
         self.ticksPerSecond = 30
         self.gridSize = 17
-        self.worldBorder = 0 # 0 = no border
+        self.worldBorder = 0  # 0 = no border
         self.pathToSaveDirectory = "saves/defaultsavefile"
 
         # dynamic (can be changed in game)
         self.debug = True
         self.fullscreen = False
         self.autoEatFoodInInventory = True
-        self.generateMapImage = True
-        self.removeDeadEntities = True
+        self.removeDeadEntities = True
+        self.showMiniMap = True

src/entity/apple.py

@@ -6,8 +6,8 @@
 # @since August 8th, 2022
 class Apple(Food):
     def __init__(self):
-       Food.__init__(self, "Apple", "assets/apple.png", random.randrange(5, 11))
-       self.solid = False
-    
+        Food.__init__(self, "Apple", "assets/images/apple.png", random.randrange(5, 11))
+        self.solid = False
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/banana.py

@@ -6,8 +6,10 @@
 # @since January 28th, 2023
 class Banana(Food):
     def __init__(self):
-       Food.__init__(self, "Banana", "assets/banana.png", random.randrange(10, 20))
-       self.solid = False
-
+        Food.__init__(
+            self, "Banana", "assets/images/banana.png", random.randrange(10, 20)
+        )
+        self.solid = False
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/coalOre.py

@@ -1,13 +1,12 @@
-import random
 from entity.drawableEntity import DrawableEntity
 
 
 # @author Daniel McCoy Stephenson
 # @since August 18th, 2022
 class CoalOre(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Coal Ore", "assets/coalOre.png")
+        DrawableEntity.__init__(self, "Coal Ore", "assets/images/coalOre.png")
         self.solid = True
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/drawableEntity.py

@@ -8,12 +8,12 @@ class DrawableEntity(Entity):
     def __init__(self, name, imagePath):
         Entity.__init__(self, name)
         self.imagePath = imagePath
-    
+
     def getImage(self):
         return pygame.image.load(self.imagePath)
 
     def getImagePath(self):
         return self.imagePath
-    
+
     def setImagePath(self, imagePath):
-        self.imagePath = imagePath
+        self.imagePath = imagePath

src/entity/food.py

@@ -7,6 +7,6 @@ class Food(DrawableEntity):
     def __init__(self, name, color, energy):
         DrawableEntity.__init__(self, name, color)
         self.energy = energy
-    
+
     def getEnergy(self):
-        return self.energy
+        return self.energy

src/entity/grass.py

@@ -5,8 +5,8 @@
 # @since August 8th, 2022
 class Grass(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Grass", "assets/grass.png")
+        DrawableEntity.__init__(self, "Grass", "assets/images/grass.png")
         self.solid = False
 
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/ironOre.py

@@ -1,13 +1,12 @@
-import random
 from entity.drawableEntity import DrawableEntity
 
 
 # @author Daniel McCoy Stephenson
 # @since August 18th, 2022
 class IronOre(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Iron Ore", "assets/ironOre.png")
+        DrawableEntity.__init__(self, "Iron Ore", "assets/images/ironOre.png")
         self.solid = True
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/jungleWood.py

@@ -5,8 +5,8 @@
 # @since August 8th, 2022
 class JungleWood(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Jungle Wood", "assets/jungleWood.png")
+        DrawableEntity.__init__(self, "Jungle Wood", "assets/images/jungleWood.png")
         self.solid = True
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/leaves.py

@@ -5,8 +5,8 @@
 # @since August 8th, 2022
 class Leaves(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Leaves", "assets/leaves.png")
+        DrawableEntity.__init__(self, "Leaves", "assets/images/leaves.png")
         self.solid = False
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/living/bear.py

@@ -8,8 +8,15 @@
 # @since December 24th, 2022
 class Bear(LivingEntity):
     def __init__(self, tickCreated):
-        LivingEntity.__init__(self, "Bear", "assets/bear.png", random.randrange(20, 30), [Chicken, Player], tickCreated)
+        LivingEntity.__init__(
+            self,
+            "Bear",
+            "assets/images/bear.png",
+            random.randrange(20, 30),
+            [Chicken, Player],
+            tickCreated,
+        )
         self.solid = False
 
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/living/chicken.py

@@ -7,8 +7,15 @@
 # @since July 7th, 2022
 class Chicken(LivingEntity):
     def __init__(self, tickCreated):
-        LivingEntity.__init__(self, "Chicken", "assets/chicken.png", random.randrange(20, 30), [Grass], tickCreated)
+        LivingEntity.__init__(
+            self,
+            "Chicken",
+            "assets/images/chicken.png",
+            random.randrange(20, 30),
+            [Grass],
+            tickCreated,
+        )
         self.solid = False
 
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/living/livingEntity.py

@@ -11,7 +11,7 @@ def __init__(self, name, color, energy, edibleEntityTypes, tickCreated):
         self.targetEnergy = energy
         self.tickCreated = tickCreated
         self.tickLastReproduced = None
-    
+
     def getEnergy(self):
         return self.energy
 
@@ -28,7 +28,7 @@ def addEnergy(self, amount):
             self.energy = 100
         else:
             self.energy += amount
-    
+
     def removeEnergy(self, amount):
         if self.energy - amount < 0:
             self.energy = 0
@@ -37,30 +37,33 @@ def removeEnergy(self, amount):
 
     def needsEnergy(self):
         return self.energy < self.targetEnergy * 0.50
-    
+
     def getTargetEnergy(self):
         return self.targetEnergy
 
+    def setTargetEnergy(self, targetEnergy):
+        self.targetEnergy = targetEnergy
+
     def canEat(self, entity):
         for entityType in self.edibleEntityTypes:
             if type(entity) is entityType:
                 return True
         return False
-    
+
     def kill(self):
         self.energy = 0
-    
+
     def getTickCreated(self):
         return self.tickCreated
-    
+
     def setTickCreated(self, tick):
         self.tickCreated = tick
-    
+
     def getAge(self, tick):
         return tick - self.tickCreated
-    
+
     def getTickLastReproduced(self):
         return self.tickLastReproduced
-    
+
     def setTickLastReproduced(self, tick):
-        self.tickLastReproduced = tick
+        self.tickLastReproduced = tick

src/entity/oakWood.py

@@ -5,8 +5,8 @@
 # @since August 8th, 2022
 class OakWood(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Oak Wood", "assets/oakWood.png")
+        DrawableEntity.__init__(self, "Oak Wood", "assets/images/oakWood.png")
         self.solid = True
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid

src/entity/stone.py

@@ -1,13 +1,12 @@
-import random
 from entity.drawableEntity import DrawableEntity
 
 
 # @author Daniel McCoy Stephenson
 # @since August 18th, 2022
 class Stone(DrawableEntity):
     def __init__(self):
-        DrawableEntity.__init__(self, "Stone", "assets/stone.png")
+        DrawableEntity.__init__(self, "Stone", "assets/images/stone.png")
         self.solid = True
-    
+
     def isSolid(self):
-        return self.solid
+        return self.solid