rpg

master branch1 version
  • master branchlatestSep 21, 2024

github.com/mswieboda/rpg-cr

2D RPG base game in CrSFML

0 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  rpg:
    github: mswieboda/rpg-cr
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 1.13.2
License
MIT
Author
Matt Swieboda
Target
  • rpg from src/rpg.cr

Dependencies

Runtime Dependencies

  • game_sf0.32.2github: mswieboda/game_sf

Development Dependencies

  • ameba*github: crystal-ameba/amebadev

README

RPG

Installation

install SFML 2.5.1

if on a mac, you can use https://github.com/mswieboda/homebrew-sfml for brew install mswieboda/homebrew-sfml/sfml@2.5 if on mac silicon, you'll need to build SFML 2.5.1 from source following: https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php (will update here with correct instructions) NOTE: currently 2.5.1 doesn't work with mac silicon, and 2.6.x crsfml isn't working on windows yet, so TBD on this

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/rpg-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, rpg.app (created by Platypus) to build/rpg-mac.zip

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This branch

Branch
master
Seen
Sep 21, 2024
Crystal
>= 1.13.2
Indexed
yes

Dependents

No indexed shard depends on this one yet.

Repository

github.com/mswieboda/rpg-cr

Metadata

Created
Aug 12, 2026
Updated
Sep 26, 2026
Synced
Sep 26, 2026
Versions
1