Skip to content

Latest commit

聽

History

History
58 lines (34 loc) 路 2.14 KB

PACKAGING.md

File metadata and controls

58 lines (34 loc) 路 2.14 KB
Raw

Packaging Fish Folk: Jumpy

Dependencies

See Bevy dependencies.

Build dependencies

Runtime dependencies

Build

# export CARGO_TARGET_DIR=target
cargo run --release --locked

Environment variables

  • JUMPY_ASSETS: assets directory (default: assets/)
  • JUMPY_ASSET_PACKS: mods directory (default: packs/)

Package

Binary will be located at target/release/jumpy after 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:

export JUMPY_ASSETS=/opt/jumpy/assets/
target/release/jumpy

The desktop file in the contrib/ directory can be installed to allow running the game from your desktop's app launcher.

Also see README.md#distro-packages

Binary releases

Binary releases are automated via Continuous Deployment workflow and they can be downloaded from the releases page. Release artifacts are named in the following format:

  • jumpy-<version>-<target>.<ext>

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.

Steam

This is WIP. In the steam folder there is a ./package_steam.sh script. This pulls the latest github release and prepares windows/linx/apple builds as .zip files to be prepared for upload to steam. Output is in ./steam/packaged dir. Subsequent runs cleanup built packages.

To prepare packages other than latest, can be run as: VERSION=v0.10.0 ./package_steam.sh.

This script also adds some additional launch scripts (see ./steam/launch_scripts).