This README is the one indexed from the repository at its latest ref, not from the tag for this version.

A* pathfinding algorithm

Installation

Add this to your application's shard.yml:

dependencies:
  a-star:
    github: petoem/a-star.cr

Usage

require "a-star"

# `Node(T)` is generic and can store any type eg. `String`
a = AStar::Node.new "A"
b = AStar::Node.new "B"
c = AStar::Node.new "C"
d = AStar::Node.new "D"

# Connect nodes to each other
# `Node#connect` connects self to other and vice versa with given distance
a.connect b, 1
b.connect c, 3
c.connect d, 2
b.connect d, 1

# Runs A* search from `start` to `goal` and uses block as heuristic function
# Returns an `Array` of `Node(T)` or `Nil`
path = AStar.search a, d do |node, goal|
  # Your heuristic algorithm here ...
end

if path
  puts "Found a solution."
else
  puts "No path found."
end

See examples directory for more.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• petoem Michael Petö - creator, maintainer