Skip to content

Latest commit

 

History

History
51 lines (44 loc) · 1.58 KB

README.md

File metadata and controls

51 lines (44 loc) · 1.58 KB
Raw

hangman

This package was created for academic use. It contains a Swift implementation of a strategic game and a CLI tool for creating game simulations.

Requirements

This is used on Mac OS, but it might also run on Linux. You should have Swift 4.2 installed.

You need the protoc compiler and the swift plugin to build the included protocol buffers schema. See the plugin repo for more information.

# Install via homebrew
brew install swift-protobuf

Installation

Mac OS

  • Go to releases tab
  • download the installation package (pkg file) for the latest release.
  • open the package and follow installation instructions
  • if OS X complains about missing signature, right-click the pkg and choose open

Build from source

Xcodebuild

# Clone this repo
cd ~/documents/code
git clone --recurse-submodules git@github.com:strategic-games/hangman.git
cd hangman
# Generate proto schema
./Scripts/generate-proto.sh
# Build with xcodebuild
xcodebuild install -scheme hangman-Package

The hangman-.pkg file will bi placed in /tmp. Go there and install the pkg.

Swift

# Clone this repo
cd ~/documents/code
git clone --recurse-submodules git@github.com:strategic-games/hangman.git
cd hangman
# Generate proto schema
./Scripts/generate-proto.sh
# Build with swift
swift build -c release
# Run hangman
swift run -c release hangman --help
# Copy hangman to a binary search path where it is found from anywhere (optional)
cp .build/release/hangman ~/bin/
hangman --help