Commit Graph
198 Commits
Author SHA1 Message Date
Athanasius f977ad6716 PLUGINS.md: General PyCharm alerts pass
A few bits of example code tweaked to be more correct, but to make
PyCharm truly happy about the file we'd need to expand the examples to
stupid proportions (extra imports, indent changes etc).
2021-08-13 13:50:46 +01:00
Athanasius 6c34ceaba9 PLUGINS.md: s/EDMC/EDMarketConnector/ almost everywhere & reflow
The reflow is on *all* non-code/table text to be within 80 columns,
excepting if a link just makes that impossible.
2021-08-13 13:32:36 +01:00
Athanasius 411bd0edf2 journal/CQC: Minor documentation tweaks for language/grammar 2021-08-13 13:19:46 +01:00
norohind c65ef0a4d6 PLUGINS.md: deduplicate content table for state in journal_entry_cqc 2021-08-13 14:41:35 +03:00
norohind 29df3869cd PLUGINS.md: update first EDMC version with journal_entry_cqc 2021-08-13 14:15:46 +03:00
norohind 28f7a2b2fe PLUGINS.md: add ref link for systems to CQC maps mapping 2021-08-13 14:07:50 +03:00
norohind 30048ded88 PLUGINS.md: initial update for journal_entry_cqc 2021-08-11 17:47:06 +03:00
A_D 2e5e55af9a Applied requested changes 2021-06-20 17:44:29 +02:00
A_D f609545fdc Updated plugin docs 2021-06-18 23:36:45 +02:00
A_D fe0e752c9b Added support for arbitrary plugins for POST debug
This works by replacing --eddn-local with --debug-sender, and making the
webserver more generic. support has been added to EDSM, EDDN, and INARA.
2021-06-18 23:36:42 +02:00
Athanasius 937aaccec4 ShipLockerJSON: Ensure initialised, and document it. 2021-06-10 14:20:27 +01:00
Athanasius 13119b9509 Release 5.1.0: *not* 5.0.5. We want the Minor bump. 2021-06-04 14:02:59 +01:00
Athanasius 7a7bd7036b PLUGINS: Added 'New in 5.0.5' section 2021-06-04 13:41:03 +01:00
A_D 0ecd33c013 Documented new monitor.state values 2021-06-04 13:47:29 +02:00
Athanasius b11486c64c PLUGINS.md: Document new language/gameversion/gamebuild state fields. 2021-05-27 13:57:28 +01:00
Athanasius f46618b61c Suits: Added German localisations/short forms for names. 2021-05-26 14:49:17 +01:00
Athanasius bac718aeff Store Fileheader language, gameversion and build in monitor.state 2021-05-25 17:56:11 +01:00
Athanasius 143a205fb9 Backpack: event name is CamelCase, stored in monitor.state, doc
* Surprise!  The new event is `BackPack`, not `Backpack`, although the
  filename *is* `Backpack.json`.
* Store the loaded JSON dict in `monitor.state['BackpackJSON']`.  That
  `p` is lower case to match with the filename, not the event name.
* Document this in PLUGINS.md.

