Create octoguns.mdoc #304
Create octoguns.mdoc #304
Conversation
WalkthroughThe changes introduce a new file for the game "Octoguns," which includes comprehensive metadata detailing its attributes. This metadata encompasses the game's name, ID, developer, genres, color, status, descriptions, supported operating systems, blockchain chains, and associated tokens. Links to the game's homepage, Twitter account, and GitHub repository are also provided. The game is categorized as playable and is described as the first on-chain FPS, with a focus on player versus player mechanics. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
apps/nextjs/content/games/octoguns.mdoc (2)
8-8: Fix grammatical issues in descriptionsThere are a few grammatical issues in the text:
-"The worlds first onchain FPS" +"The world's first on-chain FPS" -"Octoguns is a player versus player FPS where two players battle controlling eight mind controlled humans, battling in a turn based strategy to decimate your opponent" +"Octoguns is a player-versus-player FPS where two players battle by controlling eight mind-controlled humans in a turn-based strategy to decimate their opponent."Also applies to: 29-29, 49-49
33-34: Use consistent chain ID formatThe chain IDs are using raw hexadecimal values. Consider using named constants or a more readable format for better maintainability.
- - '0x534e5f4d41494e' - - '555' + - SN_MAIN + - SLOT_TESTNET
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
apps/nextjs/content/games/octoguns.mdoc(1 hunks)
🔇 Additional comments (1)
apps/nextjs/content/games/octoguns.mdoc (1)
18-18: Verify screenshot count
The screenshotLength is set to 4, but 5 screenshots are provided in the PR objectives.
| { | ||
| name: "Octoguns", | ||
| id: "Octoguns", | ||
| developer: Studios.RuneLabs, | ||
| genres: ["FPS", "Strategy", "PVP"], | ||
| color: "#292534", | ||
| status: "mainnet", | ||
| description: "The worlds first onchain FPS", | ||
| longform: | ||
| "Octoguns is a player versus player FPS where two players battle controlling eight mind controlled humans, battling in a turn based strategy to decimate your opponent.", | ||
| links: { | ||
| twitter: "https://x.com/octoguns_", | ||
| homepage: "https://play.octoguns.xyz/", | ||
| }, | ||
| chains: [ChainId.SLOT_TESTNET, ChainId.SN_MAIN], | ||
| operatingSystems: ["Web Browser"], | ||
| tokens: [Tokens.LORDS], | ||
| screenshotLength: 4, | ||
| playable: true, | ||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove duplicate metadata structure
The file contains the same metadata in two different formats. This duplication makes maintenance difficult and could lead to inconsistencies. Consider keeping only the YAML frontmatter format (the second version) as it's more standard for .mdoc files.
Here are some inconsistencies between the two versions:
- Developer name:
Studios.RuneLabsvsRune Labs - Color format:
"#292534"vs292534 - Chain IDs: Different formats and representations
Also applies to: 21-48
| icon: | ||
| coverImage: | ||
| screenshots: |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add the provided images to the documentation
Based on the PR objectives, you have several images to add. Here's how to include them:
-icon:
+icon: /images/octoguns/OCTOGUNS-CIRCLE.png
-coverImage:
+coverImage: /images/octoguns/COVER-OCTOGUNS-NEW-LIGHTS.png
-screenshots:
+screenshots:
+ - /images/octoguns/OCTOPUS-ILLUSTRATION-HOMEPAGE.png
+ - /images/octoguns/COVER-OCTOGUNS-DOK.png
+ - /images/octoguns/Concept-art-Arena-Lights.png
+ - /images/octoguns/Concept-art-Octopus-16-9.png
+ - /images/octoguns/BUILDINGS-OCTOUNS-CITY.pngNote: Ensure the images are saved in the appropriate directory and follow the project's naming conventions.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| icon: | |
| coverImage: | |
| screenshots: | |
| icon: /images/octoguns/OCTOGUNS-CIRCLE.png | |
| coverImage: /images/octoguns/COVER-OCTOGUNS-NEW-LIGHTS.png | |
| screenshots: | |
| - /images/octoguns/OCTOPUS-ILLUSTRATION-HOMEPAGE.png | |
| - /images/octoguns/COVER-OCTOGUNS-DOK.png | |
| - /images/octoguns/Concept-art-Arena-Lights.png | |
| - /images/octoguns/Concept-art-Octopus-16-9.png | |
| - /images/octoguns/BUILDINGS-OCTOUNS-CITY.png |
Can these also be added as images within there (Im not sure wtf to do)
Logo:
Banner:
Page images:
Summary by CodeRabbit
New Features
Documentation