Merge pull request #98 from jkterry1/master

More explicit warning

README.md

@@ -1,6 +1,8 @@
 **Status:** Archive (code is provided as-is, no updates expected)
 
-A maintained version of these environments, with numerous fixes, is included with PettingZoo (https://github.com/Farama-Foundation/PettingZoo , https://www.pettingzoo.ml/mpe)
+# Maintained Fork
+
+The maintained version of these environments, which includenumerous fixes, comprehensive documentation, support for installation via pip, and support for current versions of Python are available in PettingZoo (https://github.com/Farama-Foundation/PettingZoo , https://pettingzoo.farama.org/environments/mpe/)
 
 # Multi-Agent Particle Environment
 
@@ -14,7 +16,7 @@ Used in the paper [Multi-Agent Actor-Critic for Mixed Cooperative-Competitive En
 - To interactively view moving to landmark scenario (see others in ./scenarios/):
 `bin/interactive.py --scenario simple.py`
 
-- Known dependencies: Python (3.5.4), OpenAI gym (0.10.5), numpy (1.14.5)
+- Known dependencies: Python (3.5.4), OpenAI gym (0.10.5), numpy (1.14.5), pyglet (1.5.27)
 
 - To use the environments, look at the code for importing them in `make_env.py`.
 

multiagent/__init__.py

@@ -1,3 +1,6 @@
+import os
+import warnings
+
 from gym.envs.registration import register
 
 # Multiagent envs
@@ -16,3 +19,14 @@
     entry_point='multiagent.envs:SimpleSpeakerListenerEnv',
     max_episode_steps=100,
 )
+
+warnings.warn("This code base is no longer maintained, and is not expected to be maintained again in the future. \n"
+              "For the past handful of years, these environments been maintained inside of PettingZoo (see "
+              "https://pettingzoo.farama.org/environments/mpe/). \nThis maintained version includes documentation, "
+              "support for the PettingZoo API, support for current versions of Python, numerous bug fixes, \n"
+              "support for installation via pip, and numerous other large quality of life improvements. \nWe "
+              "encourage researchers to switch to this maintained version for all purposes other than comparing "
+              "to results run on this version of the environments. \n")
+
+if os.getenv('SUPPRESS_MA_PROMPT') != '1':
+    input("Please read the raised warning, then press Enter to continue... (to suppress this prompt, please set the environment variable `SUPPRESS_MA_PROMPT=1`)\n")