*****************************************************************

The Elder Scrolls III
MORROWIND Mod: MWSE 2.1 Journal Search and Edit

*****************************************************************

Index:

1. Description
2. Installation and Requirements
3. Playing the Plugin
4. Features
5. Version
6. Conflicts & Compatability
7. Credits & Thanks
8. Notes
9. Copyright


*****************************************************************

1. PLUGIN DESCRIPTION

*****************************************************************


TITLE: MWSE2.1 Journal Search and Edit
VERSION: v1.12

BY: svengineer99/sveng
CONTACT: Nexus/Discord

*****************************************************************

2. INSTALLING THE PLUGIN

*****************************************************************S

To install the plugin, unzip the files into the Morrowind/Data Files directory.

REQUIREMENTS: Morrowind, Bloodmoon, Tribunal,
MWSE v2.1 ( 5/01/2019 release or later )
https://nullcascade.com/mwse/mwse-dev.zip
development release mirror
MCP v2.4 (or later)
https://www.nexusmods.com/morrowind/mods/19510
including all Bug fixes
MGE-XE v0.10.1 (or later)
http://www.nexusmods.com/morrowind/mods/41102

*****************************************************************

3. PLAYING THE PLUGIN

*****************************************************************

Copy-merge the folder contents into your Data Files
then you should have Data Files\MWSE\mods\sve\journal\ folder
with main.lua, config.lua and mcm.lua files

*****************************************************************

4. PLUGIN FEATURES

*****************************************************************

Added journal menu features:

Search
- Simply start typing to search for text on open pages
- Tap "]" or "[" to highlight the next or prev match on open pages
- Hold "]" or "[" to continue the search on next/prev pages
- Tap "\" to exit search mode

Edit
- Tap "Shift" "Arrow Up" or "Arrow Down" to save and select new entries to edit
- Tap "Arrow Left" and "Arrow Right" to move the cursor 1 character as usual
- Tap "Arrow Up" and "Arrow Down" to move the cursor ~15 characters
- Tap "Shift" "Backspace" to delete the word to the left of the cursor
works repetitively, but the cursor will move to the end after
- Tap "Shift" "Delete" to delete the entire entry text
- Tap "\" to discard the entry edit and exit edit mode
- Tap "Shift" "Enter" to save the entry edit and exit edit mode
- added text requires manual formatting to avoid overflow
- recommend to add new lines of text only on completed pages, otherwise may
overflow on subsequent game play journal entry

Insert new pages
- Tap "Shift" "Arrow Right" to insert 2 new pages between the open 2
or to move between editing pages left to right or right to left
- only 2 new pages per 2 pages supported at this time
- at least one journal entry must be recorded to enable edit features
- requires manual formatting to avoid overflow

v1.1:
Insert book art images
- Tap "Alt" "Arrow Right" or "Arrow Left" to insert/select book art images
- art images available from books read in game
- limit of one image per inserted page
- Tap "Alt" "+" or "-" to coarsely scale the image larger or smaller
- Tap "Alt" "]" or "[" to finely scale the image larger or smaller

v1.11:
- custom images may be placed in Data Files\BookArt\Journal\
folder or sub-folders for stock access
- dds or tga format only, 2^N sizing (such as 512x512) only
- append _<width>_<height> (such as image_377_255.dds)
for custom aspect ratio scaling

v1.12:
- fixed topics and quests extra pages colliding with base journal


Hyperlinked topics
All of the above functions should work for journal topics pages
Adding hyperlink text should be automatically highlighted and linked

Convenience hot keys, not in search or edit mode
- Tap "Tab" to close the Journal menu ("J" will begin a search)
also returns from hypertext link journal pages to the main journal
- Tap or hold "Arrow Left" or "Arrow Right" to turn to the next or prev pages
(key board alternate to mouse wheel)

Tidiness:
- Hides redundant date headers on the same page
Example: only one "16 Last Seed (Day 1)" header would appear on page 1
- Compresses the space between entries
Combined, these changes free up space to add text in editing mode

Mod Configuration Menu:
- Customize the the hot key bindings described above
- Enable/disable/tune journal tidiness features described above
- Page turning, search indication and UI latency timing

*****************************************************************

5. PLUGIN VERSION

*****************************************************************

v1.0 Initial release
v1.1 Added book art image functionality
v1.11 Custom images may be added to Data Files\BookArt\Journal\

*****************************************************************

6. CONFLICTS, COMPATABILITY and SAVE GAME CLEANING

*****************************************************************

Conflicts - Any other mod that dynamically messes with the journal

*****************************************************************

7. CREDITS & THANKS

*****************************************************************

Hrnchamd: for UI Inspector, Text input example, research, MWSE dev support, ..
NullCascade and team: for MWSE lua scripting development and docs
NullCascode, Greatness7, Petethegoat, Merlord, Mort, Remiros, Abot, ... for
Morrowind Modding Discord MWSE chat discussion, help, inspiration.
Released and unreleased lua scripting references
Link to join: https://discord.gg/kVRSwkE
Merlord: for Easy MCM
Danae: for playtesting feedback

Darkelfguy: for Morrowind Modding Marathon Inspiration
Bethsoft: Of course, for the game engine
Everyone who has contributed and continues to contribute to Morrowind Modding

*****************************************************************

8. NOTES

*****************************************************************

*****************************************************************

9. COPYRIGHT

*****************************************************************

This plugin is freely distributable and modifiable, as long as this readme
file accompanies it and credit is given to the original author. But please remember
that not everything here is my work. Refer to section 7.THANKS. By downloading
and running this plugin, you acknowledge the following :

- You have read and understood this readme file.
- You acknowledge that the author of this plugin accepts no responsibility for
damage to your game saves, operating system, computer, etc,
when using this plugin.

NOTE: Please do not upload this plugin for distribution without my permission.

--svengineer99