v0.5.0: Cumulative updates

[kurone-kito]

Features

• ca2d879: added the url sticky prefab
• 48d3548: added the function that completes the toggles
• 3fa1569: improved the constructor of the extensions

Bug fixes / Refactoring

• 8b7ef7a: fixed a bug that fails the global toggles
• 33c0961: fixed the bug that the global toggles were not working
• f887673: fixed the typo in the error message
• 3a422bc: removed the extra codes
• e2fc705: rebuilt some scenes
• 00d7ffe: linted

Other updates

Dependencies update

• 4dc4677: updated the dependencies
• 6782884: increased the specified .NET version

Documents

• fafbc2e: improved the contributing documents

CI/CD

• facad49: added the process that creates the unitypackage.zip file
• 1c2b83e: added the dispatch action to curate this repository
• 52df888: improved the action that obtains package version
• e5317aa: implemented the clone the documents feature on the CI script
• b2a2db2: improved the coderabbit configuration

Project settings

• 559327d chore: improved the git configuration
• 250460b chore: improved the EditorConfig configuration

Summary by CodeRabbit

• New Features

  • Added a "Contributing" section to the README to encourage community contributions.
  • Introduced new prefab "UrlSticky" for handling URL input with specific visual and interaction settings.
  • Updated the tool versions to specify .NET version 6.0.420.

• Enhancements

  • Updated guidelines in multiple language versions of CONTRIBUTING files to enhance clarity and provide better guidance for contributors.
  • Improved material handling in various Unity scene and prefab files to refine appearance and properties.

• Bug Fixes

  • Corrected a typo in an error message within the SyncBehaviour class.

• Documentation

  • Updated the Code of Conduct in Japanese to refine terms related to gender identity and expression.

• Refactor

  • Removed redundant code and optimized toggle functionality in GlobalToggle class.

• Chores

  • Updated package versions and dependencies in package.json and related files to ensure compatibility and functionality.

• Style

  • Reformatted JSON structure in .vscode/launch.json for better readability without altering functionality.

[coderabbitai]

Walkthrough

The update focuses on refining the functionality and organization across various files in a software repository. Changes include updating coding standards, enhancing inclusivity in documentation, reformatting JSON structures, and improving the handling and appearance of Unity assets. Additionally, the update introduces new guidelines for contributions and updates package dependencies.

Changes

File Path	Change Summary
.coderabbit.yaml, .editorconfig, .gitattributes, .github/workflows/...	Updated review instructions, file patterns, and workflow steps for better functionality and inclusivity.
.github/CODE_OF_CONDUCT.ja.md, .github/CONTRIBUTING.*.md, README.md	Language and structure improvements in conduct and contributing guidelines to enhance clarity and inclusivity.
Packages/.../Editor/..., Packages/.../Runtime/Prefabs/..., Packages/.../Runtime/Scripts/Globals/...	Modifications in Unity editor scripts and prefabs for better material handling and toggle functionality.
.vscode/launch.json, .gitignore, global.json, .tool-versions	Configuration and version updates for development tools and ignored file settings.
Packages/.../Examples/Scenes/...	Changes in Unity scene files to update material properties and improve visual elements.

🐇💻
A CodeRabbit's Ode to Code

In the burrow of branches and code,
A rabbit hops on the update road.
With tweaks and fixes, far and wide,
Ensuring all the bits abide.
Hop, hop, hop, on soft digital sod,
Crafting a garden in the silicon pod.
🌱🚀🌟

---

Recent Review Details

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between ab513af and 553b35b.

Files ignored due to path filters (1)

