utility-ai

A small Utility Ai Framework

Usage no npm install needed!

<script type="module">
  import utilityAi from 'https://cdn.skypack.dev/utility-ai';
</script>

README

Build Status npm version


Utility Ai

A small Utility Ai Framework

Install

npm install utility-ai
yarn add utility-ai

Usage

  const UtilityAi = require("utility-ai")

  utility_ai = new UtilityAi

  // define your actions e.g "Move to Enemy", "Fire at Enemy", "Move to Cover", "Reload Gun"
  utility_ai.addAction("Move to Enemy", action => {

    // each score expects a number as return value, the higher the better the action will be weighted
    action.score("Distance to Enemy", ({ player, enemy }) => {
      return player.distanceTo(enemy)
    })

    action.score("Gun is not loaded", ({ player }) => {
      return player.gunEmpty() && -100
    })

  })

  utility_ai.addAction("Fire at Enemy", action => {

    action.score("Proximity to Enemy < 50", ({ player, enemy }) => {
      return player.distanceTo(enemy) < 50 && 75
    })

    action.score("Cannot make it to cover", ({ player }) => {
      return player.nextCoverDistance() > 25 && 50
    })

    action.score("Gun is not loaded", ({ player }) => {
      return player.gunEmpty() && -125
    })

  })

  utility_ai.addAction("Move to Cover", action => {

    action.score("Is not in cover", ({ player }) => {
      return !player.isInCover() && 50
    })

    action.score("Proximity to Cover < 50", ({ player }) => {
      return player.nextCoverDistance() < 50 && 50
    })

  })

  utility_ai.addAction("Reload Gun", action => {

    action.score("Gun is not loaded", ({ player }) => {
      return player.gunEmpty() && 75
    })

    action.score("Is in Cover", ({ player }) => {
      return player.isInCover() && 50
    })

    action.score("Gun is loaded", ({ player }) => {
      return !player.gunEmpty() && -125
    })

  })

  const data = {
    player: {...},
    enemy: {...}
  }

  // starts the evaluation of a given world state and returns its best action
  const result = utility_ai.evaluate(data)
  // e.g. result = { action: "Move to Cover", score: 100 }