v0.9.0

Installing NLE

Install with pip: pip install nle==0.9.0.

Or pull the docker image: docker pull fairnle/nle:0.9.0.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.9.0

This version introduces the (NetHack Learning Dataset)[https://arxiv.org/abs/2211.00539v2], shipping code and tests needed to make this run.

• Release version 0.9.0 (#349, @condnsdmatters)
• Update to latest deboost commit (fixes ARM install) (#347, @tkukurin)
• Prevent use of macro warn_unused_result for M1 Macs, fixing Issue… (#344, @condnsdmatters)
• Update actions. (#345, @condnsdmatters)
• Change the name of the altorg test files for Windows, to fix issue #341 (#343, @condnsdmatters)
• Add NLD to the README.md and create instructions and tutorial for NLD. (#342, @condnsdmatters)
• Info about the NLE language wrapper in the README.md (#339, @samvelyan)
• Test and fix for issue 333. (#334, @heiner)
• Eric/flake patch (#335, @condnsdmatters)
• Set the terminal emulator to by default not wrap extra long lines, (#330, @condnsdmatters)
• Rename "actions" to "keypresses" for dataset, which is more accurate. (#329, @condnsdmatters)
• Add an exists method (#328, @condnsdmatters)
• Make an easier import structure for nethack dataset. (#325, @condnsdmatters)
• Adjust logging for populate db. (#324, @condnsdmatters)
• Pin gym to 0.23.0 temporarily. (#326, @condnsdmatters)
• Remove empty games and integer overflow. (#323, @condnsdmatters)
• Ensure that subselect sql query still only selects from the specified (#322, @condnsdmatters)
• Populate database using the files in xlogfile (#321, @condnsdmatters)
• Fixup libtmt to ensure that unrecognised terminal commands are ignored, (#320, @condnsdmatters)
• Eric/dataset (#318, @condnsdmatters)
• Add the filepath of the ttyrec if it exists to the xlogfile. (#319, @condnsdmatters)
• Eric/add converter (#315, @condnsdmatters)
• Add an xlogfile to the generation of the ttyrecs. (#316, @condnsdmatters)
• Fail if libnethack is resident before dlopening. (#311, @heiner)
• Updates to cmake (#310, @heiner)
• Black 22.1.0 changed its mind about power operators, breaking our test. (#309, @heiner)
• Fix play.py following underscore access change. (#308, @heiner)
• Pick random race/gender/alignment when selecting random role. (#307, @heiner)
• More cleanup. Remove dashboard. (#306, @heiner)
• Don't allow set_buffers to be called after reset. (#305, @heiner)
• Add option to save ttyrec files every "M" episodes (#260) (#304, @heiner)
• Fix _underscore access, rename Nethack variable as nethack. (#303, @heiner)
• Cleanup and add vectorization (#301, @heiner)
• Use pager in read_tty.py by default, like git-diff. (#300, @heiner)
• Fix #297 (#299, @heiner)
• Add CITATION.cff file. (#295, @heiner)

💣 Breaking Change

• Add alignment to blstats. (#302, @heiner)

v0.8.1

Installing NLE

Install with pip: pip install nle==0.8.1.

Or pull the docker image: docker pull fairnle/nle:0.8.1.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.8.1

• Fix clang warning. (#294, @heiner)
• Add nle_settings to nledl interface, don't use environment variables (#291, @heiner)
• Add glyph2tile array. (#288, @heiner)
• Add def_oc_syms to pynethack.cc (#292, @heiner)

💣 Breaking Change

• Add missing see* actions (e.g., '$') and test. (#177, @heiner)

v0.8.0

Installing NLE

Install with pip: pip install nle==0.8.0.

Or pull the docker image: docker pull fairnle/nle:0.8.0.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.8.0

• Update tty tools (#283, @heiner)
• Fix NetHackScout environment following #179. (#277, @heiner)
• Alternative fix for gym 0.21 changes. (#271, @heiner)
• Follow https://apt.kitware.com in Dockerfiles (#266, @heiner)
• ttyplay: Don't read from stdin by default. Print help when called w/o… (#262, @heiner)
• Update plotting script to include xkey and ykey (#259, @dmadeka)
• Two misc changes: Fix error message and fix copyright (with check) (#252, @heiner)
• Run finalizer correctly even when _pynethack.Nethack creation fails. (#250, @heiner)
• Expose Inventory Size (#251, @dmadeka)
• Test and fix for "NLE with wrong HACKDIR after spawn" (#249, @heiner)
• Drop GIL on reset. (#242, @heiner)
• Disable dumplog files. (#240, @heiner)
• Close Nethack instance via finalizer. (#241, @heiner)
• Update "difficulty" comment to align with permonst.h. (#237, @heiner)
• Expose Monster Difficulty attribute of permonst struct through FFI (#236, @dmadeka)
• Add symdef Python class. (#231, @heiner)
• Use memfd_create + /proc/self/fd/{FD} for temporary DL on Linux. (#228, @heiner)
• Add wizard mode option to play.py, refactor rendering logic. (#226, @heiner)
• Fix black color handling (#225, @heiner)

💣 Breaking Change

• Remove space_dict argument to NLE. (#261, @heiner)

v0.7.3

Installing NLE

Install with pip: pip install nle==0.7.3.

Or pull the docker image: docker pull fairnle/nle:0.7.3.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.7.3

• Add condition mask to blstats observation. (#219, @heiner)
• Don't chdir in NLE (#210, @heiner)
• Make NLE only run bzip2 when necessary (#197, @heiner)
• Fix blstats, again, again (#196, @heiner)
• Flag for disabling random monster spawning (#191, @samvelyan)
• Fix blstats, again (#192, @heiner)
• Update blstats only at end of bot() round. (#186, @heiner)

v0.7.2

Installing NLE

Install with pip: pip install nle==0.7.2.

Or pull the docker image: docker pull fairnle/nle:0.7.2.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.7.2

• Release 0.7.2 (#181, @condnsdmatters)
• Adding noop deflakes test. (#182, @condnsdmatters)
• Default savedir to None (and remove unused archivefile) (#174, @tscmoo)
• Use cmap_to_glyph(S_stone) as "unset" glyph, not 0 (which is also PM_GIANT_ANT). (#179, @heiner)
• Create 'misc' observation with input mode indicators (#180, @condnsdmatters)
• Observations in 'glyphs', 'inv_glyphs' now fixed to correspond to description of an object class instead of the name of object class. (#176, @condnsdmatters)
• Add the Yankee Dollar. (#178, @heiner)
• Some fixes to NLE and the competition task (#173, @heiner)
• Fix NetHackChallenge no_progress_timeout (#172, @tscmoo)

v0.7.1

Installing NLE

Install with pip: pip install nle==0.7.1.

Or pull the docker image: docker pull fairnle/nle:0.7.1.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.7.1

• Remove seeds from internal observation, add warning. (#170, @heiner)
• Change _reward_fn to take action taken (#166, @RobertKirk)
• Bump glob-parent from 5.1.0 to 5.1.2 in /nle/dashboard (#169, @dependabot)
• Add copyright header and fix variable name and imports. (#168, @heiner)

v0.7.0

Installing NLE

Install with pip: pip install nle==0.7.0.

Or pull the docker image: docker pull fairnle/nle:0.7.0.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.7.0

• Bump version. (#167, @heiner)
• Asciinema does not support saving and loading of cursors, and this ru… (#165, @condnsdmatters)
• Eric/competition (#156, @condnsdmatters)
• Fix a bad buffer overflow in inv_strs. (#162, @heiner)

v0.6.1

Installing NLE

Install with pip: pip install nle==0.6.1.

Or pull the docker image: docker pull fairnle/nle:0.6.1.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.6.1

• Heiner/addhow (#160, @heiner)
• Turn "get_tty_rendering" into a somewhat saner function. (#161, @heiner)
• Remove has_color in an attempt to fix #157. (#159, @heiner)
• Change cmake install command. (#158, @heiner)
• Bump lodash from 4.17.19 to 4.17.21 in /nle/dashboard (#154, @dependabot)
• Cherry-pick upstream fix e7e07cb0. (#150, @heiner)
• Added render_mode argument in play.py script (#149, @samvelyan)
• Tty rendering for NLE environment (#147, @rockt)
• pre-commit for python3.8 (#145, @samvelyan)
• Fix bug in winrl getch which makes messages disappear forever (#143, @tscmoo)
• Rerange tty_colors to [0, 32) (#142, @tscmoo)
• Make space_dict global to reuse outside nle. (#139, @yobibyte)
• Remove ncurses from readme. (#138, @condnsdmatters)

🐛 Bug Fixes

• Set libtmt submodule url to use https (#141, @edran)

v0.6.0

Installing NLE

Install with pip: pip install nle==0.6.0.

Or pull the docker image: docker pull fairnle/nle:0.6.0.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.6.0 🚀

• Drop all ncurses dependencies, following memory leaks.
• Add a set of new observation keys ("tty_chars", "tty_colors", "tty_cursor"), to output a rendered terminal.
• Add a new observation key ("screen_descriptions"), with NetHacks's text descriptions of each square.
• Assorted bug fixes and improvements!

Full Changelog

• Release candidate branch for version 0.6.0. (#137, @condnsdmatters)
• Fix the name of the environment in README (#136, @shagunsodhani)
• Hotfix link (#135, @condnsdmatters)
• Add terminal output as an observation. (#119, @condnsdmatters)
• Added architecture document and links in README.md. (#127, @condnsdmatters)
• Fixup the test PyPI install workflow. (#129, @condnsdmatters)
• Fix checkup tool complains. (#134, @heiner)
• Improve performance (#131, @condnsdmatters)
• Add benchmarks sps profile test. (#130, @condnsdmatters)
• Add Dockerfile for Ubuntu 20.04 (focal fossa). Also fixup docker file to (#126, @condnsdmatters)
• Drop ncurses (#125, @heiner)
• Bump ncurses from 5 to 6. (#124, @condnsdmatters)
• Fix ncurses-related memory leak; various updates to help debugging (#121, @heiner)
• Use same running Python version in CMake. (#116, @heiner)
• Add uhunger to internal; fix eat task. (#122, @heiner)
• Fix extra newline at end of NLE run; fix fwrite when bz2 is disabled. (#118, @heiner)
• Fix a bad memory leak. (#115, @heiner)
• Use fewer magic constants. (#110, @heiner)
• Don't call setbuf on stdout in NLE (#113, @heiner)
• Remove temporary directory (#109, @heiner)
• Make NETHACKOPTIONS a tuple to protect from modification. (#108, @yobibyte)
• Add TELEPORT to non-RL actions. (#101, @yobibyte)
• Add text descriptions as an observation for each object on the map. (#103, @condnsdmatters)
• Terminal ttyrec stuff (#99, @heiner)
• Add inv letter to rendering. (#100, @yobibyte)
• Add neurips logo (#98, @heiner)
• Fix terminal size at 80x24, write bzip2'ed ttyrecs (#97, @heiner)
• Fix writing a wizkit file. (#96, @yobibyte)
• New ttyplay features (#94, @heiner)
• Add PRAY to autoskip exceptions. (#88, @yobibyte)
• Env updates (#89, @heiner)
• Env updates (#87, @heiner)

v0.5.2

Installing NLE

Install with pip: pip install nle==0.5.2.

Or pull the docker image: docker pull fairnle/nle:0.5.2.

See README.md and/or docker/README.md for further instructions.

New in NLE v0.5.2

• Update README, docs, GitHub workflows, Dockerfiles. (#85, @heiner)
• Fix off-by-one error in gold task. (#84, @heiner)
• Add RUSH action. (#83, @yobibyte)
• Install the nethack util binaries and their documentation. (#80, @heiner)
• Add objclass and objdescr as Python classes. (#81, @heiner)
• Clarify origin of ttyplay.js and that we modified it. (#82, @heiner)
• Fix inventory test to not fail when the agent autopicks up some gold. (#79, @heiner)
• Wizkit support (#78, @yobibyte)
• Forward wizard mode through nle, add tests. (#64, @yobibyte)