mirror of
https://github.com/EDCD/EDMarketConnector.git
synced 2025-04-17 17:42:20 +03:00
Document edmc_data.py
* PLUGINS.md - now we only need mention this for such data. * ChangeLog.md - pre-emptive section.
This commit is contained in:
parent
c17e6ecade
commit
33f0064dab
11
ChangeLog.md
11
ChangeLog.md
@ -1,6 +1,17 @@
|
||||
This is the master changelog for Elite Dangerous Market Connector. Entries are in reverse chronological order (latest first).
|
||||
---
|
||||
|
||||
Pre-Release 5.0.0-beta4
|
||||
===
|
||||
|
||||
Plugin Developers
|
||||
---
|
||||
|
||||
* All of our static data, such as mappings of names, should now be in
|
||||
edmc_data.py. So adjust any imports accordingly. Any future such will
|
||||
be placed in this file. We will endeavour not to make breaking changes to
|
||||
this file without a Major version bump.
|
||||
|
||||
Pre-Release 5.0.0-beta3
|
||||
===
|
||||
|
||||
|
12
PLUGINS.md
12
PLUGINS.md
@ -60,15 +60,11 @@ breaking with future code changes.**
|
||||
|
||||
`from prefs import prefsVersion` - to allow for versioned preferences.
|
||||
|
||||
`from companion import category_map` - Or any of the other static data
|
||||
contained therein. NB: There's a plan to move such to a `data` module.
|
||||
`import edmc_data` (or specific 'from' imports) - This contains various static
|
||||
data that used to be in other files. You should **not** now import anything
|
||||
from the original files unless specified as allowed in this section.
|
||||
|
||||
`from util_ships import ship_map` - A mapping of symbolic to English
|
||||
readable names for ships.
|
||||
|
||||
`import plug` - For using `plug.show_error()` and accessing the flags
|
||||
for `dashboard_entry()` to be useful (see example below). Relying on anything
|
||||
else isn't supported.
|
||||
`import plug` - For using `plug.show_error()` only.
|
||||
|
||||
`from monitor import game_running` - in case a plugin needs to know if we
|
||||
think the game is running. *NB: This is a function, and should be called as
|
||||
|
Loading…
x
Reference in New Issue
Block a user