incrementis / akuns-gear-

This is an item mod that contains 2 enchanted katanas and 1 armor for a Wizard Slayer.

Connect with me:

Quick-link Repo-Index

akuns-gear-'s Issues

Fixing the images in the AkunsGear<language>.pdf

The images in the PDF files are out of date.
These should be replaced with new ones.
These are:

• Weave to Dust
• Layers of Compassion

Check INI file format

“This file format is the standard INI format with minor variations”

Understanding the INI file format is recommended not only for this project but also for future mods.

Check if Akun's Gear mod gets any benefits from it. You can find more information about INI here:
https://gibberlings3.github.io/iesdp/file_formats/ie_formats/ini.htm

Power Crave mainhand only

The "Power Crave" is Opcode = 111 // Create Weapon, which replaces all equippable main hand weapon slots with the summoned item.
This can be problematic when "Power Crave" is equipped as an off-hand weapon, as it still replaces all main-hand weapon slots.

Understand LABEL

Work through the following topic and decide if this is necessary for this mod:
https://www.gibberlings3.net/forums/topic/32516-tutorial-what-is-label-why-you-should-create-it-and-how-to-do-it-properly/

Also, implement LABEL in mod if it is useful.

Indivdual weapon and armor sound

Since itemtype.2da offers the possibility to add new sound effects for grabbing and releasing the items, a sound experiment for this equipment set should be considered.

Here is an example entry for itemtype.2da:
74 GAM_41A GAM_41B 35

74 is the id which is referenced in ITM file.
GAM_41A GAM_41B are the sound files and can be found in the WAV folder.
35 means item is usable at mainhand only.

Mod-folder in Override

After installing a mod generated by WeiDU, the files will be located in the game's location, specifically in the override folder.
To keep things organized, create an “AkunsGear” folder in the Override folder.
This can be helpful in finding mod-specific data, especially if more than one mod is installed.

New description images recommended

The preset images in the description should be improved as they look unclean.
An example follows:

The white and gray areas must be removed.
An exception might be the jewel in "Weave to Dust".

Invalid character [!]

It seems that a parsing error may occur if "!" is used for category name. What this might look like requires further research, as it may only occur when used as the first character.

//[ITEMCAT] LEXER ERROR at line 40 column 1-3
//Near Text: !
//invalid character [!]
//WARNING: error parsing ITEMCAT.IDS: Parsing.Parse_error
//[ITEMCAT] LEXER ERROR at line 40 column 1-3
//Near Text: !
//invalid character [!]
//WARNING: error parsing ITEMCAT.IDS: Parsing.Parse_error

source: https://www.gibberlings3.net/forums/topic/36760-item-mod-bgee-akuns-gear/?do=findComment&comment=341552

Review self-made EET installation guide

The self-made EET installation guide must be checked to see whether the DLC "Siege of Dragonspear" is required.

This is the guide:
https://github.com/Incrementis/Akuns-Gear-/blob/main/akgear/Fast_installation_of_EET.pdf

Check !_ERDANE.STO

It is not clear whether the !_ERDANE.STO file is actually needed, as the file does not appear to be used in the code.

The target file can be found here:
https://github.com/Incrementis/Akuns-Gear-/tree/main/akgear/Store

tpa to tph in lib

The library contains files for outer and patch functions that are called outside the library folder.

In general, the library functionality is abstract in nature and can be used in other mods without modifications, so changing it to .tph should be fine.

The lib can be found here:
https://github.com/Incrementis/Akuns-Gear-/tree/main/akgear/lib

Folder lpa to laf

The “lpa” folder needs to be changed to “laf”.
laf stands for “launch action function” while “lpa” is not defined.

This folder is the target:
https://github.com/Incrementis/Akuns-Gear-/tree/main/akgear/lpa

Furthermore adjust the dependency graph which can be found here:
https://github.com/Incrementis/Akuns-Gear-/wiki/System

Discussion opportunities

There is no offer to discuss the mod in the readme file.
The discussion offering should include: GitHub, Beamdog and G3 forums.

Naming files with prefix

For example, the files in the “lpf” folder should be renamed with the “!_” prefix.
This helps find out who owns the files and who is responsible for them.

.tra for messages

The error and warning messages provide information for different languages ​​at the same time.
To resolve this issue, .tra files could be used.
The recommended solution is to give the specific OUTER_SPRINT variables the required @reference value.

All message files can be found here:
https://github.com/Incrementis/Akuns-Gear-/tree/main/akgear/lpa

The specific part for OUTER_SPRINT in WeiDU doc can be found here:
https://weidu.org/~thebigg/README-WeiDU.html#OUTER_SPRINT

If the doc is down, then use the attached screenshot.

Relocate WeiDU backup folder

Currently the backup folder is created in the following location:
akgear/Backup

This should be changed to "weidu_external/<gamefolder>/backup" as it is a dynamically generated folder while the mod folder contains static files.

Target file is:
https://github.com/Incrementis/Akuns-Gear-/blob/main/akgear/setup-akgear.tp2

Relocate Includes

Move the includes of lib files and global files within the tp2 file to the "ALWAYS" section as these files are needed globally and before mod installation.
The area "ALWAYS" features such behavior.

For more information about "ALWAYS" , see the WeiDU documentation:
https://weidu.org/~thebigg/README-WeiDU.html

If the documentation website is down, use the screenshot:

NOTE:
"ALWAYS" comes before the "LANGUAGE" area (see "TP2 Flag")!!!

Here is an example of ALWAYS:
// --------------
// Initialization
// --------------
ALWAYS
// LIBRARY INCLUDES(Don't touch these)
// -----------------------------------
INCLUDE ~%MOD_FOLDER%/lib/dynArrayFunctionalities.tph~
INCLUDE ~%MOD_FOLDER%/lib/dialogTlkFunctionalities.tph~

END// End of "ALWAYS"

Operating System in Readme

The readme file does not inform the user which operating system the mod supports.
This should be included in the readme file.

The supported operating system is Windows 11.
All versions except 11 may work, but it should be made clear that there is no guarantee.