game_sf_template

Version, currently 0.1.44 versions

github.com/mswieboda/game_sf_template

template repo for Game SF (CrSFML)

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  game_sf_template:
    github: mswieboda/game_sf_template
    version: ~> 0.1.4

Then run:

shards install

shard.yml

Crystal
>= 1.12.1
License
MIT
Author
Matt Swieboda
Target
  • game_sf_template from src/game_sf_template.cr

Dependencies

Runtime Dependencies

  • game_sf0.18.0github: mswieboda/game_sf

Development Dependencies

  • ameba*github: crystal-ameba/amebadev

README

Game SF Template

Rename

To use this template, use the rename script, and follow the prompts, to automatically replace all text, and rename all files and folders from the example of GameSFTemplate, game_sf_template and Game SF Template.

make rename

Installation

install SFML

shards install

Windows

if compiling/installing from Windows, please follow game_sf windows instructions

Linter

bin/ameba

or

bin/ameba --fix
bin/ameba --gen-config

etc, see ameba

Compiling

Dev / Test

make

or

make test

Release

make release

Packaging

Windows

creates Windows release build, packages and zips

make winpack

you'll need 7z (7zip binary) installed (download)

zips up SFML DLLs, assets, run.bat (basically the .exe) to build/game_sf_template-win.zip

Mac

make macpack

creates Mac OSX release build, packages and zips

you'll need installed:

  • 7zz (7zip binary) via brew install 7zip
  • platypus (Platypus binary) via brew install --cask platypus then in Platypus > Preferences install the command line tool

zips up SFML libs, ext libs, assets, game_sf_template.app (created by Platypus) to build/game_sf_template-mac.zip