Skip to content

sarl/sarl

SARL Agent Programming Language

SARL logo

SARL is a general-purpose agent-oriented language, www.sarl.io.

SARL aims at providing the fundamental abstractions for dealing with concurrency, distribution, interaction, decentralization, reactivity, autonomy and dynamic reconfiguration. These high-level features are now considered as the major requirements for an easy and practical implementation of modern complex software applications. We are convinced that the agent-oriented paradigm holds the keys to effectively meet this challenge.

Considering the variety of existing approaches and meta-models in the field of agent-oriented engineering and more generally multi-agent systems, our approach remains as generic as possible and highly extensible to easily integrate new concepts and features. The language is platform- and architecture-independent.

However, we provide a first set of tools to support its execution based on the recent version 3.0 of the Janus (see www.janusproject.io) platform, but it can be linked with other existing agent platforms and frameworks.

compilation process

documentation API ff69b4 documentation reference red Lobby

requires Java%2017 yellowgreen interoperable%20with Java yellowgreen sdk build%20with Maven blue

based%20on Xtext orange

sarl sarl?style=flat square

1. Requirements

  • Java Development Toolkit (JDK) 17 or higher.

2. Using SARL

2.1. Recommendations

For making your experience with SARL the best, we recommend you:

  • to enable the assertions at development time (with the -ea command line option).

2.2. Use the stable version with Maven

The lastest stable version of SARL is available on Maven Central. Consequently, you could directly include the SARL module into the Maven dependencies of your project:

	...
	<dependency>
	  <groupId>io.sarl.sdk</groupId>
	  <artifactId>sdk</artifactId>
	  <version>0.13.0</version>
	</dependency>
	...

Please, replace Version 0.13.0 in the previous snipset by the number of the version you want to use.

2.3. Use of the development version with Maven

New features, enhancements and bug fixes are available in the SNAPSHOT (development) version of SARL. For using this version, you must add the Maven Repository Server of SARL in your pom file:

	...
	<dependencies>
	  <dependency>
	    <groupId>io.sarl.sdk</groupId>
	    <artifactId>sdk</artifactId>
	    <version>0.14.0-SNAPSHOT</version>
	  </dependency>
	<dependencies>
	...
	<repositories>
	  <repository>
	    <id>io.sarl-maven</id>
	    <name>SARL Snapshots</name>
	    <url>http://maven.sarl.io/</url>
	  </repository>
	</repositories>
	<pluginRepositories>
    	  <pluginRepository>
	    <id>io.sarl-maven</id>
	    <name>SARL Snapshots</name>
	    <url>http://maven.sarl.io/</url>
	    <snapshots>
	      <enabled>true</enabled>
	    </snapshots>
	  </pluginRepository>
	</pluginRepositories>
	...

2.4. Compile SARL code with Maven

For compiling SARL source files with Maven, you should use the provided plugin: sarl-maven-plugin. It invokes the SARL and Java compilers with a simpler interface than the standard Xtext maven plugin. For using the sarl-maven-plugin, you should add in your pom file:

	...
	<build>
	  <plugins>
	    <plugin>
	      <groupId>io.sarl.lang</groupId>
	      <artifactId>sarl-maven-plugin</artifactId>
	      <version>0.13.0</version>
	      <extensions>true</extensions>
	      <configuration>
	        <source>17</source>
	        <target>17</target>
	        <encoding>UTF-8</encoding>
	      </configuration>
	    </plugin>
	    ...
	  </plugins>
	  ...
	</build>
	...

Please, replace Version 0.13.0 in the previous snipset by the number of the version you want to use.

Caution
Do not forget to set the extensions flag to true.

2.5. Syntax highlighting with other tools

Several style specifications are provided for syntax highlighting in third party tools. Style specifications are provided for:

3. Separated Sub-Projects

The SARL project is splitted into different sub-projects that may be compiled independently. Each project is dedicated to a specific set of features and tools. These sub-projects are:

  • sarl-bom: Provide the Build-of-Material, i.e., a shared list of Maven dependency, for all the SARL sub-projects;

  • sarl-baseutils: Set of Maven artifacts that are independent of SARL but needed to build the SARL artifacts;

  • sarl-lang: Provides the language definition, the associated compiler (including the Maven plugin) and code formatting styles for different text editors;

  • sarl-sdk: Set of Maven artifacts that constitute the SDK for all the SARL developers;

  • sarl-apputils: Shared projects for building applications that are using a SARL compiler;

  • sarl-sre: SARL runtime environment (or SARL virtual machine);

  • sarl-docs: Tools and Doclet for the generation of the documentation, including the API documentation pages;

  • sarl-cli: Set of command-line tools (sarlc, sarldoc, janus…​);

  • sarl-eclipse: Eclipse-based editor for SARL;

  • sarl-officialdoc: Markdown files of the official documentation of SARL.

4. Issues

Issues related to SARL are tracked on GitHub You must use this issue tracker to report and follow your issues.

Additionally, you could have a look on the SARL developers' working plan on Huboard.

5. Contributions

Any contribution to the SARL is welcome. Please read the guidelines for contributors.

6. Authors and Contributors

  • klmp200 Antoine BARTUCCIO, fireworks and Sierpinski fractal examples.

  • Lomadriel Gérôme BOULMIER, game of life example.

  • gb96 Greg BOWERING, fixes for localization support within the fireworks example.

  • m ezzat Mohamed EZZAT, code cleaning and optimization.

  • ThomasFarrenkopf Thomas FARRENKOPF, documentation contributor.

  • jgfoster James FOSTER, documentation contributor.

  • gallandarakhneorg Stéphane GALLAND, founder, original and active author.

  • ngaud Nicolas GAUD, founder, original and active author.

  • jjst Jeremie JOST, documentation contributor.

  • alexandrelombard Alexandre LOMBARD, active author.

  • RyuzakiKK Ludovico de NITTIS, documentation contributor.

  • pinam45 Maxime PINARD, game of life example.

  • tpiotrow Thomas PIOTROWSKI, maven configuration.

  • srodriguez Sebastian RODRIGUEZ, founder, original and active author.

  • ssardina Sebastian SARDINA, documentation contributor.

7. License of SARL

SARL is distributed under the Apache v2 license, and is copyrigthed to the original authors and the other authors, as expressed in the NOTICE.

8. Success Stories

SARL was successfully used by multiple projects. They are listed on the official SARL website.