Improvements into webservice layout for the huge bots

examples/lookatplayers.js

@@ -3,14 +3,14 @@
  */
 const mineflayer = require('mineflayer')
 
-if (process.argv.length < 4 || process.argv.length > 6) {
+if (process.argv.length < 3 || process.argv.length > 6) {
   console.log('Usage : node lookatplayers.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 
 const bot = mineflayer.createBot({
   host: process.argv[2],
-  port: parseInt(process.argv[3]),
+  port: process.argv[3] ? parseInt(process.argv[3]) : 25565,
   username: process.argv[4] ? process.argv[4] : 'statemachine_bot',
   password: process.argv[5]
 })

examples/webserver.js

@@ -1,13 +1,13 @@
 const mineflayer = require('mineflayer')
 
-if (process.argv.length < 4 || process.argv.length > 6) {
+if (process.argv.length < 3 || process.argv.length > 6) {
   console.log('Usage : node webserver.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 
 const bot = mineflayer.createBot({
   host: process.argv[2],
-  port: parseInt(process.argv[3]),
+  port: process.argv[3] ? parseInt(process.argv[3]) : 25565,
   username: process.argv[4] ? process.argv[4] : 'statemachine_bot',
   password: process.argv[5]
 })
@@ -119,7 +119,7 @@ bot.once('spawn', () => {
   ]
 
   const root = new NestedStateMachine(transitions, printServerStates)
-  root.name = 'main'
+  root.stateName = 'main'
 
   bot.on('chat', (username, message) => {
     if (message === 'hi') { transitions[1].trigger() }

examples/webserver_nested.ts

@@ -0,0 +1,164 @@
+import mineflayer, { Bot } from 'mineflayer'
+import {
+  globalSettings,
+  StateTransition,
+  BotStateMachine,
+  StateMachineWebserver,
+  EntityFilters,
+  BehaviorIdle,
+  BehaviorPrintServerStats,
+  BehaviorFollowEntity,
+  BehaviorLookAtEntity,
+  BehaviorGetClosestEntity,
+  NestedStateMachine,
+  StateMachineTargets
+} from './../src'
+
+import { pathfinder } from 'mineflayer-pathfinder'
+
+if (process.argv.length < 3 || process.argv.length > 6) {
+  console.log('Usage : node lookatplayers.js <host> <port> [<name>] [<password>]')
+  process.exit(1)
+}
+
+const bot = mineflayer.createBot({
+  host: process.argv[2],
+  port: process.argv[3] !== null ? parseInt(process.argv[3]) : 25565,
+  username: process.argv[4] !== null ? process.argv[4] : 'statemachine_bot',
+  password: process.argv[5]
+})
+
+bot.loadPlugin(pathfinder)
+
+globalSettings.debugMode = true
+
+bot.once('spawn', () => {
+  const targets = {}
+
+  const printServerStates = new BehaviorPrintServerStats(bot)
+  printServerStates.x = 100
+  printServerStates.y = 100
+
+  const idleState = new BehaviorIdle()
+  idleState.x = 400
+  idleState.y = 100
+
+  const getClosestPlayer = new BehaviorGetClosestEntity(bot, targets, EntityFilters().PlayersOnly)
+  getClosestPlayer.x = 700
+  getClosestPlayer.y = 100
+
+  const followingUser = followUser(bot, targets)
+  followingUser.x = 550
+  followingUser.y = 210
+
+  const transitions = [
+
+    new StateTransition({
+      parent: printServerStates,
+      child: idleState,
+      shouldTransition: () => true
+    }),
+
+    new StateTransition({
+      parent: idleState,
+      child: getClosestPlayer,
+      name: 'player says "hi"',
+      onTransition: () => bot.chat('hello')
+    }),
+
+    new StateTransition({
+      parent: followingUser,
+      child: idleState,
+      name: 'player says "bye"',
+      onTransition: () => bot.chat('goodbye')
+    }),
+
+    new StateTransition({
+      parent: getClosestPlayer,
+      child: followingUser,
+      shouldTransition: () => true
+    })
+  ]
+
+  const root = new NestedStateMachine(transitions, printServerStates)
+  root.stateName = 'Main'
+
+  bot.on('chat', (username, message) => {
+    if (message === 'hi') {
+      transitions.find(t => t.name === 'player says "hi"')?.trigger()
+    }
+
+    if (message === 'bye') {
+      transitions.find(t => t.name === 'player says "bye"')?.trigger()
+    }
+  })
+
+  // This function can be in another file
+  function followUser (bot: Bot, targets: StateMachineTargets): NestedStateMachine {
+    const lookAtPlayersState = new BehaviorLookAtEntity(bot, targets)
+    lookAtPlayersState.x = 400
+    lookAtPlayersState.y = 25
+
+    const followPlayer = new BehaviorFollowEntity(bot, targets)
+    followPlayer.x = 200
+    followPlayer.y = 200
+
+    const lookAtFollowTarget = new BehaviorLookAtEntity(bot, targets)
+    lookAtFollowTarget.x = 600
+    lookAtFollowTarget.y = 200
+
+    const transitions = [
+      new StateTransition({
+        parent: lookAtPlayersState,
+        child: followPlayer,
+        name: 'player says "come"'
+      }),
+
+      new StateTransition({
+        parent: followPlayer,
+        child: lookAtFollowTarget,
+        name: 'closeToTarget',
+        shouldTransition: () => followPlayer.distanceToTarget() < 2
+      }),
+
+      new StateTransition({
+        parent: lookAtFollowTarget,
+        child: followPlayer,
+        name: 'farFromTarget',
+        shouldTransition: () => lookAtFollowTarget.distanceToTarget() >= 2
+      }),
+
+      new StateTransition({
+        parent: followPlayer,
+        child: lookAtPlayersState,
+        name: 'player says "stay"',
+        onTransition: () => bot.chat('staying')
+      }),
+
+      new StateTransition({
+        parent: lookAtFollowTarget,
+        child: lookAtPlayersState,
+        name: 'player says "stay"'
+      })
+    ]
+
+    bot.on('chat', (username, message) => {
+      if (message === 'come') {
+        transitions.find(t => t.name === 'player says "come"')?.trigger()
+      }
+
+      if (message === 'stay') {
+        transitions.filter(t => t.name === 'player says "stay"')
+          .forEach(t => t.trigger())
+      }
+    })
+
+    const nestedState = new NestedStateMachine(transitions, lookAtPlayersState)
+    nestedState.stateName = 'Follow the entity'
+    return nestedState
+  }
+
+  const stateMachine = new BotStateMachine(bot, root)
+  const webserver = new StateMachineWebserver(bot, stateMachine)
+  webserver.startServer()
+})

examples/webserver_static_layout.js

@@ -136,7 +136,7 @@ bot.once('spawn', () => {
   ]
 
   const root = new NestedStateMachine(transitions, printServerStates)
-  root.name = 'main'
+  root.stateName = 'main'
 
   bot.on('chat', (username, message) => {
     if (message === 'hi') { transitions[1].trigger() }

package.json

@@ -6,6 +6,7 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "ts-standard && tsc",
+    "watch": "tsc -w",
     "clean": "rm -rf lib",
     "test": "test",
     "fix-lint": "ts-standard --fix"
@@ -58,4 +59,4 @@
       "lib"
     ]
   }
-}
+}

src/statemachine.ts

@@ -245,7 +245,7 @@ export class NestedStateMachine extends EventEmitter implements StateBehavior {
   /**
      * A list of all states within this state machine layer.
      */
-  readonly states: StateBehavior[]
+  readonly states: Array<StateBehavior | NestedStateMachine>
 
   /**
      * A list of all transitions within this state machine layer.

src/webserver.ts

@@ -1,5 +1,5 @@
 import { Bot } from 'mineflayer'
-import { BotStateMachine, StateBehavior } from './statemachine'
+import { BotStateMachine, NestedStateMachine, StateBehavior } from './statemachine'
 import socketLoader, { Socket } from 'socket.io'
 import path from 'path'
 import express from 'express'
@@ -93,11 +93,13 @@ export class StateMachineWebserver {
     const states = this.getStates()
     const transitions = this.getTransitions()
     const nestGroups = this.getNestGroups()
+    const nestGroupsTree: NestedStateMachinePacketTree[] = this.getNestGroupsTree(this.stateMachine.rootStateMachine, true, nestGroups) as NestedStateMachinePacketTree[]
 
     const packet: StateMachineStructurePacket = {
       states,
       transitions,
-      nestGroups
+      nestGroups,
+      nestGroupsTree
     }
 
     socket.emit('connected', packet)
@@ -175,6 +177,7 @@ export class StateMachineWebserver {
       const nest = this.stateMachine.nestedStateMachines[i]
       nestGroups.push({
         id: i,
+        stateId: this.stateMachine.states.indexOf(nest),
         enter: this.stateMachine.states.indexOf(nest.enter),
         exit: nest.exit != null ? this.stateMachine.states.indexOf(nest.exit) : undefined,
         indent: nest.depth ?? -1,
@@ -184,21 +187,73 @@ export class StateMachineWebserver {
 
     return nestGroups
   }
+
+  private getNestGroupsTree (currentState: NestedStateMachine, firstState: boolean, nestedStateMachine: NestedStateMachinePacket[]): NestedStateMachinePacketTree[] | NestedStateMachinePacketTree {
+    const statesOnThisBehavior: NestedStateMachinePacketTree[] = []
+
+    currentState.states.forEach((state) => {
+      if (isNestedStateMachine(state)) {
+        const subStates = this.getNestGroupsTree(state, false, nestedStateMachine)
+        if (!Array.isArray(subStates)) {
+          statesOnThisBehavior.push(subStates)
+        }
+      }
+    })
+
+    const currentStateId = this.stateMachine.states.indexOf(currentState)
+
+    const returnData: NestedStateMachinePacketTree = {
+      id: nestedStateMachine.find((n) => n.stateId === currentStateId)?.id ?? 0,
+      stateId: currentStateId,
+      enter: this.stateMachine.states.indexOf(currentState.enter),
+      exit: currentState.exit != null ? this.stateMachine.states.indexOf(currentState.exit) : undefined,
+      name: currentState.stateName,
+      open: false,
+      selected: false,
+      type: statesOnThisBehavior.length > 0 ? 'folder' : 'file',
+      children: statesOnThisBehavior
+    }
+
+    if (firstState) {
+      returnData.selected = true
+      return [returnData]
+    }
+
+    return returnData
+  }
+}
+
+const isNestedStateMachine = (state: NestedStateMachine | StateBehavior): state is NestedStateMachine => {
+  return state instanceof NestedStateMachine
 }
 
 interface StateMachineStructurePacket {
   states: StateMachineStatePacket[]
   transitions: StateMachineTransitionPacket[]
   nestGroups: NestedStateMachinePacket[]
+  nestGroupsTree: NestedStateMachinePacketTree[]
+
 }
 
 interface NestedStateMachinePacket {
   id: number
+  stateId: number
   enter: number
   exit?: number
   indent: number
   name?: string
 }
+interface NestedStateMachinePacketTree {
+  id: number
+  stateId: number
+  enter: number
+  exit?: number
+  name: string
+  open: boolean
+  selected: boolean
+  type: 'folder' | 'file'
+  children: NestedStateMachinePacketTree[]
+}
 
 interface StateMachineStatePacket {
   id: number

tsconfig.eslint.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+      "types": ["@types/node"],
+      "noEmit": true,
+      "allowJs": true
+    },
+    "extends": "./tsconfig.json",
+    "include": [
+        "src",
+        "examples",
+    ]
+  }