forester-rs 0.1.1

About

Forester represents a framework that provides the toolkit to perform the effective task orckestrations. The tasks can be performed synchronously or asynchronously, locally or remotely. Forester takes care of the correct performance and distribution of the tasks. The main concept of the framework is the flow based on the behavior trees it can be effectively used in the game, ai, robotic areas, or anywhere where the workflow engine can be applied.

Example

The language is very simple

import "std::actions"

root main sequence {
    store_str("info", "initial")
    retryer(task({}), success())
    store_str("field","some_info")
}

fallback retryer(t:tree, default:tree){
    retry(5) t(..)
    fail("just should fail")
    default(..)
}

impl task(config: object);

and simulator test

#[test]
fn smoke() {
    let mut sb = SimulatorBuilder::new();

    let root = test_folder("simulator/smoke");

    sb.root(root);
    sb.profile(PathBuf::from("sim.yaml"));
    sb.main_file("main.tree".to_string());

    let mut sim = sb.build().unwrap();
    let tracer = &sim.forester.tracer;
    sim.run().unwrap();
}

or running from the console

forest sim --root tree\tests\simulator\smoke\  --profile sim.yaml

Why Forester

The main idea and the target of Forester is to make the process of chaining a complex logic of the different tasks together effective and easy.

The following set of features is summoned to highlight the framework among the others.

• The dsl to describe the logic
• The framework provides the ability to create async and sync tasks
• The framework provides the ability to create remote and local tasks
• The tooling to visualize and trace the execution of the tree
• The simulation mode is supposed to aid with the design decisions
• The optimizations and analysis of the tree
• The validations engine allows the users to create the manually defined validations

Why Behaviour trees

Firstly, they provide a strong math abstraction over the orchestration logic
and enables to separate the business logic and the tree logic itself.

On the other hand, they have only a small set of logically conjucted components making the design easier,

Articles that introduce into the basics of the behaviour trees

• Chris Simpson’s Behavior trees for AI: How they work
• Introduction to behavior trees
• State Machines vs Behavior Trees

Documentation

The common documentation is available as a mini-book, describing all aspects of working with the framework

Contributing

A guideline about contributing to Forester can be found in the CONTRIBUTING.md file.

License

Forester is released under the Apache License, Version 2.0.