Added new boxart following the pre-release folder structure

E1ite007 commented 1 month ago

Description

Following #130 and with #135 efforts, I created this new database following the newer folder structure.

Motivation and Context

Adding compatibility for the newest rolling pre-release.

How Has This Been Tested?

Screenshots

Types of changes

[x] Improvement (non-breaking change that adds a new feature)
[ ] Bug fix (fixes an issue)
[ ] Breaking change (breaking change)
[ ] Documentation Improvement
[ ] Config and build (change in the configuration and build system, has no impact on code or features)

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

Signed-off-by: E1ite007 ghrv_1999@hotmail.com

Summary by CodeRabbit

New Features
- Introduced a "GamePak sprites" section with guidelines for using N64 GamePak sprites.
- Added a "Compatibility mode" subsection detailing deprecated filename support.
- Included a "Sounds" subsection listing sound effects and their licenses.
- Provided a link to a boxart pack that adheres to the new structure.
Documentation
- Enhanced readability with formatting updates and additional examples.

coderabbitai[bot] commented 1 month ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request updates the README.md file for the N64 Flashcart Menu project by adding new sections and subsections. A section on "GamePak sprites" has been introduced, detailing usage instructions and directory structure for boxart sprites. The "Experimental features" section now includes a "Compatibility mode" subsection, addressing deprecated filename support. Additionally, a new "Sounds" subsection lists sound effects used in the project. Minor formatting improvements have also been made for better readability.

Changes

File	Change Summary
`README.md`	Added "GamePak sprites" section with usage instructions and directory structure; expanded "Experimental features" with "Compatibility mode"; added "Sounds" subsection listing sound effects; included link to boxart pack; made minor formatting improvements.

Possibly related PRs

130: The changes in this PR enhance the loading performance of boxart images and include updates to the README.md that specify the directory structure for boxart images, which directly relates to the organization and usage of boxart as discussed in the main PR.

Suggested labels

enhancement

Poem

🐰 In the land of sprites and games,
A README blooms with new names.
Boxart and sounds, all aligned,
With clear paths for us to find.
Hop along, let’s play today,
With every change, we leap and sway! 🎮✨

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.

networkfusion commented 1 month ago

Looking at the content of the zip, I am not sure why you have also included the ABCD.png files in the A/B/C/D/ folder... if they are a failback, they should be in the root boxart folder?!

E1ite007 commented 1 month ago

Looking at the content of the zip, I am not sure why you have also included the ABCD.png files in the A/B/C/D/ folder... if they are a failback, they should be in the root boxart folder?!

Huh, didn't noticed it. Fixed it and followed your advice, and added the failback in the root boxart folder. It can be checked at the same link as before.

networkfusion commented 1 month ago

@coderabbitai resolve and full review

coderabbitai[bot] commented 1 month ago

@networkfusion: I will resolve all previous comments and conduct a full review of the changes.

:white_check_mark: Actions performed

Comments resolved. --- Full review triggered.

Polprzewodnikowy / N64FlashcartMenu