refactor(sprites.py-file)

docs/Guides/InventoryGuide.md

@@ -33,9 +33,7 @@ The `data/inventory.json` file controls the data for all items in the inventory.
 2. Add, remove, or edit item entries using the following format:
    ```json
    {
-        ...
-       "Gold Coin": {"type": "currency", "effect": "collect", "quantity": 1},
-       ...
+       "Gold Coin": {"type": "currency", "effect": "collect", "quantity": 1}
    }
    ```
 
@@ -52,17 +50,24 @@ Each item in the inventory has the following properties:
 ### Adding a New Item Icon
 To add a new item icon to the inventory:
 
-1. Open `src/GUI/inventory_gui.py`.
-2. Locate the initializer method (`self.icons: {}`).
-3. Map the item name in `inventory.json` to the icon's location in the spritesheet. Use the following format:
+   1. Open `src/inventory_gui.py`.
+   2. Locate the initializer method (`self.icons: {}`).
+   3. Map the item name in `inventory.json` to the icon's location in the sprite sheet. Use the following format:
+
+```py
+class InventoryGUI:
 
-```python
-    "Gold Coin": self.extract_icon(0, 0),
+    def __init__(self, ):
+
+       self.icons = { "Gold Coin": self.extract_icon(0, 0) }
+
+    def extract_icon(self, x, y, size=16):
+        ...
 ```
 
 [![icons-inventory-gui.png](https://i.postimg.cc/CMNKKL8T/icons-inventory-gui.png)](https://postimg.cc/231YcYT2)
 
-4. Test the new item in-game to verify functionality and ensure no errors occur.
+   4. Test the new item in-game to verify functionality and ensure no errors occur.
 
 ## Known Issues
 

src/game_manager.py

@@ -9,7 +9,7 @@
 
 from src.settings import FPS, SCREEN_HEIGHT, SCREEN_WIDTH
 
-# import basestate for typehint
+# import base state for typehint
 from src.states.base_state import BaseState
 from src.states.game_running import GameRunning
 
@@ -29,14 +29,14 @@ def __init__(self) -> None:
         # init pygame
         pygame.init()
         self.screen = pygame.display.set_mode((SCREEN_WIDTH, SCREEN_HEIGHT))
-        pygame.display.set_caption("PySeas")
+        pygame.display.set_caption("PyCeas")
 
         self.clock = pygame.Clock()
         self.running = True
         self.events: list[pygame.event.Event] = []
         self.states_stack: list[BaseState] = []
 
-        # instanciate the initial state
+        # instantiate the initial state
         self.states_stack.append(GameRunning(self))
 
     def __str__(self) -> str:
@@ -76,11 +76,11 @@ def run(self) -> None:
         while self.running:
             self._handle_events()
 
-            # give the pygame events to each states
+            # give the pygame events to each state
             # to ensure that pygame.event.get() is only called once per frame
             self.states_stack[-1].update(self.events)
 
             self.states_stack[-1].render(self.screen)
 
-            # magic value, use a FPS const in settings or delta time
+            # magic value, use 'a' FPS const in settings or delta time
             self.clock.tick(FPS)

src/inventory.py

@@ -58,7 +58,7 @@ def use_item(self, item_name: str) -> str:
         if self.remove_item(item_name, 1) == get_message("inventory", "remove_success", item=item_name, quantity=1):
             return get_message("inventory", "use_success", item=item_name)
         return get_message("inventory", "use_fail", item=item_name)
-    
+
     def buy_item(self, item_name, quantity):
         if item_name in self.items:
             self.items[item_name] += quantity