Note: For general information about the repository please refer to the top level README.md
The purpose of this directory is to create a socket server which can send the GameState to the java iv4XR agent.
This repository contains an adapted version of NLE package. NLE puts NetHack into a gym environment. The entire sourcecode of NetHack and it's LICENSE are included in NLE.
The entrypoint main.py starts up a socket server on 127.0.0.1:5001. On connection, it creates a NetHack game instance and will send the GameState and observations through the socket connection in JSON format as it receives commands from the client to execute. The JSON messages also allows to render the NetHack in the server terminal.
NLE adaptations:
- Change output directory
- Compile NetHack with coverage flags
This Python project can only run on Linux/macOS. It has been compiled and ran on Ubuntu-22.04 on desktop and on WSL.
Important: All scripts are ran with bash since we need to use commands not available in sh.
bash <path-to>/install.sh
NetHack has options that can be set. Those options can be found in here using the NETHACKOPTIONS
Changing them can remove bots' understanding of the game, so be careful!
Resets the coverage for the run and starts up the server.
bash <path-to>/start.sh
Tip: If you have installed it on WSL this script will start server on load. You might have to change the distribution name if another distribution was used.
Run coverage via gcovr:
bash <path-to>/coverage.sh
A first plot on coverage can be created using the plotter.py script.
python3 src/plotter.py