Skip to content

org-arl/fjage

Repository files navigation

fjåge

Framework for Java and Groovy Agents

Introduction

fjåge provides a lightweight and easy-to-learn framework for agent-oriented software development in Java and Groovy. Although most of the functionality of the framework can be used in pure-Java projects, the adoption of Groovy in the project simplifies development immensely. Typically, initialization scripts, shell interaction and command scripts are written in Groovy. Agents and support classes may be written in Java or Groovy.

Key Features

  • Lightweight and fast
  • Easy to learn, and rapid agent development cycle
  • Agent development in Java or Groovy
  • Interactive Groovy shell and scripting
  • Easy switching between realtime operation and discrete event simulation
  • APIs for access from Java, Groovy, Python, C, Julia, and Javascript
  • JSON-based protocol to interface with external applications

Documentation

Support

Maven Central dependency

<dependency>
  <groupId>com.github.org-arl</groupId>
  <artifactId>fjage</artifactId>
  <version>1.14.0</version>
</dependency>

Contributing

Contributions are always welcome! Clone, develop and do a pull request!

Try to stick to the coding style already in use in the repository. Additionally, some guidelines:

Building:

  • gradle to build the jars including resources (webshell, fjage.js, etc.)
  • gradle lite to build only the jars
  • gradle test to run all regression tests (automated through Github actions CI)
  • gradle publish to upload jars to Maven staging (requires credentials)
  • make html to build developer's documentation (automated through ReadTheDocs)
  • gradle javadoc to build the Java API documentation
  • npm run docs to build the Javascript API documentation

License

fjåge is licensed under the Simplified (3-clause) BSD license. See LICENSE.txt for more details.