Add project banner and TOC to the README

This commit is contained in:
Nathan Lovato 2020-02-07 14:54:14 -06:00
parent f1483e93a8
commit fe8afc3b70

View File

@ -1,9 +1,21 @@
# Godot Steering AI Framework #
![Project banner](./assets/banner.svg)
This project is a framework to code complex and smooth AI movement in GDScript, using steering behaviors. It works in both 2D and 3D games.
It supports all essential steering behaviors like flee, follow, look at, but also blended behaviors, group behaviors, avoiding neighbors, following a path, following the leader, and much more.
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**
- [Introduction](#introduction)
- [The framework](#the-framework)
- [Getting Started](#getting-started)
- [Example usage](#example-usage)
<!-- markdown-toc end -->
## Introduction ##
In the 1990s, [Craig Reynolds](http://www.red3d.com/cwr/) developed algorithms for common AI behaviors. They allowed AI agents to seek out or flee from a target, follow a pre-defined path, or face in a particular direction. They were simple, repeatable tasks that could be broken down into a programming algorithms which made them easy to reuse, maintain, combine and extend.