Unless EDSM is telling us to discard this we should now be sending it.
2021-05-20 18:13:51 +01:00
Athanasius 9c4058da60 PLUGINS.md: Actually have something in Avoiding pitfalls about dir name 2021-05-18 23:21:05 +01:00
Athanasius 6448d03ab3 PLUGINS.md: Document packaging extra modules 2021-05-18 23:18:30 +01:00
Athanasius d850fa050e PLUGINS.md: Document Horizons and Odyssey state booleans 2021-05-17 14:53:36 +01:00
Athanasius f8e562eed2 PLUGINS.md: Do NOT tempt devs into using monitor.state directly. 2021-05-17 13:03:10 +01:00
Athanasius b444647c4a PLUGINS: Explicitly outline how to be informed of all releases. 2021-05-12 22:47:36 +01:00
Athanasius b3495df1b6 PLUGINS: Tweak config.appversion section 2021-05-12 09:53:44 +01:00
Athanasius 41adf596ce PLUGINS/config: Better forwards-compatibility example 2021-05-11 22:46:39 +01:00
Athanasius 682c48e5ac PLUGINS: Document better config forwards compatibility code 2021-05-11 21:48:03 +01:00
Athanasius 1b7f5e2b06 PLUGINS.md: Document config methods workaround for <5.0.0 2021-05-11 08:32:07 +01:00
Athanasius 63a0456a9f PLUGINS.md: Fix Flags to reference edmc_data, not plug. 2021-05-09 10:32:58 +01:00
Athanasius d475d3194f PLUGINS.md: Document extra python modules we package for plugins use. 2021-05-06 11:09:49 +01:00
Athanasius bd1b86d3a3 Suits/Loadouts: Always convert to dict form for simpler downstream code. 2021-04-29 11:30:55 +01:00
Athanasius eb04673751 PLUGINS.md: Document dual-type of Suits, and helper functions. 2021-04-19 12:30:24 +01:00
Athanasius 29473de031 PLUGINS.md: Update for all added Odyssey monitor.state fields 2021-04-13 12:26:33 +01:00
Athanasius 9a6b59fbd3 monitor.py: Initialise EDLogs self.systempopulation
This is the *one* field that wasn't always initialised.
2021-04-12 09:10:25 +01:00
Athanasius 33f0064dab Document edmc_data.py
* PLUGINS.md - now we only need mention this for such data.
* ChangeLog.md - pre-emptive section.
2021-04-12 08:31:47 +01:00
Athanasius 74a2b70a19 PLUGINS.md: Add ship_utils.ship_map to allowed imports 2021-04-12 08:30:51 +01:00
Athanasius 8f2802fbcf monitor.py: Add support for Odyssey 'Component' materials. 2021-04-12 08:30:51 +01:00
Athanasius 5edf8d5b59 Change monitor.state['on_foot'] to 'OnFoot' for consistency 2021-04-12 08:30:51 +01:00
Athanasius f40f6464b6 PLUGINS.md: Document state['on_foot']
* Also restore 'New in' bits to just below the table.
2021-04-12 08:30:51 +01:00
Athanasius 7ae40591ad PLUGINS.md: Big cleanup
* New 'Avoiding potential pitfalls' section to be sure we list them all.
* All plain text now wrapped at 80 columns.
* Re-did all the section headings for consistency, and added many `---`
  between sections.
* Headers added within the 'Plugin-specific events' section.
2021-04-01 14:46:43 +01:00
Athanasius 5de4950fba Change config.appversion() to return semantic_version.Version
As we're changing it to a function at this stage anyway, it might as
well return this type, not a str.
2021-04-01 14:46:43 +01:00
Athanasius b841d434e5 plugintest: Document core version code & add to PLUGINS.md
* New PLUGINS.md section 'Checking core EDMC version'.
* And the same comments might as well be in the plugintest/load.py.
2021-04-01 14:46:43 +01:00
Athanasius 5a38537294 docs: General update for main now using Python 3.9 & misc
* Extend EDCD copyright into 2021 here as well.
* Recommend *against* any attempt at making plugins also work with
  Python 2.7.
* setup.py no longer writes appcast files.  Mention
  edmarketconnector.xml enclosure instead for the url= bit.
* DRY about location of log files, just point to appropriate wiki link.
2021-04-01 14:45:51 +01:00
Athanasius 3fddd2bdf9 try/except ModulesInfo.json load & fully document 2021-04-01 14:45:50 +01:00
Athanasius 1ee2be8fc8 Call out discrepancies between Journal doc v28 and reality in 3.7.x 2021-04-01 14:45:50 +01:00
Athanasius b3a1b0492e Correct event and file name to NavRoute(.json) & expand docs
* Despite what section 4.18 of v28 Journal docs say, the event is
  `NavRoute`, not `Route`, and the file is `NavRoute.json`.  The array
  of hops is still keyed as `Route` though.

* Calls out that both `NavRoute` and `Cargo` events, as passed to
  plugins, are augmented with the data from their respective files, and
  are not simply the 'bare' event as seen in the Journal.
2021-04-01 14:45:50 +01:00
Athanasius ef891fa8bd Initial support for Route.json file 2021-04-01 14:45:50 +01:00
Athanasius b3b72a05a8 PLUGINS.md: Be explicit about why plugin_prefs(...) -> Optional[tk.Frame] 2021-04-01 14:45:47 +01:00
Athanasius 903ec3d558 Added mention of deprecated methods
# Conflicts:
#	PLUGINS.md
2021-04-01 14:45:47 +01:00
A_D b5282fc8ea Deprecated camelCase methods
Python prefers snake_case methods and camelCase classes. This replaces
some camelCase methods with snake_case variants, and has the original
names raise a DeprecationWarning before calling the snake_case versions
2021-04-01 14:45:47 +01:00
A_D a68468d7ce Updated wording in plugins docs 2021-04-01 14:45:46 +01:00