An open API service indexing awesome lists of open source software.

https://github.com/mahiethan/morrowind-inventory-manager

C++ program and Lua script which retrieves and manages the inventory items belonging to a character in the game "The Elder Scrolls III: Morrowind".
https://github.com/mahiethan/morrowind-inventory-manager

cpp lua morrowind mwse

Last synced: 4 months ago
JSON representation

C++ program and Lua script which retrieves and manages the inventory items belonging to a character in the game "The Elder Scrolls III: Morrowind".

Awesome Lists containing this project

README

          

# TES III : Morrowind Inventory Management Tool

# ***Work in Progress***

## Prerequisites

- A game copy of *"The Elder Scrolls III: Morrowind"*

- *g++ compiler* (C++ compiler)
- Installation guide: https://code.visualstudio.com/docs/cpp/config-mingw

- *MWSE (Morrowind Script Extender)*
- Installation: https://www.nexusmods.com/morrowind/mods/45468 (Nexus Mods)

- Follow the mod requirements listed on this mod webpage to ensure compatability.

## How to compile?

If you have g++ installed, you can compile the program using the following command from the `./Morrowind-Inventory-Manager` directory:

UPDATE FOLLOWING COMMAND TO INCLUDE NEW CLASSES

```shell
g++ -g ./classes/item.cpp ./classes/equippable.cpp ./classes/armor.cpp ./classes/weapon.cpp ./classes/thieves_tool.cpp ./classes/clothing.cpp ./classes/misc.cpp ./classes/soul_gem.cpp ./classes/apparatus.cpp ./classes/light.cpp main.cpp -o inventoryManager
```

This will produce an executable `inventoryManager.exe` which you can run by clicking on it, or using a terminal window like Command Line (`cmd`) etc.

If your system supports shell, you can instead run the `compile.sh` script by clicking on the file, or by typing the following command on a shell-compatible terminal window:

```shell
sh compile.sh
```

The above script *only* works inside the `./Morrowind-Inventory-Manager` folder, and not within any subdirectories. Additionally, the script will not compile the code if the program is running, so make sure to *exit the program before compiling*.

## Where to place the Lua script inside the `inventoryExplorer` folder?

Copy the entire folder `inventoryExplorer` into the following directory:

```
PATH/TO/GAME/Morrowind/Data Files/MWSE/mods
```

Once placed here, the contained Lua script is triggered to work when successfully loading a save inside the game. The following message will appear, every time a save file is loaded, to indicate that the Lua script is correctly working:

```
"Exporting inventory items ..."
```

The inventory items of the playable character in the save file will be stored in a text file called `inventory_output.txt`, which will be produced in the same directory as the Lua script `./inventoryExplorer` inside the `./mods` folder.

The path for this text file can be changed by editing the following value in the `main.lua` script:

```lua
local filePath = "./Data Files/MWSE/mods/inventoryExporter/inventory_output.txt"
```