sapphire-chess 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a152a756661a6bba522bd8a75bde7074e7386a5b65c1572225da5976acd86cd8
-  data.tar.gz: 98c2040c722a85e5f5caf9a8dce9ee5caeb2bf1871b1b9dceb1e1d330de52e03
+  metadata.gz: 44df97bffb9cde364d3e734fc09129c0b0ffe860f8572ca47ed1cb304b121e2a
+  data.tar.gz: 61aa950fb118981973b8d1d58fe2ad1e4cd3e85dc8ad2c20fafdab16ef1a257b
 SHA512:
-  metadata.gz: 108d87f43ba5f8c26f6e7e607dca07cbc57e7ae79ea4675b3649d5272995351b2cc37ca9570bac11651d4694b3978bba502b0ff60a1b52e5c30541ee68d77c41
-  data.tar.gz: 7a035c86043ecec355bb910d834eec02c060f49705067b27ed2c5b9f467e5920e7adbf1bf215a31330fda448911797d4a8ded7e227b417bb96aa39832027bdcb
+  metadata.gz: 7dcdaf550d4b43871587ddacae31b28f1fe2b190732948a6db4a05423903769f16454eedf5aae3368b94e896497d96c014c96693c3b95fadfd660d1d3f377806
+  data.tar.gz: d5c4d34fda192846826a3c39eef7f06808918fad7e545dcc00e739be28ef37f48595dd62f3fae5b209c05502b48e01eedd089542c63841e0ce53a6f5efc6b482

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 1.0.1 (January 16, 2023)
+
+## Enhancement:
+
+  - Remove useless assignments in `ai.rb`
+  - Fine tune pawn location values for not hard difficulties
+
+## Documentation:
+
+  - Update `README.md`
+  - Correct typo in `sapphire-chess.gemspec`
+
+
+# 1.0.0 (January 15, 2023)
+
+Initial irst release.
+
+Please, visit https://medium.com/@lucas.sorribes/nostromo-my-ruby-chess-journey-part-i-7ef544b547a5 for a very detailed account of how I wrote this game.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sapphire-chess (1.0.0)
+    sapphire-chess (1.0.1)
       paint (~> 2.3)
 
 GEM

data/README.md

@@ -1,24 +1,62 @@
-# Sapphire Chess v0.9.0
+# Sapphire Chess [![Gem Version](https://badge.fury.io/rb/sapphire-chess.svg)](https://badge.fury.io/rb/sapphire-chess)
 
-Welcome to Sapphire Chess!
-
-This is a chess game written in pure Ruby v2.7.5. Other versions have not been tested yet.
+Sapphire Chess is a command line-based chess game with an algebraic notation input system,
+complete chess rules, a beautiful interface and a functional AI. It provides three game modes: 
+Human vs. Human, Human vs. AI, and AI vs. AI.
 
 Please, visit https://medium.com/@lucas.sorribes/nostromo-my-ruby-chess-journey-part-i-7ef544b547a5 for a very detailed account of how I wrote this game.
 
+Supported Rubies: 3.1, 3.0, 2.7. 
+The game has not been tested for older versions, but it might still work.
+
 ---
 
 ## Current Features
 
 * A beautiful board with easy-to-distinguish colors for white and black pieces.
 * Fully functional AI
-* Two game modes: human vs. computer, human vs. human.
 * Three levels of difficulty.
+* Three game modes: human vs. computer, human vs. human.
 * Full chess movement rules implementation, including castling and *en passant*, for both the human and the computer player.
 * Accepts algebraic notation for movements, with human input validation.
 * Material score display.
 * Player's last move display.
 
+## Setup
+
+Install with:
+```ruby
+gem install 'saphhire-chess'
+```
+And execute from the command prompt with:
+```
+sapphire-chess
+```
+Currently, the icons are only loaded properly from within VS Code terminals, so, for the moment, I highly recommend executing this command from there.
+
+You can also create a new `.rb` file with this content and execute it:
+```ruby
+require 'sapphire-chess'
+
+Engine.new.play
+```
+
+## Difficulty Mode
+
+The difficulty mode is based on how many turns the computer can think ahead (the depth of the tree generated by `AI#minimax`, max. 3), the aggressiveness of the pieces, and the enemy's carelessness.
+
+My recommendation is to play the game on the *hard* mode, as this was the original intention when I designed it. I introduced the other difficulties based on the suggestions from those who weren't able to beat the machine. However, the hard mode, due to the current Minimax implementation, is a little slow; I'm working on ways to improve the performance of this method.
+
 ## Screenshot
 
