diff --git a/PLUGINS.md b/PLUGINS.md index 5a7388b7..dcb36441 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -83,9 +83,16 @@ from the original files unless specified as allowed in this section. `import plug` - For using `plug.show_error()` only. -`from monitor import game_running` - in case a plugin needs to know if we + Use `monitor.game_running()` as follows in case a plugin needs to know if we think the game is running. *NB: This is a function, and should be called as such. Using the bare word `game_running` will always be `True`.* + +``` +from monitor import monitor +... +if monitor.game_running(): + ... +``` `import timeout_session` - provides a method called `new_session` that creates a requests.session with a default timeout on all requests. Recommended to