{"id":22672179,"url":"https://github.com/jimlynchcodes/quackers-frontend","last_synced_at":"2025-10-19T07:20:02.176Z","repository":{"id":258790627,"uuid":"875432565","full_name":"JimLynchCodes/Quackers-Frontend","owner":"JimLynchCodes","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-08T15:33:00.000Z","size":7523,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-04T11:55:02.373Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JimLynchCodes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-20T00:46:29.000Z","updated_at":"2025-01-08T15:33:04.000Z","dependencies_parsed_at":"2024-12-09T16:18:13.661Z","dependency_job_id":"067d97df-32b3-470d-8858-20b383b73b98","html_url":"https://github.com/JimLynchCodes/Quackers-Frontend","commit_stats":null,"previous_names":["jimlynchcodes/quackers-frontend-v3","jimlynchcodes/quackers-frontend"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JimLynchCodes%2FQuackers-Frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JimLynchCodes%2FQuackers-Frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JimLynchCodes%2FQuackers-Frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JimLynchCodes%2FQuackers-Frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JimLynchCodes","download_url":"https://codeload.github.com/JimLynchCodes/Quackers-Frontend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246176145,"owners_count":20735712,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-09T16:18:14.263Z","updated_at":"2025-10-19T07:19:57.149Z","avatar_url":"https://github.com/JimLynchCodes.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Quackers Frontend\n\nBevy code for the amazing online multiplayer game: _[Quackers](https://quackers-game.itch.io/quackers-beta)_\n\n\u003cbr/\u003e\n\n## Quickstart\n\n1) Install wasm built target:\n```\nrustup target add wasm32-unknown-unknown\n```\n\n2) Set backend endpoint\n\n```\nexport BACKEND_WS_ENDPOINT=ws://0.0.0.0:8000/ws\n```\n\n_Note: You'll also need to have the [Quackers backend project](https://github.com/JimLynchCodes/Quackers-Backend) running locally in order for the game to work properly._ \n\n\n3) Run frontend wasm project locally in a browser: \n```\ntrunk serve\n```\n\n\u003cbr/\u003e\n\n## Deploying\n\nmake sure to set these secrets in Github actions:\n\n1) `BUTLER_CREDENTIALS` - just straight up copy and paste the itch.io key for app you want to deploy\n\n2) `BACKEND_WS_ENDPOINT` - endpoint for the backend server. eg: `wss://your-subdomain.your-domain.com/ws`\n\nBackend ws endpoint defaults to `ws://0.0.0.0:8000/ws`\n\nbut you can override it and for example get the live backend locally:\n```\nexport BACKEND_WS_ENDPOINT=ws://0.0.0.0:8000/ws\n```\n\nyou can also unset local env vars like this:\n```\nunset BACKEND_WS_ENDPOINT\n```\n\nYou can also view and locally run the [Quackers-Backend code](https://github.com/JimLynchCodes/Quackers-Backend). \n\nGithub secrets are copied over to env vars in the app by `release.yaml`.\n\n# Bevy New 2D\n\nThis template is a great way to get started on a new 2D [Bevy](https://bevyengine.org/) game!\nStart with a [basic project structure](#write-your-game) and [CI / CD](#release-your-game) that can deploy to [itch.io](https://itch.io).\nYou can [try this template in your web browser!](https://the-bevy-flock.itch.io/bevy-new-2d)\n\n[@ChristopherBiscardi](https://github.com/ChristopherBiscardi) made a video on how to use this template from start to finish:\n\n[\u003cimg src=\"./docs/img/thumbnail.png\" width=40% height=40% alt=\"A video tutorial for bevy_new_2d, formerly known as bevy_quickstart\"/\u003e](https://www.youtube.com/watch?v=ESBRyXClaYc)\n\n## Prerequisites\n\nWe assume that you know how to use Bevy already and have seen the [official Quick Start Guide](https://bevyengine.org/learn/quick-start/introduction/).\n\nIf you're new to Bevy, the patterns used in this template may look a bit weird at first glance.\nSee our [Design Document](./docs/design.md) for more information on how we structured the code and why.\n\n## Create a new game\n\nInstall [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) and run the following command:\n\n```sh\ncargo generate thebevyflock/bevy_new_2d\n```\n\nThen [create a GitHub repository](https://github.com/new) and push your local repository to it.\n\n## Write your game\n\nThe best way to get started is to play around with what you find in [`src/demo/`](./src/demo).\n\nThis template comes with a basic project structure that you may find useful:\n\n| Path                                               | Description                                                        |\n| -------------------------------------------------- | ------------------------------------------------------------------ |\n| [`src/lib.rs`](./src/lib.rs)                       | App setup                                                          |\n| [`src/asset_tracking.rs`](./src/asset_tracking.rs) | A high-level way to load collections of asset handles as resources |\n| [`src/audio/`](./src/audio)                        | Marker components for sound effects and music                      |\n| [`src/demo/`](./src/demo)                          | Example game mechanics \u0026 content (replace with your own code)      |\n| [`src/dev_tools.rs`](./src/dev_tools.rs)           | Dev tools for dev builds (press \\` aka backtick to toggle)         |\n| [`src/screens/`](./src/screens)                    | Splash screen, title screen, gameplay screen, etc.                 |\n| [`src/theme/`](./src/theme)                        | Reusable UI widgets \u0026 theming                                      |\n\nFeel free to move things around however you want, though.\n\n\u003e [!Tip]\n\u003e Be sure to check out the [3rd-party tools](./docs/tooling.md) we recommend!\n\n## Run your game\n\nRunning your game locally is very simple:\n\n- Use `cargo run` to run a native dev build.\n- Use [`trunk serve`](https://trunkrs.dev/) to run a web dev build.\n\nIf you're using [VS Code](https://code.visualstudio.com/), this template comes with a [`.vscode/tasks.json`](./.vscode/tasks.json) file.\n\n\u003cdetails\u003e\n  \u003csummary\u003eRun release builds\u003c/summary\u003e\n\n- Use `cargo run --profile release-native --no-default-features` to run a native release build.\n- Use `trunk serve --release --no-default-features` to run a web release build.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eLinux dependencies\u003c/summary\u003e\n\nIf you are using Linux, make sure you take a look at Bevy's [Linux dependencies](https://github.com/bevyengine/bevy/blob/main/docs/linux_dependencies.md).\nNote that this template enables Wayland support, which requires additional dependencies as detailed in the link above.\nWayland is activated by using the `bevy/wayland` feature in the [`Cargo.toml`](./Cargo.toml).\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003e(Optional) Improve your compile times\u003c/summary\u003e\n\n[`.cargo/config_fast_builds.toml`](./.cargo/config_fast_builds.toml) contains documentation on how to set up your environment to improve compile times.\nAfter you've fiddled with it, rename it to `.cargo/config.toml` to enable it.\n\n\u003c/details\u003e\n\n## Release your game\n\nThis template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) to run tests and build releases.\nSee [Workflows](./docs/workflows.md) for more information.\n\n## Known Issues\n\nThere are some known issues in Bevy that require some arcane workarounds.\nTo keep this template simple, we have opted not to include those workarounds.\nYou can read about them in the [Known Issues](./docs/known-issues.md) document.\n\n## License\n\nThe source code in this repository is licensed under any of the following at your option:\n\n- [CC0-1.0 License](./LICENSE-CC0-1.0.txt)\n- [MIT License](./LICENSE-MIT.txt)\n- [Apache License, Version 2.0](./LICENSE-Apache-2.0.txt)\n\nThe CC0 license explicitly does not waive patent rights, but we confirm that we hold no patent rights to anything presented in this repository.\n\n## Credits\n\nThe [assets](./assets) in this repository are all 3rd-party. See the [credits screen](./src/screens/credits.rs) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimlynchcodes%2Fquackers-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimlynchcodes%2Fquackers-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimlynchcodes%2Fquackers-frontend/lists"}