search

stanoddly / GameKit

Apache License 2.0
1 stars 0 forks source link

Initial support for asset loading via virtual filesystem (and packages in future) #20

Open stanoddly opened 5 hours ago

stanoddly commented 5 hours ago

Initial support for asset loading. Tests included this time.

coderabbitai[bot] commented 5 hours ago

Walkthrough

The changes in this pull request introduce a variety of modifications across multiple files, primarily focusing on enhancing the content management system and virtual file systems within the GameKit framework. Key updates include the addition of new test classes, modifications to existing project files, and the introduction of new classes for managing cached and composite file systems. Additionally, several existing classes have been refactored to implement interfaces, improving the overall architecture and flexibility of the content loading mechanisms.

Changes

File Change Summary
.gitignore Added entry to ignore *.kate-swp files.
Examples/Examples.TexturedQuad/Examples.TexturedQuad.csproj Removed <ItemGroup> for content files in the Content directory.
Examples/Examples.TexturedQuad/Program.cs Added method call to AddContentFromProjectDirectory("Content"); simplified shader and image loading paths.
Examples/Examples.Triangle/Examples.Triangle.csproj Removed <ItemGroup> for content files in the Content directory.
Examples/Examples.Triangle/Program.cs Added method call to AddContentFromProjectDirectory("Content"); simplified shader loading paths.
GameKit.Content.Tests/BaseVirtualFileSystemTests.cs Introduced unit tests for VirtualFileSystem.
GameKit.Content.Tests/CachedFileSystemTests.cs Added tests for CachedFileSystem, inheriting from BaseVirtualFileSystemTests.
GameKit.Content.Tests/CompositeFileSystemTests.cs Added tests for CompositeFileSystem, inheriting from BaseVirtualFileSystemTests.
GameKit.Content.Tests/Content/*.txt Added various text files with simple content.
GameKit.Content.Tests/ContentInDevRoot/*.txt Added various text files with simple content.
GameKit.Content.Tests/ContentLoaderTests.cs Introduced tests for content loading functionality.
GameKit.Content.Tests/ContentPart1/*.txt Added various text files with simple content.
GameKit.Content.Tests/ContentPart2/*.txt Added various text files with simple content.
GameKit.Content.Tests/ContentTests.cs Introduced tests for content loading functionality.
GameKit.Content.Tests/DictFileSystemFactory.cs Added factory for creating DictFileSystem instances.
GameKit.Content.Tests/DictFileSystemTests.cs Added tests for DictFileSystem, inheriting from BaseVirtualFileSystemTests.
GameKit.Content.Tests/FileSystemBuilderTests.cs Added tests for FileSystemBuilder.
GameKit.Content.Tests/GameKit.Content.Tests.csproj Created new test project file.
GameKit.Content.Tests/NativeFileSystemTests.cs Added tests for NativeFileSystem, inheriting from BaseVirtualFileSystemTests.
GameKit.ImageLoader.StbImageSharp/StbImageLoader.cs Updated to implement IContentLoader<Image> interface; modified Load method signature.
GameKit.sln Added project entry for GameKit.Content.Tests.
GameKit/Content/CachedFileSystem.cs Introduced CachedFileSystem class with caching capabilities.
GameKit/Content/CompositeFileSystem.cs Introduced CompositeFileSystem class for aggregating multiple file systems.
GameKit/Content/ContentManager.cs Introduced ContentManager class for managing content loading.
GameKit/Content/DictFileSystem.cs Introduced ByteVirtualFile and DictFileSystem classes for managing virtual files.
GameKit/Content/FileSystemBuilder.cs Introduced FileSystemBuilder class for constructing virtual file systems.
GameKit/Content/NativeFileSystem.cs Introduced NativeFile and NativeFileSystem classes for native file handling.
GameKit/Content/VirtualFileSystem.cs Introduced abstract classes for virtual file representation and management.
GameKit/GameKitApp.cs Updated ContentManager property to IContentManager and added FileSystem property.
GameKit/GameKitAppBuilder.cs Refactored to a class; added methods for content and file system management.
GameKit/ShaderPackLoader.cs Updated to implement IContentLoader<ShaderPack> interface; modified Load method signature.
docs/technical/content.md Documented ContentManager and related interfaces.
docs/technical/filesystem.md Documented virtual filesystem and its implementations.
GameKit/GameKit.csproj Removed package references for TestableIO.System.IO.Abstractions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.