Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kelindar committed Nov 11, 2023
1 parent 0bd030d commit 44a131b
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: [kelindar]
Binary file added .github/logo.pdn
Binary file not shown.
Binary file added .github/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Test
on: [push, pull_request]
env:
GITHUB_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
GO111MODULE: "on"
jobs:
test:
name: Test with Coverage
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v1
with:
go-version: "1.21"
- name: Check out code
uses: actions/checkout@v2
- name: Install dependencies
run: |
go mod download
- name: Run Unit Tests
run: |
go test -tags noasm -race -covermode atomic -coverprofile=profile.cov ./...
go test -race ./...
- name: Upload Coverage
uses: shogo82148/actions-goveralls@v1
with:
path-to-profile: profile.cov
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<p align="center">
<img width="270" height="110" src=".github/logo.png" border="0" alt="kelindar/goap">
<br>
<img src="https://img.shields.io/github/go-mod/go-version/kelindar/goap" alt="Go Version">
<a href="https://pkg.go.dev/github.com/kelindar/goap"><img src="https://pkg.go.dev/badge/github.com/kelindar/goap" alt="PkgGoDev"></a>
<a href="https://goreportcard.com/report/github.com/kelindar/goap"><img src="https://goreportcard.com/badge/github.com/kelindar/goap" alt="Go Report Card"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
<a href="https://coveralls.io/github/kelindar/goap"><img src="https://coveralls.io/repos/github/kelindar/goap/badge.svg" alt="Coverage"></a>
</p>

## GOAP: Goal-Oriented Action Planning in Go

**GOAP** is a Goal-Oriented Action Planning library written in Go. It is designed to help you find plans to achieve a specific goal by selecting appropriate actions from a set of available actions. GOAP is well-suited for solving complex decision-making problems, such as AI planning in games, robotics, and other applications.

### Features

1. **High Performance**: This library is designed for efficiency and performance, making it suitable for real-time applications.

2. **Flexible Actions**: Define custom actions that can be used in the planning process.

3. **Numeric and Symbolic States**: The library supports both numeric and symbolic states, making it versatile for various types of problems

4. **Heuristic Search**: The library uses heuristic search (A\*) to efficiently explore possible plans.

## License

This library is licensed under the MIT license. See the [LICENSE](https://github.com/kelindar/goap/LICENSE) file in the project root for more details.

## Credits

This library is developed and maintained by [Roman Atachiants](https://github.com/kelindar) and contributions from the open-source community. We welcome contributions and feedback to make the library even better.

0 comments on commit 44a131b

Please sign in to comment.