dojoengine / dojo.js

Official JavaScript packages for Dojo.
https://dojoengine.github.io/dojo.js/
MIT License
28 stars 47 forks source link

feat: add vanillajs + phaser example #249

Closed MartianGreed closed 3 months ago

MartianGreed commented 3 months ago

Closes #242

Introduced changes

Adds a new example using vanilla js and phaser

-

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@MartianGreed has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 4 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 95e373c92d1de5a337d7b8d4428e9211c5851a9b and 7c6d94e31c0866a535586ba97c338e3786e4e38c.
## Walkthrough

This update introduces a vanilla Phaser.js example, featuring a character navigating an infinite map. It includes essential configuration files and scripts, enhancing modularity and maintainability while integrating the Dojo engine effectively. This setup streamlines the development process and lays the groundwork for an engaging interactive experience.

## Changes

| Files | Change Summary |
|-------|----------------|
| `examples/vanilla/phaser/.gitignore` | New file to exclude unnecessary files from version control. |
| `examples/vanilla/phaser/dojoConfig.ts`, `examples/vanilla/phaser/src/dojo/*.ts`, `examples/vanilla/phaser/src/models.ts`, `examples/vanilla/phaser/src/utils.ts` | New files defining Dojo configuration, components, models, and utility functions for game logic. |
| `examples/vanilla/phaser/index.html` | New foundational HTML file linking Dojo and Phaser. |
| `examples/vanilla/phaser/package.json`, `examples/vanilla/phaser/tsconfig.json`, `examples/vanilla/phaser/vite.config.ts` | New configuration files for project metadata, TypeScript options, and build setup. |
| `examples/vanilla/phaser/src/entities.ts`, `examples/vanilla/phaser/src/scenes/scene-main.ts`, `examples/vanilla/phaser/src/main.ts` | New files introducing classes for managing game entities, scene management, and game initialization. |
| `package.json` | Addition of a new build script for the vanilla Phaser example. |
| `pnpm-workspace.yaml` | Updated to include new paths for workspace packages. |
| `scripts/build-examples.sh` | Modified script to include building the vanilla Phaser application. |

## Sequence Diagram(s)

```mermaid
sequenceDiagram
    participant User
    participant SceneMain as Scene
    participant GameConfig as Game
    participant DojoConfig as Config
    participant Models as Model

    User->>Scene: Start Game
    Scene->>Config: Load Configuration
    Config->>Scene: Return Config
    Scene->>Game: Initialize Game with Config
    Game->>Model: Setup Models
    Model->>Scene: Return Models
    Scene-->>User: Game Ready

Assessment against linked issues

Objective Addressed Explanation
Create a pure Phaser.js example (#[242]) βœ…
Show a character moving around on an infinite map (#[242]) ❓ Implementation details on character movement are not explicitly confirmed.

Poem

🐰 In a world of maps, so vast and wide,
A character hops with joy and pride.
With Phaser's magic, they leap and bound,
Through endless terrains, adventure found.
Hooray for code, a new tale to tell,
In this rabbit's paradise, all is swell! 🌟


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 .` - `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.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.