Add information about MAgent2 standalone package (#857)

Farama-Foundation · Nov 14, 2022 · 16e587a · 16e587a
1 parent 09de084
commit 16e587a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,6 +10,7 @@ repos:
       - id: codespell
         args:
           - --skip=*.css,*.js,*.map,*.scss,*svg
+          - --ignore-words-list=magent
   - repo: https://gitlab.com/PyCQA/flake8
     rev: 5.0.4
     hooks:

diff --git a/pettingzoo/magent/README.md b/pettingzoo/magent/README.md
@@ -0,0 +1 @@
+MAgent has been moved into its own package: MAgent2. Install with `pip install magent2`. For more information on the MAgent2 package, see https://magent2.farama.org/.
diff --git a/pettingzoo/magent/__init__.py b/pettingzoo/magent/__init__.py
@@ -0,0 +1,3 @@
+raise ImportError(
+    "MAgent has been moved into its own package: MAgent2. Install with `pip install magent2`. For more information on the MAgent2 package, see https://magent2.farama.org/."
+)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		MAgent has been moved into its own package: MAgent2. Install with `pip install magent2`. For more information on the MAgent2 package, see https://magent2.farama.org/.