GUI Inventory Integration (Closes #41)

[AnSiChen]

PySeas: Inventory

This PR integrates an interactive GUI for managing the player's inventory, a game's core feature. It enhances user experience with features like item usage, removal, and real-time feedback while ensuring code quality through robust type-checking, formatting, and error handling, with added icons for further visual feedback.

Key Implementations

Inventory Management in GUI:

1. Scrollable item display with "Use" and "Discard" buttons.
2. Real-time feedback for user actions displayed as messages.

Testing:

• Verified functionality with unit tests for inventory and GUI components.

Progress on Issue #41

This PR addresses the following items:

• The player can remove items from their inventory.
• The player can add items to their inventory.
• The player can open the inventory and view items.
• The player can use an item from their inventory, which removes it.

Screenshots

Icon Integration:
[

Using an Item:

Removing an Item:

Documentation

Inventory Guide: Testing and Structure

1. Visual display of items with names and quantities.
2. Real-time interaction buttons and feedback.
3. Modify inventory.json to add items for testing.
4. Modify Initializer

Utils Guide(Related Implementation):

1. Explains messaging.py for JSON-based messages for Dynamic Messages.
2. Highlights modularity and expandability for future expansion or multilingual support.

Checklist

• Features implemented as described.
• Code reviewed for type-checking and linting (mypy, ruff).
• Unit tests passed.
• Documentation updated with visuals and usage examples.

Previously Also Considered:

Implementing in Fewer Files

• This approach was not pursued as it did not promote modularization or scalability.

Using External Libraries for UI Design

• While still being considered, this iteration focuses on addressing the issue using existing tools and frameworks.

Using Placeholders for Icons

• This PR implements the foundational logic to transition from placeholders to real Sprite Sheet Images.

Potential Future Enhancements

• Expand inventory visuals (e.g., add "Buy item" and "Loot" features).
• Replace placeholder icons for certain inventory items to accurately represent each item in the Sprite Sheet.

[ultimateownsz]

Hey, thank you for your pull request! I wrote down my thoughts on some things you need to adjust a bit. The unittest didn't work at my end. Perhaps I did something wrong. Let me know if so!

[AnSiChen]

Hi all, I've pushed the latest changes based on feedback and updates.

Summary of Updates:

• Added __init__.py files for package structure.
• Updated tests/test_inventory.py to fix sys.path for direct execution. (Alternatively use pytest)
• Revised docs/InventoryGuide.md to include test instructions.
• Added comments to inventory_gui.py to remind everyone of the nature of the current implementation.
  • (Once this last point has been addressed or we implement "Buy", "Add" or related in-game feature we can proceed to replace it. As explained in the PR discussion, we do not currently have a way to test the inventory, so for now it could be fine until we move forward.)

All tests, ruff, and mypy checks pass locally. Please let me know if further adjustments are needed. Thank you for reviewing!

[ultimateownsz]

Hey, thank you for your changes, before I can check your PR, there are some changes made to the codebase. You should use get pull from the main branch to see the latest changes. And update your own branch with those changes. Thanks in advance!

[ultimateownsz]

Thank you for your changes, sorry for the long wait, I was busy and was also sick for a few days. I will contact you in Discord for new tasks to pickup, my idea is to create a roadmap for PySeas to prioritize what needs to be worked on to create the working prototype! All input is appreciated!