Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 4.06 KB

README.md

File metadata and controls

79 lines (56 loc) · 4.06 KB
Raw

xEdit-Armor-Export

xEdit script for exporting crafting materials and combined armor ratings

This script was designed to be used with the Character Tracker iOS app. It is still totally usable without it, though.

Use

Dependencies

Microsoft Visual C++ Redistributable for Visual Studio

Installation

  1. Download xEdit-Armor-Export.zip from the Releases tab.
  2. Extract to your xEdit (TES5Edit, TES5VREdit, etc.) folder, merging any contents.
    • If it asks to replace mteFunctions.pas, it shouldn't matter either way.
    • Extracting Python38 and Armor_Export.py is optional. These are used for creating QR codes for Character Tracker. You are welcome to remove them if you are not using the app.

Running

  1. In xEdit, select all armor items for a particular armor set then right click and choose Apply Script....
  2. From the menu, chose Armor Stats and Requirements.pas and click OK.
  3. Enter a name for the armor set.
  4. Optional: Enter a name for the mod if you want it shown in Character Tracker.
    • If you leave this empty, no mod entry will be created in the JSON.
    • This has no affect on the simple printout.
  5. This will create an Ingredients.txt file in the Armor Export folder in your xEdit directory with the following information:
    • CSV list of crafting ingredients required
      • quantity, plugin name and FixedFormID, DisplayName
    • Combined armor rating
    • The armor type (of the first armor selected)
    • Calculated level based on type and rating
    • JSON that can be imported into Character Tracker
    • A QR code that can be scanned into Character Tracker if myqr.exe is present.
  6. A GUI will launch for adding images and URL and for generating QR codes.
    • Manually add images with the Image URL text box
    • Enter a Nexusmods mod page in the Nexusmods URL text box to select images from the mod page to load.
      • Adult-only mod pages will not load as they require a user to be signed in, and this does not currently support signing in to an account.
      • The URL entered here along with the title in "Link Name" will be saved to both the mod and module.
    • When you have the images inputted that you'd like, click any of the Save images to buttons to save the images to the Ingredients.json file.
      • Check Generate QR code to generate a QR code that can be scanned into Character Tracker.

Build

(You can ignore this section if you just download a release zip)

xEdit scripts are compiled at runtime, so no build is required for the Pascal script.

This script depends on mteFunctions.pas (included in releases).

Python

The Python UI is built using PySimpleGUI.

WinPython

The image and QR code UI is built using Python. To use a standalone Python distribution like the ones included in releases, you can download a Python 3.8dot release from WinPython. Copy the Python folder (will look something like python-3.8.6.amd64) to Armor Export and rename it to Python38.

To install dependencies, navigate to the xEdit directory in Command Prompt and run the following command:

Python38\python.exe -m pip install -r requirements.txt

You should now be able to access the UI from the xEdit script or by running run.bat.

Note that you must run this from the xEdit directory, not the Armor Export directory, or the relative file paths will be wrong.

MyQR

Isvvc/qrcode is required to generate QR codes. This is a slightly modified version of sylnsfar/qrcode. The changes I made were

  1. adding " and the line break character to the supported characters list so it could encode JSON and
  2. allowing it to read input from a file so long JSON could be passed in without having to try to pass it as an argument.