-![Game screenshot](./screenshot.png)
+![Game screenshot](https://live.staticflickr.com/65535/52630422741_bc858d0096_z.jpg)
+
+## The AI
+
+The AI is based on a Minimax algorithm with Alpha-Beta pruning. This algorithm generates possible outcomes (*children*) for a provisional move: Each branch represents the enemy's possible move in the next turn as an answer to the provisional move; (i.e.: if current player is white [the maximizing player], it generates every possible movement for the next player, black [the minimizing player], who will choose the best possible move, and so on. 
+
+The best (relative to each player) possible outcome for each move will determine what move is chosen) The Alpha-Beta 'prunes' the tree: it makes the search more efficient, removing unnecessary branches, resulting in a faster process.
+
+Copyright © 2023 Lucas Sorribes, released under the MIT license.
+
+

data/lib/sapphire-chess/ai.rb

@@ -22,22 +22,11 @@ module AI
     move_randomizer(evaluations)
   end
 
+  # See README.md for an explanation of this method.
   def minimax(move, depth, alpha, beta, maximizing_player)
     return board.evaluate if depth.zero?
 
-    move_final_evaluation =
     board.provisional(move, color) do
-      # This generates possible outcomes (children) for the provisional move:
-      # Each branch represents the next turn (i.e.: if current player is white
-      # [the maximizing player], it generates every possible movement for the
-      # next player, black [the minimizing player], who will choose the best
-      # possible move, and so on. The best (relative to each player) possible
-      # outcome for each move will determine what move is chosen, `best_evaluation`)
-      # See AI#computer_chooses_move
-
-      # The alpha-beta `prunes` the tree: it makes the search more efficient
-      # removing unnecessary branches, resulting in a faster process.
-      move_final_evaluation =
         if maximizing_player
           best_minimizing_evaluation = Float::INFINITY
 
@@ -62,8 +51,6 @@ module AI
           best_maximizing_evaluation
         end
     end
-
-    move_final_evaluation
   end
 
   # This method randomizes the moves if two or more moves share the best evaluation.

data/lib/sapphire-chess/pieces/pawn.rb

@@ -43,7 +43,7 @@ class Pawn < Piece
     [50, 50, 60, 60, 60, 60, 50, 50],
     [50, 50, 60, 60, 60, 60, 50, 50],
     [50, 50, 60, 0, 0, 60, 50, 50],
-    [50, 50, 10, 0, 0, 10, 50, 50],
+    [50, 40, 10, 0, 0, 10, 40, 50],
     [5, 10, 10, -20, -20, 10, 10, 5],
     [0, 0, 0, 0, 0, 0, 0, 0]
   ].freeze
@@ -51,7 +51,7 @@ class Pawn < Piece
   BLACK_LOCATION_VALUE_EASY = [
     [0, 0, 0, 0, 0, 0, 0, 0],
     [5, 10, 10, -20, -20, 10, 10, 5],
-    [50, 50, 10, 0, 0, 10, 50, 50],
+    [50, 40, 10, 0, 0, 10, 40, 50],
     [50, 50, 60, 0, 0, 60, 50, 50],
     [50, 50, 60, 60, 60, 60, 50, 50],
     [50, 50, 60, 60, 60, 60, 50, 50],

data/lib/sapphire-chess/version.rb

@@ -1,3 +1,3 @@
 module SapphireChess
-  VERSION ||= '1.0.0'
+  VERSION ||= '1.0.1'
 end

data/sapphire-chess.gemspec

@@ -6,14 +6,14 @@ Gem::Specification.new do |spec|
   spec.summary     = 'Command line-based chess game'
   spec.description = <<-EOF
     Sapphire Chess is a command line-based chess game with an algebraic notation input system,
-    complete chess rules, a beautiful interface and a functional AI. It provides three game modes: 
-    Human vs. Human, Human vs. Ai, and AI vs. AI.
+    complete chess rules, a beautiful interface, and a functional AI. It provides three game modes: 
+    Human vs. Human, Human vs. AI, and AI vs. AI.
   EOF
   spec.authors     = ['Lucas Sorribes']
   spec.email       = 'lucas.sorribes@gmail.com'
   spec.license     = 'MIT'
   spec.homepage    = 'https://github.com/lucsorr/sapphire-chess'
-  spec.files       = Dir['lib/**/*.rb'] + %w[Gemfile Gemfile.lock LICENSE Rakefile sapphire-chess.gemspec]
+  spec.files       = Dir['lib/**/*.rb'] + %w[Gemfile Gemfile.lock LICENSE Rakefile sapphire-chess.gemspec CHANGELOG.md]
   spec.bindir      = 'bin'
   spec.executables << 'sapphire-chess'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapphire-chess
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lucas Sorribes
@@ -67,8 +67,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.4'
 description: "    Sapphire Chess is a command line-based chess game with an algebraic
-  notation input system,\n    complete chess rules, a beautiful interface and a functional
-  AI. It provides three game modes: \n    Human vs. Human, Human vs. Ai, and AI vs.
+  notation input system,\n    complete chess rules, a beautiful interface, and a functional
+  AI. It provides three game modes: \n    Human vs. Human, Human vs. AI, and AI vs.
   AI.\n"
 email: lucas.sorribes@gmail.com
 executables:
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE