{"id":17250085,"url":"https://github.com/stephengold/fuzecreek","last_synced_at":"2025-04-14T05:09:44.648Z","repository":{"id":39735254,"uuid":"389220064","full_name":"stephengold/FuzeCreek","owner":"stephengold","description":"A grid-based, real-time river-rafting game with explosives","archived":false,"fork":false,"pushed_at":"2025-04-02T05:10:35.000Z","size":844,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-14T05:09:34.183Z","etag":null,"topics":["2d-graphics","3d-graphics","game","grid-based-movement","java","jme3","jmonkeyengine3","rafting","real-time"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stephengold.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":"2021-07-24T23:29:07.000Z","updated_at":"2025-04-02T05:10:38.000Z","dependencies_parsed_at":"2023-02-17T02:16:30.150Z","dependency_job_id":"7c95c81f-1a8f-4042-a93e-77e92af1abe7","html_url":"https://github.com/stephengold/FuzeCreek","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FFuzeCreek","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FFuzeCreek/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FFuzeCreek/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephengold%2FFuzeCreek/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephengold","download_url":"https://codeload.github.com/stephengold/FuzeCreek/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248824681,"owners_count":21167345,"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":["2d-graphics","3d-graphics","game","grid-based-movement","java","jme3","jmonkeyengine3","rafting","real-time"],"created_at":"2024-10-15T06:46:09.239Z","updated_at":"2025-04-14T05:09:44.625Z","avatar_url":"https://github.com/stephengold.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FuzeCreek\n\nA grid-based rafting game with explosives, powered by\n[the jMonkeyEngine (JME) game engine][jme].\n\nIt contains 4 subprojects:\n\n 1. FC2D: a (retro) 2-D version of the game\n 2. FC3D: the 3-D version of the game\n 3. FCCommon: shared sourcecode which implements the mechanics of the game\n 4. FCConsole: a (very retro) console-based version of the game,\n    implemented using \"ASCII graphics\"\n\nAssets and complete source code (in [Java]) are provided under\n[a 3-clause BSD license][license].\n\n\n\u003ca name=\"toc\"\u003e\u003c/a\u003e\n\n## Contents of this document\n\n+ [How to download and run a pre-built release of FuzeCreek](#prebuilt)\n+ [How to build and run FuzeCreek from source](#build)\n+ [Playing FuzeCreek](#play)\n+ [Wish list](#wishlist)\n+ [History](#history)\n+ [Acknowledgments](#acks)\n\n\n\u003ca name=\"prebuilt\"\u003e\u003c/a\u003e\n\n## How to download and run a pre-built release of FuzeCreek\n\n(documentation not yet written)\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"build\"\u003e\u003c/a\u003e\n\n## How to build and run FuzeCreek from source\n\n1. Install a [Java Development Kit (JDK)][adoptium],\n   if you don't already have one.\n2. Point the `JAVA_HOME` environment variable to your JDK installation:\n   (In other words, set it to the path of a directory/folder\n   containing a \"bin\" that contains a Java executable.\n   That path might look something like\n   \"C:\\Program Files\\Eclipse Adoptium\\jdk-17.0.3.7-hotspot\"\n   or \"/usr/lib/jvm/java-17-openjdk-amd64/\" or\n   \"/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home\" .)\n  + using Bash or Zsh: `export JAVA_HOME=\"` *path to installation* `\"`\n  + using [Fish]: `set -g JAVA_HOME \"` *path to installation* `\"`\n  + using Windows Command Prompt: `set JAVA_HOME=\"` *path to installation* `\"`\n  + using PowerShell: `$env:JAVA_HOME = '` *path to installation* `'`\n3. Download and extract the FuzeCreek source code from GitHub:\n  + using [Git]:\n    + `git clone https://github.com/stephengold/FuzeCreek.git`\n    + `cd FuzeCreek`\n  + using a web browser:\n    + Browse to https://github.com/stephengold/FuzeCreek/archive/refs/heads/master.zip\n    + save the ZIP file\n    + extract the contents of the saved ZIP file\n    + `cd` to the extracted directory/folder\n4. Run the [Gradle] wrapper:\n  + using Bash or Fish or PowerShell or Zsh: `./gradlew build`\n  + using Windows Command Prompt: `.\\gradlew build`\n\nYou can run the console-based version:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew :FCConsole:run`\n+ using Windows Command Prompt: `.\\gradlew :FCConsole:run`\n\nYou can run the 2-D version:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew :FC2D:run`\n+ using Windows Command Prompt: `.\\gradlew :FC2D:run`\n\nYou can run the 3-D version:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew :FC3D:run`\n+ using Windows Command Prompt: `.\\gradlew :FC3D:run`\n\nYou can restore the project to a pristine state:\n+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`\n+ using Windows Command Prompt: `.\\gradlew clean`\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"play\"\u003e\u003c/a\u003e\n\n## Playing FuzeCreek\n\nThe game consists of steering a raft down a river\ncontaining naval mines and exposed sharp rocks.\nThe raft automatically advances downstream.\nIt advances in discrete jumps, one row at a time.\nThe objective is to maximize points while avoiding mines and rocks.\n\n### Scoring system\n\nPoints are awarded for:\n\n1. making downstream progress (1 point per row) and\n2. removing mines by navigating alongside them\n   without making contact (20 points per mine)\n\nIf the raft crosses over a mine, the mine will detonate,\nending the game with a deduction of 100 points.\n\nYou begin the game with 20 patches.\nEach time the raft crosses over a rock,\nyou automatically expend one patch to repair damage caused by the rock.\nIf no patches remain, the raft sinks, ending the game.\n\nIf the raft runs up against either bank (side) of the river, the game ends.\n\n### Controls\n\nAll versions are controlled entirely using the keyboard;\nno mouse or trackpad is required.\n\nWhen run, the game opens a single window.\nFor the controls to work, this window must be selected to receive input.\nSome window managers select windows\nbased on the position of the mouse pointer.\nIf none of the controls work, try selecting the game window\nby clicking on it or moving the mouse pointer into it.\n\nGeneral controls found in all versions of the game:\n\n+ Esc : end the game immediately\n+ A or LeftArrow : steer left\n+ D or RightArrow : steer right\n\nAdditional controls found in FC2D and FC3D:\n\n+ H or F1 : toggle the help node in the upper-right corner of the window\n+ F5 : toggle the render statistics in the lower-left corner of the window\n+ Prt Scr : capture a screenshot to the working directory\n\nAdditional caveats:\n\n+ Steering is effective only when the raft advances.\n  To steer, you must press a key and hold it down.\n+ On Linux systems, the Prt Scr key might be needed by the window manager,\n  so the Scroll Lock key is used instead.\n+ The key descriptions above assume a keyboard\n  with the \"United States QWERTY\" layout.\n  On some keyboards, the keys in the A, D, and H positions\n  are labelled differently.\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"wishlist\"\u003e\u003c/a\u003e\n\n## Wish list\n\nSome ideas for future development:\n\n+ Sound effects\n+ Visualize exploding mines\n+ Health bar to visualize the remaining patches\n+ Shadows in FC3D\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"history\"\u003e\u003c/a\u003e\n\n## History\n\n(documentation not yet written)\n\n[Jump to the table of contents](#toc)\n\n\n\u003ca name=\"acks\"\u003e\u003c/a\u003e\n\n## Acknowledgments\n\nLike most projects, FuzeCreek builds on the work of many who\nhave gone before.  I therefore acknowledge the following\nartists and software developers:\n\n+ the creators of (and contributors to) the following software:\n    + the [Blender] 3-D animation suite\n    + the [Checkstyle] tool\n    + the [Firefox] web browser\n    + the [Git] revision-control system and GitK commit viewer\n    + the [GitKraken] client\n    + the [Gradle] build tool\n    + the [IntelliJ IDEA][idea] and [NetBeans] integrated development environments\n    + the [Java] compiler, standard doclet, and runtime environment\n    + [jMonkeyEngine][jme] and the jME3 Software Development Kit\n    + the [Linux Mint][mint] operating system\n    + [LWJGL], the Lightweight Java Game Library\n    + the [Markdown] document-conversion tool\n    + the [Meld] visual merge tool\n    + Microsoft Windows\n\nI am grateful to [GitHub]\nfor providing free hosting for this project\nand many other open-source projects.\n\nI'm also grateful to my dear Holly, for keeping me sane.\n\nIf I've misattributed anything or left anyone out, please let me know, so I can\ncorrect the situation: sgold@sonic.net\n\n[Jump to the table of contents](#toc)\n\n\n[adoptium]: https://adoptium.net/releases.html \"Adoptium Project\"\n[blender]: https://docs.blender.org \"Blender Project\"\n[checkstyle]: https://checkstyle.org \"Checkstyle\"\n[firefox]: https://www.mozilla.org/en-US/firefox \"Firefox\"\n[fish]: https://fishshell.com/ \"Fish command-line shell\"\n[git]: https://git-scm.com \"Git\"\n[github]: https://github.com \"GitHub\"\n[gitkraken]: https://www.gitkraken.com \"GitKraken client\"\n[gradle]: https://gradle.org \"Gradle Project\"\n[idea]: https://www.jetbrains.com/idea/ \"IntelliJ IDEA\"\n[java]: https://en.wikipedia.org/wiki/Java_(programming_language) \"Java programming language\"\n[jme]: https://jmonkeyengine.org \"jMonkeyEngine Project\"\n[license]: https://github.com/stephengold/FuzeCreek/blob/master/LICENSE \"FuzeCreek license\"\n[lwjgl]: https://www.lwjgl.org \"Lightweight Java Game Library\"\n[markdown]: https://daringfireball.net/projects/markdown \"Markdown Project\"\n[meld]: https://meldmerge.org \"Meld merge tool\"\n[mint]: https://linuxmint.com \"Linux Mint Project\"\n[netbeans]: https://netbeans.org \"NetBeans Project\"","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Ffuzecreek","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephengold%2Ffuzecreek","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephengold%2Ffuzecreek/lists"}