ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

Fix game_runnning() doc in PLUGINS.md

Browse Source
This commit is contained in:
Chris 2021-08-24 14:52:10 -04:00 committed by GitHub
parent e7f8fea250
commit 705d2dd4f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
PLUGINS.md
View File

@ -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