Skip to content
This repository has been archived by the owner on Nov 10, 2023. It is now read-only.

Commit

Permalink
Update documentation for MuJoCo
Browse files Browse the repository at this point in the history
Updated documentation for MuJoCo to reflect the fact that license keys
are no longer required as of MuJoCo 2.1.
  • Loading branch information
samuelfneumann committed Oct 18, 2021
1 parent 44aa495 commit ee38930
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
15 changes: 9 additions & 6 deletions environment/mujoco/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,14 @@ The `XML` files that describe [MuJoCo](http://www.mujoco.org/) environments are
- walker2d.xml

## How To Use
The `mujoco` packge uses `cgo` to interface with [MuJoCo](http://www.mujoco.org/). You must
first have all the required files for [MuJoCo](http://www.mujoco.org/) on your system and
a valid [MuJoCo](http://www.mujoco.org/) license key. The license key should
be named `mjkey.txt` and should be placed in `~/.mujoco`. This package
assumes you will be using [MuJoCo](http://www.mujoco.org/) 2.0.
The `mujoco` packge uses `cgo` to interface with [MuJoCo](http://www.mujoco.org/).

You must first have all the required files for [MuJoCo](http://www.mujoco.org/) on your system and
a valid [MuJoCo](http://www.mujoco.org/) license key (if using MuJoCo 2.0 ore before).
The license key should be named `mjkey.txt` and should be placed in `~/.mujoco`. This package
assumes you will be using [MuJoCo](http://www.mujoco.org/) 2.0 or later. It has not been tested
for any versions of [MuJoCo](http://www.mujoco.org/) prior to 2.0, but may still work with
earlier versions.

This pacakge needs to know where the [MuJoCo](http://www.mujoco.org/) shared library
is and where the [MuJoCo](http://www.mujoco.org/) header files are. There are two ways
Expand Down Expand Up @@ -59,4 +62,4 @@ directives have been left in the files in this package. These should be removed
or altered to suit your system before you run code from this package. In
particular, the `-I` option for `CFLAGS` and the `-L` option for `LDFLAGS`
should be removed or altered, depending on if you used option 1 or 2 above to
set up the package.
set up the package.
3 changes: 2 additions & 1 deletion environment/mujoco/internal/mujocoenv/MujocoEnv.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,8 @@ const (
)

// init performs setup before the package can be run by initialziing
// and activating MuJoCo
// and activating MuJoCo. Activation of MuJoCo is kept here for
// backwards compatability.
func init() {
// Activate MuJoCo
home, err := os.UserHomeDir()
Expand Down

0 comments on commit ee38930

Please sign in to comment.