CommsLogMFD

From Elite Wiki
Revision as of 05:47, 21 May 2015 by Phkb (talk | contribs)
CommlogMFD.png

Overview

This expansion pack adds a log of all communications received by the player and displays them in a multi-function display. As comms chatter can happen quickly in a battle situation, it can be easy to miss communications. The CommsLog MFD keeps all communications indefinitely, until either the log hits its maximum size (around 32k), or the user themselves clear the log. You can also view all communications received when docked, by going to the ship interfaces and selecting the "Communications Log".

You can purchase this MFD from any tech-level 3 systems for 250cr. Once purchased, the MFD is available while in flight, and the Communications Log becomes available in the ships interfaces. The MFD is primable equipment (the default is to use shift-N to prime a piece of equipment). When primed, use the mode key (default "b") to select a mode. The available modes are (in order):

  • Scroll back mode
  • Scroll forward mode
  • Scroll to previous launch
  • Scroll to next launch
  • View current
  • View oldest
  • Clear log mode
  • Write comms to latest log
  • Switch between message-by-message or line-by-line scrolling

After a mode is selected it can be activated (default "n").

If log is scrolled and left for 90 seconds, log will automatically revert to viewing the current message.

To aid in usability, if the "scroll forward" function is selected, and then activated, the next mode will be "scroll back". This allows easier scrolling backwards and forwards. The same thing happens with the scroll to next launch and scroll to previous launch modes.

When "view current" is activated, the mode will be automatically switched to "scroll back". When "view oldest" is activated, the mode will automatically switched to "scroll forward".

Licence/Author

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
The expansion pack was developed by phkb.

Installation

Place the 'CommsLogMFD.oxz' into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.
Alternatively, you can download the expansion using the expansion pack manager in the game itself.

Requirements

This expansion pack relies on having multi-function displays available in your HUD. You must at least be using Oolite version 1.79, and your HUD must have at least 1 MFD defined.

Download

Download v1.5.2 CommsLogMFD.oxz (downloaded 11516 times).
Alternative download from box.com

Version History

Version 1.5.2

  • Code improvements as suggested by Wildeblood.

Version 1.5

  • You can now exit the comms log interface screen at any time using a function key. For real this time.

Version 1.5

  • Added ability to set the log file size.
  • You can now exit the comms log interface screen at any time using a function key.

Version 1.4

  • Comms messages are now viewable in the dockside F4 Communications log, even if the scroller hasn't been purchased.
  • Fixed bug where clearing the log while docked would hide the HUD.
  • Fixed JS bug when clearing the log in flight.
  • F4 comms log options will now show all options, with various items disabled based on the log viewing position and content.
  • Code refactoring and cleanup.

Version 1.3

  • Whole MFD now puchasable equipment, not just the scroller.
  • New price of 250cr, which, along with the previous point, make it feel more "real" in game
  • New modes
    • Dump messages to log, which sends all current messages to the lastest log file
    • switch scroll mode to be either by message (default) or by line
  • Added "Communications log" to the system interfaces (f4) screen, so you can view your comms log while docked.
  • Code refactoring

Version 1.2.1

  • removed some debug code. No functional changes.

Version 1.2

  • Mode selection now changes scroll function between scroll back, scroll forward, scroll to previous launch, scroll to next launch, view current, view oldest, and clear log.
  • If log is scrolled and left for 90 seconds, log will automatically revert to viewing the current message
  • updated license reference in manifest.plist to match with the license specified in "comms_mfd.js"
  • split up the js files, putting the MFD code in one, and the scroller code in another.
  • fixed case when first line of first message might not be viewable in some circumstances
  • improved speed and memory management

Version 1.1

  • Scrolling by message, rather than by line (can be changed to line by line if you change a setting)
  • Better handling of local variables
  • Fixed the name of the MFD used to be consistent with the OXP name
  • Log is kept between launches (can be changed to clear on launch if you change a setting)
  • Log size limit added
  • Added "Launch" and "Dock" messages to the comms log to help delineate between message sections
  • Corrected the readme file license link to match with the license specified in "comms_mfd.js"
  • Adjusted the width setting to leave more of a margin on the right side of the box

Quick Facts

Version Released License Features Category Author(s) Feedback
1.5.2 2015-05-21 CC BY-NC-SA 4.0 Hud MFD HUDs OXPs‏‎ phkb Oolite BB

Gameplay and Balance indicator

Tag-colour-green.png