PapyrusCore

Reusable library for playing board games with similar rules to Scrabble.

Example implementation of a 3 player game (1 human, 2 computers):

// NOTE: Rather than block the main thread, your 'Dictionary' object should be created on a background thread
// this has been omitted to reduce complexity

// Create a dictionary object for determining and validating moves
// Dictionary must conform to 'Lookup' protocol (like my AnagramDictionary)
let dictionary = AnagramDictionary(filename: "DICTIONARY")!

// Create players that will be challenging eachother
let human = Human()
let hardAI = Computer()
let easyAI = Computer(difficulty: .easy)
let players = [human, hardAI, easyAI]

// Path to configuration file containing game layout information (see below)
let configFileURL = ...

// Now we have everything configured, we can create a Game object
let game = Game(config: configFileURL, dictionary: dictionary, players: players) { event in 
  // Switch to main thread before updating UI...
  Dispatch.main.async() {
    switch event {
      case let .over(game, winner):
        print("Winner: \(winner)")
      
      case let .turnStarted(game):
        // UI should be enabled if game.player is 'Human'
        print("Turn Started")
      
      case let .turnEnded(game):
        // UI should be disabled if game.player is 'Human'
        print("Turn Ended")
    
      case let .move(game, solution):
        print("Word Played \(solution.word)")
      
      case let .drewTiles(game, letters):
        print("Drew Tiles \(letters)")
      
      case let .swappedTiles(game):
        print("Swapped Tiles")
    }
  }
}

// Finally, when you're ready to start the game you can call
game.start()

Example configuration file (Scrabble):

{
  "allTilesUsedBonus": 50,
  "maximumWordLength": 15,
  "vowels": ["a", "e", "i", "o", "u"],
  "letters": {
    "_": 2, "a": 9, "b": 2, "c": 2, "d": 4,
    "e": 12, "f": 2, "g": 3, "h": 2, "i": 9,
    "j": 1, "k": 1, "l": 4, "m": 2, "n": 6,
    "o": 8, "p": 2, "q": 1, "r": 6, "s": 4,
    "t": 6, "u": 4, "v": 2, "w": 2, "x": 1,
    "y": 2, "z": 1},
  "letterPoints": {
    "_": 0, "a": 1, "b": 3, "c": 3, "d": 2,
    "e": 1, "f": 4, "g": 2, "h": 4, "i": 1,
    "j": 8, "k": 5, "l": 1, "m": 3, "n": 1,
    "o": 1, "p": 3, "q": 10, "r": 1, "s": 1,
    "t": 1, "u": 1, "v": 4, "w": 4, "x": 8,
    "y": 4, "z": 10},
  "letterMultipliers": [
      [1,1,1,2,1,1,1,1,1,1,1,2,1,1,1],
      [1,1,1,1,1,3,1,1,1,3,1,1,1,1,1],
      [1,1,1,1,1,1,2,1,2,1,1,1,1,1,1],
      [2,1,1,1,1,1,1,2,1,1,1,1,1,1,2],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [1,3,1,1,1,3,1,1,1,3,1,1,1,3,1],
      [1,1,2,1,1,1,2,1,2,1,1,1,2,1,1],
      [1,1,1,2,1,1,1,1,1,1,1,2,1,1,1],
      [1,1,2,1,1,1,2,1,2,1,1,1,2,1,1],
      [1,3,1,1,1,3,1,1,1,3,1,1,1,3,1],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [2,1,1,1,1,1,1,2,1,1,1,1,1,1,2],
      [1,1,1,1,1,1,2,1,2,1,1,1,1,1,1],
      [1,1,1,1,1,3,1,1,1,3,1,1,1,1,1],
      [1,1,1,2,1,1,1,1,1,1,1,2,1,1,1]],
  "wordMultipliers": [
      [3,1,1,1,1,1,1,3,1,1,1,1,1,1,3],
      [1,2,1,1,1,1,1,1,1,1,1,1,1,2,1],
      [1,1,2,1,1,1,1,1,1,1,1,1,2,1,1],
      [1,1,1,2,1,1,1,1,1,1,1,2,1,1,1],
      [1,1,1,1,2,1,1,1,1,1,2,1,1,1,1],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [3,1,1,1,1,1,1,2,1,1,1,1,1,1,3],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],
      [1,1,1,1,2,1,1,1,1,1,2,1,1,1,1],
      [1,1,1,2,1,1,1,1,1,1,1,2,1,1,1],
      [1,1,2,1,1,1,1,1,1,1,1,1,2,1,1],
      [1,2,1,1,1,1,1,1,1,1,1,1,1,2,1],
      [3,1,1,1,1,1,1,3,1,1,1,1,1,1,3]]
}

Object Types

Bag

The tile bag, provides methods for drawing and replacing tiles in a distribution.

Board

The current board representation.

Game

Main class responsible for gameplay, handles saving and restoring game state (via save(to:) and Game(restoring:) methods).

Exposes various actions that a Human player may want to take including: move validation, shuffling and rearranging your rack, skipping, submitting moves, suggested moves, and swapping tiles. AI play will be handled automatically once nextTurn is called.

Player

A player can be either a Human or a Computer, Computer's have a difficulty associated with them and are automated. Both have the solutions they have played, the tiles they have in their rack and their score.

cjnevin/PapyrusCore