• Packages/black.kit.toybox/Examples/Images/example.com.png is excluded by !**/*.png

Files selected for processing (41)

• .coderabbit.yaml (1 hunks)
• .editorconfig (1 hunks)
• .gitattributes (1 hunks)
• .github/CODE_OF_CONDUCT.ja.md (2 hunks)
• .github/CONTRIBUTING.ja.md (1 hunks)
• .github/CONTRIBUTING.md (1 hunks)
• .github/CONTRIBUTING.zh.md (1 hunks)
• .github/workflows/build-listing.yml (1 hunks)
• .github/workflows/release.yml (2 hunks)
• .gitignore (1 hunks)
• .tool-versions (1 hunks)
• .vscode/launch.json (1 hunks)
• Packages/black.kit.toybox/Editor/Concretes/GlobalTogglesEditor.cs (4 hunks)
• Packages/black.kit.toybox/Editor/EditorBase.cs (3 hunks)
• Packages/black.kit.toybox/Editor/ToggleGroupUtils.cs (1 hunks)
• Packages/black.kit.toybox/Editor/ToggleGroupUtils.cs.meta (1 hunks)
• Packages/black.kit.toybox/Examples/Images.meta (1 hunks)
• Packages/black.kit.toybox/Examples/Images/example.com.png.meta (1 hunks)
• Packages/black.kit.toybox/Examples/Prefabs/CommonFloor.prefab (2 hunks)
• Packages/black.kit.toybox/Examples/Scenes/ConditionalActiveRelayToAnimator.unity (8 hunks)
• Packages/black.kit.toybox/Examples/Scenes/GlobalScroll.unity (2 hunks)
• Packages/black.kit.toybox/Examples/Scenes/GlobalSlider.unity (1 hunks)
• Packages/black.kit.toybox/Examples/Scenes/GlobalToggle.unity (1 hunks)
• Packages/black.kit.toybox/Examples/Scenes/PositionAnchor.unity (5 hunks)
• Packages/black.kit.toybox/Examples/Scenes/TickingDown.unity (1 hunks)
• Packages/black.kit.toybox/Examples/Scenes/UrlSticky.unity.meta (1 hunks)
• Packages/black.kit.toybox/Examples/Scenes/Whitelist.unity (3 hunks)
• Packages/black.kit.toybox/Runtime/Prefabs/GlobalScroll.prefab (7 hunks)
• Packages/black.kit.toybox/Runtime/Prefabs/GlobalSlider.prefab (3 hunks)
• Packages/black.kit.toybox/Runtime/Prefabs/GlobalToggle.prefab (4 hunks)
• Packages/black.kit.toybox/Runtime/Prefabs/UrlSticky.prefab (1 hunks)
• Packages/black.kit.toybox/Runtime/Prefabs/UrlSticky.prefab.meta (1 hunks)
• Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalSlider.cs (1 hunks)
• Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalToggle.cs (1 hunks)
• Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalToggles.cs (2 hunks)
• Packages/black.kit.toybox/Runtime/Scripts/Globals/SyncBehaviour.cs (1 hunks)
• Packages/black.kit.toybox/package.json (2 hunks)
• Packages/packages-lock.json (1 hunks)
• Packages/vpm-manifest.json (1 hunks)
• README.md (1 hunks)
• global.json (1 hunks)

Files not summarized due to errors (1)

• Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalSlider.cs: Error: Server error. Please try again later.

Files not reviewed due to errors (3)

• GlobalToggle.prefab (no review received)
• GlobalScroll.prefab (no review received)
• ConditionalActiveRelayToAnimator.unity (no review received)

Files skipped from review due to trivial changes (5)

• .tool-versions
• .vscode/launch.json
• Packages/black.kit.toybox/Editor/ToggleGroupUtils.cs.meta
• Packages/black.kit.toybox/Examples/Images.meta
• Packages/black.kit.toybox/Runtime/Scripts/Globals/SyncBehaviour.cs

Additional comments not posted (50)

global.json (2)

3-3: Setting the roll-forward policy to "latestMinor" is a good practice for maintaining compatibility with minor SDK updates.

---

4-4: Update of SDK version to "6.0.420" appears appropriate. Ensure compatibility with the project's requirements.

Verification successful

---

The verification process has confirmed that there are no specific SDK version requirements mentioned in the README.md of the project. This suggests that the update to SDK version "6.0.420" should not conflict with any documented requirements. Therefore, the update appears to be appropriate and should be compatible with the project as no constraints were found.

• No specific SDK version requirements are mentioned in the project documentation.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Check for any specific SDK version requirements in the project documentation.
rg --type md --type txt "SDK version" README.md docs/

Length of output: 101

---

---

Script:

#!/bin/bash
# Re-check for any specific SDK version requirements in the project documentation, ensuring to handle the case where 'docs/' directory might not exist.
rg --type md --type txt "SDK version" README.md || echo "No SDK version requirements mentioned in README.md"

Length of output: 160

Packages/black.kit.toybox/Examples/Scenes/UrlSticky.unity.meta (1)

2-2: Change in guid value noted. Ensure all references to this asset are updated across the project.

Verification successful

---

The search for the old guid "49968646634b27449a1eb97090e3571a" did not return any results, suggesting that it has been successfully updated across the project. However, it's recommended to manually verify this to ensure that no references were missed, especially in less common file types or external configurations that might not have been indexed.

• Manually verify the update of the guid in all project assets and configurations.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for the old GUID in the project to ensure it has been updated everywhere.
rg "49968646634b27449a1eb97090e3571a"

Length of output: 37

Packages/black.kit.toybox/Runtime/Prefabs/UrlSticky.prefab.meta (2)

2-2: Change in guid value noted. Ensure all references to this prefab are updated across the project.

Verification successful

The search for the old GUID "49968646634b27449a1eb97090e3571a" returned no results, indicating that it has been successfully removed or updated throughout the project. To ensure thorough verification, it would be prudent to check for the correct implementation of the new GUID "209a26e517b9509429dd12f9d1777fa1" across the project.

---

The search for the new GUID "209a26e517b9509429dd12f9d1777fa1" in the project has shown multiple references in the UrlSticky.unity scene and the UrlSticky.prefab.meta file. This indicates that the new GUID has been successfully implemented and is being referenced correctly in the project files where it is expected.

Based on this information, it can be concluded that the change in the GUID has been properly propagated throughout the project, and all necessary references have been updated to reflect the new GUID.

Conclusion:

• The change in the GUID has been successfully updated across the project.
• The new GUID is correctly implemented in the relevant project files.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Search for the old GUID in the project to ensure it has been updated everywhere.
rg "49968646634b27449a1eb97090e3571a"

Length of output: 37

---

---

Script:

#!/bin/bash
# Search for the new GUID in the project to ensure it is correctly implemented everywhere.
rg "209a26e517b9509429dd12f9d1777fa1"

Length of output: 3426

---

3-3: Change of importer type to PrefabImporter noted. Verify that this change aligns with the asset's requirements and functionality.

Packages/black.kit.toybox/package.json (2)

4-4: Update of package version to 0.5.0 aligns with the introduction of new features and improvements.

---

15-15: Update of dependency com.vrchat.worlds to ^3.5.2 allows for minor updates. Ensure compatibility with this version.

Packages/vpm-manifest.json (3)

10-10: Ensure that the version 3.5.2 for com.vrchat.worlds is compatible with other project dependencies.

---

23-25: Verify that the dependency com.vrchat.base version 3.5.2 is correctly specified and is compatible with com.vrchat.worlds.

---

29-29: Confirm that the version 3.5.2 for com.vrchat.base in the locked section is intended and aligns with the project's dependency management strategy.

.editorconfig (1)

17-17: Confirm that the exclusion of dotnet_diagnostic.IDE0066.severity for .cs files under Packages/black.kit is aligned with the project's coding standards.

.github/CONTRIBUTING.md (1)

7-19: Review the rephrased and reordered contribution guidelines for clarity and inclusiveness. Ensure all links are functional and lead to the correct resources.

README.md (1)

29-33: Confirm that the new "Contributing" section in the README.md is clear, inviting, and correctly links to the CONTRIBUTING.md file.

Packages/black.kit.toybox/Editor/Concretes/GlobalTogglesEditor.cs (1)

32-36: Review the refactored logic in the CompleteToggles method to ensure it correctly sorts and assigns toggle elements based on their sibling index. Confirm that this change enhances the efficiency and maintainability of toggle management.

Packages/black.kit.toybox/Editor/ToggleGroupUtils.cs (1)

42-45: Ensure that the GetToggles method correctly retrieves and orders toggles based on their sibling index. This method should be robust and handle potential null values gracefully.

Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalToggle.cs (1)

Line range hint 25-33: Verify that the removal of the UpdateView() call in the SetValue method does not introduce any side effects or issues with the synchronization of the toggle state. This change should enhance performance without compromising functionality.

Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalSlider.cs (1)

Line range hint 25-33: Confirm that the changes in the SetValue method for the GlobalSlider correctly synchronize slider values and do not introduce any performance issues. This method should handle value changes efficiently and accurately.

.github/workflows/release.yml (6)

12-12: Ensure that the new step name accurately reflects its functionality.

---

31-32: Good addition for ensuring important documentation is included in the package.

---

35-35: Verify that sergeysova/jq-action@v2 is compatible with the project's requirements and provides the necessary functionality.

---

45-45: Ensure that the compression level -9 does not significantly impact the build time or resource usage.

---

53-54: Good practice to zip the UnityPackage for better management and distribution.

---

60-66: Ensure that all necessary files are included in the release and that the tag_name is correctly set from the environment variables.

.github/workflows/build-listing.yml (1)

83-88: Ensure that the repository dispatch action is correctly configured with the appropriate event-type and repository. Verify that the REPO_TOKEN has the necessary permissions.

.github/CODE_OF_CONDUCT.ja.md (1)

7-7: Ensure that the updated terms related to gender identity and expression are culturally and contextually appropriate.

Packages/black.kit.toybox/Runtime/Scripts/Globals/GlobalToggles.cs (1)

104-110: Verify that the updated logic correctly handles the toggle state based on the index, especially in edge cases where the index might be out of bounds.

Packages/black.kit.toybox/Examples/Images/example.com.png.meta (1)

1-140: Check that the metadata settings such as maxTextureSize, compressionQuality, and textureFormat are optimized for the image's usage in the project.

.gitignore (1)

219-227: Confirm that the new entries in the .gitignore file are necessary and correctly formatted to avoid unintentionally ignoring important files.

Packages/black.kit.toybox/Editor/EditorBase.cs (2)

3-5: The addition of UnityEditor and UnityEngine.UI namespaces should be verified for necessity and potential conflicts with existing code.

---

70-101: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [21-97]

Review the refactored constructor and the new CompleteToggles method to ensure they are correctly implemented and improve the code's maintainability and functionality.

Packages/black.kit.toybox/Runtime/Prefabs/UrlSticky.prefab (1)

1-239: Verify that the new URL sticky prefab is correctly configured and functional, with appropriate components and properties set as expected.

Packages/packages-lock.json (1)

174-174: Addition of "com.unity.timeline": "1.7.6" looks correctly formatted and integrated into the dependency list.

Verification successful

---

The verification process confirms that the dependency "com.unity.timeline": "1.7.6" is correctly integrated into the project files, as evidenced by its presence in both packages-lock.json and manifest.json with the correct version and associated properties. No further issues were found.

• Packages/packages-lock.json: Correct version and dependency structure.
• Packages/manifest.json: Correctly listed as a project dependency.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify if the new dependency com.unity.timeline is integrated and used in the project files.
rg --type json 'com.unity.timeline' -C 5

Length of output: 1954

Packages/black.kit.toybox/Runtime/Prefabs/GlobalSlider.prefab (3)

264-264: Update to m_Material property in the Handle component is correctly formatted.

---

353-353: Update to m_Material property in the Background component is correctly formatted.

---

428-428: Update to m_Material property in the Fill component is correctly formatted.

Packages/black.kit.toybox/Examples/Prefabs/CommonFloor.prefab (2)

199-199: Ensure the addition of udonProducts array aligns with intended data structure modifications.

The addition of an empty array udonProducts to the MonoBehaviour instance is noted. Please confirm that this aligns with the intended modifications to the prefab's data structure and that it integrates correctly with other components.

---

263-263: Verify the purpose of the empty SerializedTypeNames array.

The addition of an empty array SerializedTypeNames is observed. It's important to verify the purpose and future use of this array to ensure it serves a functional role within the prefab's architecture.

Packages/black.kit.toybox/Examples/Scenes/TickingDown.unity (1)

4718-4718: Update to m_Material property looks good.

Ensure to verify the visual appearance in the Unity editor to confirm that the new material meets the desired aesthetics and functionality.

Packages/black.kit.toybox/Examples/Scenes/GlobalSlider.unity (1)

4719-4719: Update to m_Material property looks correct.

Please ensure to verify the new material in the Unity editor for any visual or performance issues.

Packages/black.kit.toybox/Examples/Scenes/GlobalToggle.unity (1)

160-160: Update to m_Material property approved.

Please ensure to verify the visual and functional impacts of the new material in the Unity editor, especially how it interacts with lighting and other scene elements.

Packages/black.kit.toybox/Examples/Scenes/Whitelist.unity (3)

4818-4818: Update to material properties aligns with project enhancements.

---

4978-4978: Consistent update to material properties across different objects.

---

5093-5093: Addition of a new material to the array reflects the ongoing enhancements to scene aesthetics.

Packages/black.kit.toybox/Examples/Scenes/GlobalScroll.unity (2)

4788-4788: Change in m_AnchoredPosition.y from a very small value to 557 approved.

Please verify the visual impact of this change in the Unity editor to ensure it aligns with the intended design.

---

4933-4933: Update to m_Material property approved.

Please verify the material settings and appearance in the Unity editor to ensure they meet the intended visual standards.

Packages/black.kit.toybox/Examples/Scenes/PositionAnchor.unity (5)

175-175: Updated material reference appears correct and aligns with project enhancements.

---

4821-4821: Consistent update of material reference as seen in other parts of the scene.

---

4989-4989: Material and transparency update noted; ensures visual consistency and functionality.

---

5084-5084: Addition of new material to the rendering options enhances visual properties.

---

5451-5451: Material update and darker color adjustment align with thematic enhancements.

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.