A_D
1be723e249
Added additional doccumentation
2021-01-05 14:34:51 +00:00
Athanasius
c1dcd30280
PLUGINS.md: Be explicit about why plugin_prefs(...) -> Optional[tk.Frame]
2020-12-21 14:44:39 +00:00
Athanasius
a65d77a67e
PLUGINS.md: Make the disctinction between "ShutDown" and "Shutdown" clear
2020-12-18 12:32:45 +00:00
Athanasius
a181379669
PLUGINS.md: Point to current Python version information in Releasing.md
2020-12-12 14:02:11 +00:00
Joshua Tyler-Jones
1c16b5fae6
Fix dead link in PLUGINS.md
2020-12-08 15:08:27 +00:00
A_D
97d8631e11
Removed todo
2020-09-22 15:22:27 +02:00
A_D
9c3f273027
Added type hints and param descriptions
2020-09-22 15:20:46 +02:00
A_D
5ae269d7f6
Added type annotations to examples
2020-09-22 15:20:46 +02:00
A_D
161ca24bb6
updated plugin docs
2020-09-22 15:20:45 +02:00
A_D
4ecb378b83
cleaned up plugins.md
2020-09-22 15:20:44 +02:00
Athanasius
a19fd3cbf6
PLUGINS.md: Emphasise the correct way to get a logger.
...
A_D had accidentally used 'ClickCounter' for this when their folder name
was 'click_counter'. This lead to using a very bare `logger` which
still used our defined format leading to things blowing up when there
was no adapter to handle `qualname` format string.
2020-09-18 13:07:44 +01:00
Athanasius
4d3f9264f2
PLUGINS.md: Correct example to 'tkinter' not 'Tkinter'.
2020-09-10 18:31:09 +01:00
Athanasius
cd0d0f9e08
PLUGINS.md: Update for logging now being available
2020-09-07 17:38:15 +01:00
A_D
81dfbdfb8e
Added timeout_session, made inara use it
...
timeout_session provides two things, TimeoutAdapter, a HTTP adapter
subclass that automatically adds timeouts to all requests, and
new_session, which automatically creates a request.Session with the
adapter in the correct place.
2020-07-31 15:53:20 +02:00
Athanasius
0115e5c6ba
PLUGINS.md: except not catch
2020-07-30 14:33:00 +01:00
Athanasius
0e6d4468da
PLUGINS.md: Fix typo ' -> `
2020-07-30 14:17:14 +01:00
Athanasius
974872fe9e
PLUGINS.md: Logging is being added, how to prepare
...
* Currently you use `print(...)`
* `logging` support is coming, here's how to prepare.
2020-07-30 14:05:09 +01:00
Athanasius
ddadaf36f2
Update PLUGINS.md
...
Adds missing blank line that caused acciental underline/heading
2020-07-24 13:45:17 +01:00
Athanasius
8d0cd8c9dc
PLUGINS.md: Change header to 'Developer Plugin Documentation'
2020-07-13 11:59:10 +01:00
Athanasius
dec2f3d041
theme not them
2020-07-12 23:15:47 +01:00
Athanasius
04090842d7
Add a few more allowed plugin imports in docs
...
* L10n
* theme.theme
* plug allows for flags.
* monitor.gamerunning()
2020-07-12 19:54:23 +01:00
Athanasius
71bb14a737
Document allowed imports for PLUGINS
...
* List added in 'Available imports' section of PLUGINS.md
* Various *.py files now have comments about things being allowed for
plugin import.
2020-07-12 19:25:47 +01:00
Athanasius
2bd6e4cb1c
PLUGINS.md: Flesh out plugin API docs
...
* Note in monitor.py to update the docs if anything changed about the
'state' dictionary.
* Expand on arguments to all plugin call-ins.
* Particularly what the 'state' diction passed to journal_entry()
contains.
* The contents of the `data` dictionary passed to `cmdr_data()`.
2020-07-12 18:10:16 +01:00
Athanasius
37c00d31ee
General text re-flow to make subsequent changes more obvious.
...
Also fixed formatting of some of the embedded code.
2020-07-12 16:25:20 +01:00
Athanasius
273e121736
PLUGINS.md: Installation instructions on wiki
2020-07-06 18:22:02 +01:00
Athanasius
3b5a510653
Plugins.md: Minor edits
...
* One more plugin_start() -> plugin_start3()
* Startup and Shutdown events linkified in sections.
* Note the use of the return from plugin_start3()
* Point out the cmdr_data() `data` dictionary is from CAPI `/profile`
2020-07-01 18:29:56 +01:00
Athanasius
d8e8869b15
Plugins.md: Minor edit about Settings
2020-07-01 18:11:20 +01:00
Athanasius
df09ddf4ed
First full Python 3.7 release will be 4.0.0.0
...
Issue #526
2020-06-29 15:03:49 +01:00
Athanasius
6f9d6a3a05
Ensure PLUGINS.md is all Python 3.x
...
* One reference to plugin_start() updated
* Settings > Plugins > "Plugins Without Python 3.x Support" mentioned.
* Minor formatting changes.
2020-06-29 15:01:37 +01:00
Jonathan Harris
685fbeccf5
Doc fixes
2020-06-21 16:33:37 +01:00
Jonathan Harris
c62d110448
Plugin migration
2020-06-21 16:33:13 +01:00
Athanasius
a8631e5bb8
Gives up and uses full URL for python3 branch
2020-06-20 12:20:32 +01:00
Athanasius
8262a2afba
Attempts to fix the 'python3' branch URL in migration guide
2020-06-20 12:18:58 +01:00
Athanasius
7ed7f904a8
Adds an edited version of python3/PLUGINS.md#Migration for master branch
...
We need this in master so that the forthcoming Python 2.7 version that
detects plugins that aren't ready for migration can provide a link to
information about migrating. In the future the 'python3' branch might
have been removed.
2020-06-19 19:28:01 +01:00
Athanasius
53bbeca12b
Merge branch 'releases'
...
Release 3.44 just made as pre-release, soon to be live.
2020-06-17 18:15:33 +01:00
Athanasius
f52d4a5e75
Updates various github URLs to EDCD, not Marginal, ones.
2020-06-17 16:41:25 +01:00
Jonathan Harris
ba9954dd7b
Document multithreading in more detail
2019-10-07 14:12:58 +01:00
Jonathan Harris
b81c4cf6c5
More control over widget colors
...
Documented mechanism to apply theme to dynamically created widgets.
Allow widgets to override theme colors. Fixes #444
2019-09-24 00:08:46 +01:00
Jonathan Harris
d8b5884b05
Notify plugins of Inara ship, system and station IDs
...
Fixes #425
2019-07-06 15:28:48 +01:00
Jonathan Harris
b8a7d143d4
Pass plugin's folder to plugin_start()
2018-08-09 00:47:28 +01:00
Jonathan Harris
092dda84f5
More docs for dashboard_entry()
2018-06-15 09:43:02 -05:00
Jonathan Harris
9265646a38
Correct dashboard example
2018-06-15 09:11:23 -05:00
Jonathan Harris
a442d2cd14
Extend localisation support to plugins
2018-05-12 20:50:45 +01:00
Jonathan Harris
fa3cf23c09
Load any plugins that are also packages first
...
Addresses #313
2018-04-26 18:53:29 +01:00
Jonathan Harris
f42d5d7af6
plugin_app() can return None
...
so it can be used as a callback after the main window and all other plugins are initialised.
2018-04-02 13:03:39 +01:00
Jonathan Harris
0b0ac162e1
Add dashboard constants
2018-02-27 19:47:54 +00:00
Jonathan Harris
9c8c9e8e83
Correct dashboard_entry() docs
2018-02-27 02:01:45 +00:00
Jonathan Harris
75edff5fc3
Rename plugin callback to dashboard_entry
2018-01-30 00:11:49 +00:00
Jonathan Harris
a081b6b637
Monitor player status, and call new "status" plugin callback
2018-01-29 01:36:14 +00:00
Jonathan Harris
95f96c1c03
Send "ShutDown" event to plugins on quitting to Main Menu
2017-12-03 17:14:18 +00:00