diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e20ac8b42e..b6bcdbee31 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -71,12 +71,12 @@ jobs: shell: bash if: matrix.config.os == 'windows-latest' run: | - release_dir="fishfight-${{ env.RELEASE_VERSION }}" - artifact_path="fishfight-${{ env.RELEASE_VERSION }}-${{ matrix.config.target }}.zip" + release_dir="jumpy-${{ env.RELEASE_VERSION }}" + artifact_path="jumpy-${{ env.RELEASE_VERSION }}-${{ matrix.config.target }}.zip" echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_ENV mkdir $release_dir - cp target/${{ matrix.config.target }}/release/fishfight.exe $release_dir/ - strip $release_dir/fishfight.exe + cp target/${{ matrix.config.target }}/release/jumpy.exe $release_dir/ + strip $release_dir/jumpy.exe find assets -name "*.schema.json" -exec rm -f {} \; cp -R assets/ mods/ licenses/ $release_dir/ cp LICENSE $release_dir/licenses/ @@ -86,12 +86,12 @@ jobs: shell: bash if: matrix.config.os != 'windows-latest' run: | - release_dir="fishfight-${{ env.RELEASE_VERSION }}" - artifact_path="fishfight-${{ env.RELEASE_VERSION }}-${{ matrix.config.target }}.tar.gz" + release_dir="jumpy-${{ env.RELEASE_VERSION }}" + artifact_path="jumpy-${{ env.RELEASE_VERSION }}-${{ matrix.config.target }}.tar.gz" echo "ARTIFACT_PATH=$artifact_path" >> $GITHUB_ENV mkdir $release_dir - cp target/${{ matrix.config.target }}/release/fishfight $release_dir/ - strip $release_dir/fishfight || true + cp target/${{ matrix.config.target }}/release/jumpy $release_dir/ + strip $release_dir/jumpy || true find assets -name "*.schema.json" -exec rm -f {} \; cp -R assets mods licenses $release_dir cp LICENSE $release_dir/licenses @@ -121,15 +121,15 @@ jobs: run: echo "RELEASE_VERSION=${GITHUB_REF:10}" >> $GITHUB_ENV - name: Generate Checksums - run: for file in fishfight-*/fishfight-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done + run: for file in jumpy-*/jumpy-*; do openssl dgst -sha256 -r "$file" | awk '{print $1}' > "${file}.sha256"; done - name: Publish Release uses: svenstaro/upload-release-action@v2 with: release_name: Release ${{ env.RELEASE_VERSION }} - file: fishfight-*/fishfight-* + file: jumpy-*/jumpy-* file_glob: true overwrite: true - body: "FishFight ${{ env.RELEASE_VERSION }} 🐟" + body: "FishFight: Jumpy ${{ env.RELEASE_VERSION }} 🐟" tag: ${{ github.ref }} repo_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/Arcadefile b/Arcadefile index 822a40cc12..b8d810bba0 100644 --- a/Arcadefile +++ b/Arcadefile @@ -1,5 +1,5 @@ -id: fish-fight -name: Fish Fight +id: fish-fight-jumpy +name: jumpy logoUrl: /static/images/ship/original.png coverImage: original: /static/images/cover/original.jpg @@ -9,7 +9,7 @@ marketingAssets: title: cover description: Cover image description: | - Fish Fight is a tactical 2D shooter, played online or on a shared screen. + Fish Fight: Jumpy is a tactical 2D shooter, played online or on a shared screen. Aim either left or right; the rest is up to clever movement and positioning in this fish-on-fish brawler! admins: - fllr diff --git a/Cargo.lock b/Cargo.lock index 530a2072ed..00140e4c52 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -162,36 +162,6 @@ dependencies = [ "serde", ] -[[package]] -name = "fishfight" -version = "0.4.2" -dependencies = [ - "ff-particles", - "fishfight-core", - "fishsticks", - "hecs", - "macroquad", - "macroquad-platformer", - "serde", - "serde_json", - "wasm-bindgen", -] - -[[package]] -name = "fishfight-core" -version = "0.4.2" -dependencies = [ - "async-trait", - "fishsticks", - "getrandom", - "hecs", - "macroquad", - "serde", - "serde_json", - "toml", - "wasm-bindgen", -] - [[package]] name = "fishsticks" version = "0.2.3" @@ -344,6 +314,36 @@ dependencies = [ "wasm-bindgen", ] +[[package]] +name = "jumpy" +version = "0.4.3" +dependencies = [ + "ff-particles", + "fishsticks", + "hecs", + "jumpy-core", + "macroquad", + "macroquad-platformer", + "serde", + "serde_json", + "wasm-bindgen", +] + +[[package]] +name = "jumpy-core" +version = "0.4.3" +dependencies = [ + "async-trait", + "fishsticks", + "getrandom", + "hecs", + "macroquad", + "serde", + "serde_json", + "toml", + "wasm-bindgen", +] + [[package]] name = "lazy_static" version = "1.4.0" diff --git a/Cargo.toml b/Cargo.toml index f7675b8e3f..fce834e1c0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [package] -name = "fishfight" -version = "0.4.2" +name = "jumpy" +version = "0.4.3" description = "A tactical 2D shooter" -authors = ["Fish Fight Contributors"] +authors = ["The Fish Fight Game & Spicy Lobster Developers"] license = "MIT OR Apache-2.0" edition = "2021" @@ -19,8 +19,7 @@ members = ["core"] opt-level = 3 [dependencies] -core = { path = "./core", package = "fishfight-core" } -# ultimate = { path = "../FishFight-ultimate", package = "fishfight-ultimate", optional = true } +core = { path = "./core", package = "jumpy-core" } ff-particles = { version = "0.1", features = ["serde"] } fishsticks = { git = "https://github.com/fishfight/fishsticks", default-features = false, features = ["gilrs"] } macroquad = { version = "=0.3.16" } # Newer versions break is_key_pressed detection diff --git a/LICENSE b/LICENSE index 867afb0be2..200fa66590 100644 --- a/LICENSE +++ b/LICENSE @@ -1,8 +1,8 @@ -Fish Fight source code is dual-licensed under either +'Fish Fight: Jumpy' source code is dual-licensed under either * MIT License (licenses/LICENSE-MIT or http://opensource.org/licenses/MIT) * Apache License, Version 2.0 (licenses/LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) at your option. -Fish Fight media assets are Copyright (c) 2020-2022 The Fish Fight Game Developers and licensed as [CC BY-NC](https://creativecommons.org/licenses/by-nc/4.0/). +Fish Fight media assets are Copyright (c) 2020-2022 The Fish Fight Game & Spicy Lobster Developers and licensed as [CC BY-NC](https://creativecommons.org/licenses/by-nc/4.0/). diff --git a/PACKAGING.md b/PACKAGING.md index bee7182e04..85ec731a0c 100644 --- a/PACKAGING.md +++ b/PACKAGING.md @@ -1,4 +1,4 @@ -## Packaging Fish Fight +## Packaging Fish Fight: Jumpy ### Dependencies @@ -25,28 +25,28 @@ cargo run --release --locked ### Environment variables -- `FISHFIGHT_CONFIG`: configuration file (default: `config.json`) -- `FISHFIGHT_ASSETS`: assets directory (default: `assets/`) -- `FISHFIGHT_MODS`: mods directory (default: `mods/`) +- `JUMPY_CONFIG`: configuration file (default: `config.json`) +- `JUMPY_ASSETS`: assets directory (default: `assets/`) +- `JUMPY_MODS`: mods directory (default: `mods/`) ### Package -Binary will be located at `target/release/fishfight` after [build](#build). To run it, `assets` directory should be placed in the same directory or a path can be specified via `FISHFIGHT_ASSETS` environment variable. +Binary will be located at `target/release/jumpy` after [build](#build). To run it, `assets` directory should be placed in the same directory or a path can be specified via `JUMPY_ASSETS` environment variable. For example: ```sh -export FISHFIGHT_ASSETS=/opt/fishfight/assets/ -export FISHFIGHT_MODS=/opt/fishfight/mods/ -target/release/fishfight +export JUMPY_ASSETS=/opt/jumpy/assets/ +export JUMPY_MODS=/opt/jumpy/mods/ +target/release/jumpy ``` Also see [README.md#distro-packages](./README.md#distro-packages) ### Binary releases -Binary releases are automated via [Continuous Deployment](./.github/workflows/release.yml) workflow and they can be downloaded from the [releases](https://github.com/fishfight/FishFight/releases) page. Release artifacts are named in the following format: +Binary releases are automated via [Continuous Deployment](./.github/workflows/release.yml) workflow and they can be downloaded from the [releases](https://github.com/fishfight/jumpy/releases) page. Release artifacts are named in the following format: -- `fishfight--.` +- `jumpy--.` -A single archive includes the `fishfight` binary and `assets` directory. It can be verified by using a SHA256 hash file that has the same name as the artifact except it ends with ".sha256". Release artifacts are not signed at this time. +A single archive includes the `jumpy` binary and `assets` directory. It can be verified by using a SHA256 hash file that has the same name as the artifact except it ends with ".sha256". Release artifacts are not signed at this time. diff --git a/README.md b/README.md index fa4c16ca8b..79e829a13d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Fish Fight +# Fish Fight: Jumpy -[![Build Status](https://img.shields.io/github/workflow/status/fishfight/FishFight/Continuous%20integration?logo=github&labelColor=1e1c24&color=8bcfcf)](https://github.com/fishfight/FishFight/actions) [![Documentation](https://img.shields.io/badge/documentation-fishfight.github.io-green.svg?labelColor=1e1c24&color=f3ee7a)](https://fishfight.github.io/FishFight/) [![License](https://img.shields.io/badge/License-MIT%20or%20Apache%202-green.svg?label=license&labelColor=1e1c24&color=34925e)](./LICENSE) [![Discord](https://img.shields.io/badge/chat-on%20discord-green.svg?logo=discord&logoColor=fff&labelColor=1e1c24&color=8d5b3f)](https://discord.gg/4smxjcheE5) +[![Build Status](https://img.shields.io/github/workflow/status/fishfight/jumpy/Continuous%20integration?logo=github&labelColor=1e1c24&color=8bcfcf)](https://github.com/fishfight/jumpy/actions) [![Documentation](https://img.shields.io/badge/documentation-fishfight.github.io-green.svg?labelColor=1e1c24&color=f3ee7a)](https://fishfight.github.io/FishFight/) [![License](https://img.shields.io/badge/License-MIT%20or%20Apache%202-green.svg?label=license&labelColor=1e1c24&color=34925e)](./LICENSE) [![Discord](https://img.shields.io/badge/chat-on%20discord-green.svg?logo=discord&logoColor=fff&labelColor=1e1c24&color=8d5b3f)](https://discord.gg/4smxjcheE5) -![Fish Fight Preview](https://user-images.githubusercontent.com/24392180/151969075-399e9fea-e2de-4340-96a4-0a0e5b79c281.gif) +![Fish Fight: Jumpy Preview](https://user-images.githubusercontent.com/24392180/151969075-399e9fea-e2de-4340-96a4-0a0e5b79c281.gif) ## Introduction -Fish Fight is a tactical 2D shooter, played by up to 4 players online or on a shared screen. Aim either left or right; the rest is up to clever movement and positioning in this fish-on-fish brawler! For more information about our origin story (Duck Game et.al.) and big-picture plans, see our [design document](https://www.notion.so/erlendsh/Fish-Fight-1647ed74217e4e38a59bd28f4f5bc81a). +Fish Fight: Jumpy is a tactical 2D shooter, played by up to 4 players online or on a shared screen. Aim either left or right; the rest is up to clever movement and positioning in this fish-on-fish brawler! For more information about our origin story (Duck Game et.al.) and big-picture plans, see our [design document](https://www.notion.so/erlendsh/Fish-Fight-1647ed74217e4e38a59bd28f4f5bc81a). ### Key Features (WIP) @@ -26,9 +26,9 @@ https://twitter.com/fishfightgame/status/1424084016467226624 ### Contributing -Anyone involved in the Fish Fight community must follow our [code of conduct](https://github.com/fishfight/FishFight/blob/main/CODE_OF_CONDUCT.md). +Anyone involved in the Fish Fight community must follow our [code of conduct](https://github.com/fishfight/jumpy/blob/main/CODE_OF_CONDUCT.md). -If you'd like to make something for Fish Fight, check out our [help-wanted](https://github.com/fishfight/FishFight/labels/help%20wanted) issues or just ask us on [Discord](https://discord.gg/4smxjcheE5). We'll soon post an updated roadmap for the next month or two of work ahead. +If you'd like to make something for Fish Fight, check out our [help-wanted](https://github.com/fishfight/jumpy/labels/help%20wanted) issues or just ask us on [Discord](https://discord.gg/4smxjcheE5). We'll soon post an updated roadmap for the next month or two of work ahead. Before committing and opening a PR, please run the following commands and follow their instructions: 1. `cargo clippy -- -W clippy::correctness -D warnings` @@ -44,32 +44,25 @@ Before committing and opening a PR, please run the following commands and follow ## Download & play -1. Download the latest version from the [releases](https://github.com/fishfight/FishFight/releases) page. -2. Extract the archive and run the executable. (e.g. `./fishfight` or `fishfight.exe`) +1. Download the latest version from the [releases](https://github.com/fishfight/jumpy/releases) page. +2. Extract the archive and run the executable. (e.g. `./jumpy` or `jumpy.exe`) ### Launcher -[A cross-platform launcher](https://github.com/fishfight/Launcher) is also available for downloading and launching the game easily. +[A cross-platform launcher](https://github.com/fishfight/SpicyLauncher) is also available for downloading and launching the game easily. ### Distro Packages -
- Packaging status - -[![Packaging status](https://repology.org/badge/vertical-allrepos/fishfight.svg)](https://repology.org/project/fishfight/versions) - -
- #### Arch Linux ```sh -pacman -S fishfight +pacman -S jumpy ``` ## Building 1. Install Rust with [rustup.rs](https://rustup.rs/) -2. Clone this repository: `git clone https://github.com/fishfight/FishFight.git` +2. Clone this repository: `git clone https://github.com/fishfight/jumpy.git` 3. `cargo run` ## Default Keybindings @@ -78,5 +71,5 @@ You can view and modify the default keybindings in [config.toml](./config.toml). ## Credits -- [FishFight Credits](./CREDITS.md) +- [Fish Fight: Jumpy Credits](./CREDITS.md) - Input Icons: [Kadith's Icons](https://kadith.itch.io/kadiths-free-icons) by Kadith diff --git a/RELEASE.md b/RELEASE.md index 13ad090a9d..53006021af 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,10 +1,10 @@ # Creating a Release -[GitHub releases](https://github.com/fishfight/FishFight/releases) are automated via [GitHub actions](./.github/workflows/release.yml) and triggered by pushing a tag. +[GitHub releases](https://github.com/fishfight/jumpy/releases) are automated via [GitHub actions](./.github/workflows/release.yml) and triggered by pushing a tag. 1. Bump the version in [Cargo.toml](Cargo.toml) and [core/Cargo.toml](core/Cargo.toml). 2. Update [Cargo.lock](Cargo.lock) by building the project. (`cargo build`) 3. Commit and push the changes. (i.e. submit a pull request) -4. Either [draft a new release](https://github.com/fishfight/FishFight/releases/new) from the GitHub interface or create a new tag and push it via the command line. +4. Either [draft a new release](https://github.com/fishfight/jumpy/releases/new) from the GitHub interface or create a new tag and push it via the command line. 5. While naming the release, do not include the version in the title. (e.g. "Level Editor") 6. Add release notes and highlights. diff --git a/book/book.toml b/book/book.toml index e9b587701a..9909d99d20 100644 --- a/book/book.toml +++ b/book/book.toml @@ -7,5 +7,5 @@ title = "Fish Fight Documentation" [output.html] default-theme = "navy" -git-repository-url = "https://github.com/fishfight/FishFight" +git-repository-url = "https://github.com/fishfight/jumpy" git-repository-icon = "fa-github" diff --git a/core/Cargo.toml b/core/Cargo.toml index 43b5f6a9e8..4867d354ca 100644 --- a/core/Cargo.toml +++ b/core/Cargo.toml @@ -1,7 +1,7 @@ [package] -name = "fishfight-core" -version = "0.4.2" -authors = ["Fish Fight Contributors"] +name = "jumpy-core" +version = "0.4.3" +authors = ["The Fish Fight Game & Spicy Lobster Developers"] license = "MIT OR Apache-2.0" edition = "2021" diff --git a/licenses/LICENSE-APACHE b/licenses/LICENSE-APACHE index 39429f1e3b..b23f69ad8e 100644 --- a/licenses/LICENSE-APACHE +++ b/licenses/LICENSE-APACHE @@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work. same "printed page" as the copyright notice for easier identification within third-party archives. -Copyright (c) 2020-2022 The Fish Fight Game Developers +Copyright (c) 2020-2022 The Fish Fight Game & Spicy Lobster Developers Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/licenses/LICENSE-MIT b/licenses/LICENSE-MIT index 3011f8b12d..fe5c850501 100644 --- a/licenses/LICENSE-MIT +++ b/licenses/LICENSE-MIT @@ -1,4 +1,4 @@ -Copyright (c) 2020-2022 The Fish Fight Game Developers +Copyright (c) 2020-2022 The Fish Fight Game & Spicy Lobster Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/mods/test_mod_one/fishfight_mod.json b/mods/test_mod_one/jumpy_mod.json similarity index 100% rename from mods/test_mod_one/fishfight_mod.json rename to mods/test_mod_one/jumpy_mod.json diff --git a/mods/test_mod_two/fishfight_mod.json b/mods/test_mod_two/jumpy_mod.json similarity index 100% rename from mods/test_mod_two/fishfight_mod.json rename to mods/test_mod_two/jumpy_mod.json diff --git a/src/gui/credits.rs b/src/gui/credits.rs index ea0766a494..56bb63f781 100644 --- a/src/gui/credits.rs +++ b/src/gui/credits.rs @@ -9,7 +9,7 @@ const SECONDARY_HEADER_Y_OFFSET: f32 = 150.0; const TEXT_Y_OFFSET: f32 = 60.0; const CREDITS_LIST: [(&str, LabelType); 32] = [ - ("Fish Fight", LabelType::MainHeader), + ("Fish Fight: Jumpy", LabelType::MainHeader), ("Founding Team", LabelType::SecondaryHeader), ("Erlend Sogge Heggen - General Director", LabelType::Regular), ("'Emerald Jak' - Sound Director", LabelType::Regular), @@ -120,8 +120,7 @@ fn create_game_credits() -> Vec { let credit_label = credit; match credit_label.1 { LabelType::MainHeader => { - // The "Fish Fight" header sets the initial position - if credit.0 == "Fish Fight" { + if credit.0 == "Fish Fight: Jumpy" { prev_position -= MAIN_HEADER_Y_OFFSET; } else { prev_position -= -MAIN_HEADER_Y_OFFSET; diff --git a/src/main.rs b/src/main.rs index 1133e240fe..351212711d 100644 --- a/src/main.rs +++ b/src/main.rs @@ -58,11 +58,11 @@ pub use effects::{ pub type CollisionWorld = macroquad_platformer::World; -const CONFIG_FILE_ENV_VAR: &str = "FISHFIGHT_CONFIG"; -const ASSETS_DIR_ENV_VAR: &str = "FISHFIGHT_ASSETS"; -const MODS_DIR_ENV_VAR: &str = "FISHFIGHT_MODS"; +const CONFIG_FILE_ENV_VAR: &str = "JUMPY_CONFIG"; +const ASSETS_DIR_ENV_VAR: &str = "JUMPY_ASSETS"; +const MODS_DIR_ENV_VAR: &str = "JUMPY_MODS"; -const WINDOW_TITLE: &str = "Fish Fight"; +const WINDOW_TITLE: &str = "Fish Fight: Jumpy"; /// Exit to main menu pub fn exit_to_main_menu() { diff --git a/src/resources.rs b/src/resources.rs index 806884cefc..02fe697966 100644 --- a/src/resources.rs +++ b/src/resources.rs @@ -41,7 +41,7 @@ pub const MAP_PREVIEW_PLACEHOLDER_PATH: &str = "maps/no_preview.png"; pub const MAP_PREVIEW_PLACEHOLDER_ID: &str = "map_preview_placeholder"; const ACTIVE_MODS_FILE_NAME: &str = "active_mods"; -const MOD_FILE_NAME: &str = "fishfight_mod"; +const MOD_FILE_NAME: &str = "jumpy_mod"; #[derive(Serialize, Deserialize)] #[serde(deny_unknown_fields)]