<commit_before># MASSim Documentation

TODO:
* introduction
* Commands (scenario)

### Building MASSim
The complete package can be built by running ```mvn package``` in the main directory. All necessary dependencies are available online and maven should
automatically fetch them.

### Structure

[server.md](server.md) describes how the server can be configured and started.

[scenario.md](scenario.md) contains the description of the current scenario.

[monitor.md](monitor.md) explains the MASSim web monitor.

[protocol.md](protocol.md) describes the MASSim protocol, i.e. XML message formats for communicating with the MASSim server.

[eismassim.md](eismassim.md) explains EISMASSim, a Java library using the Environment Interface Standard (EIS) to communicate with the MASSim server, that can be used with platforms which support the EIS.

[javaagents.md](javaagents.md) gives a short introduction to the java agents framework, which holds skeletons that can already communicate with the MASSim server and have basic agent capabilities.

[rules.md](rules.md) lists all rules and requirements for participating in the MAPC.<commit_msg>finish main doc<commit_after># MASSim Documentation

This is the documentation for _MASSim_ (Multi-Agent Systems Simulation Platform), the simulation (server) software used in the [Multi-Agent Programming Contest](https://multiagentcontest.org/), where participants program agents to compete with each other in a predefined game.

_MASSim_ simulations run in discrete steps. Agents connect remotely to the contest server, receive percepts and send their actions, which are in turn executed by _MASSim_.

### Building MASSim
The complete package can be built by running ```mvn package``` in the main directory. All necessary dependencies are available online and maven should
automatically fetch them.

### Doc structure

[server.md](server.md) describes how the _MASSim_ server can be configured and started.

[scenario.md](scenario.md) contains the description of the current scenario.

[monitor.md](monitor.md) explains the _MASSim_ web monitor.

[protocol.md](protocol.md) describes the _MASSim_ protocol, i.e. XML message formats for communicating with the _MASSim_ server.

[eismassim.md](eismassim.md) explains _EISMASSim_, a Java library using the Environment Interface Standard (EIS) to communicate with the _MASSim_ server, that can be used with platforms which support the EIS.

[javaagents.md](javaagents.md) gives a short introduction to the java agents framework, which holds skeletons that can already communicate with the MASSim server and have basic agent capabilities.

[rules.md](rules.md) lists all rules and requirements for participating in the MAPC.
{'fraction_non_alphanumeric': 0.06531365313653137, 'fraction_numerical': 0.0, 'mean_word_length': 5.393867924528302, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6768160', 'n_tokens_mistral': 711, 'n_tokens_neox': 680, 'n_words': 338}