Mod:Knightcore: Difference between revisions

From PMDOWiki
Imbion (talk | contribs)
Created page with "{{ModData|namespace=knightcore|creator=Imbion|type=Framework|version=0.8.11|download=https://codeberg.org/Imbion/pmdo_knightcore}} '''Knightcore''' is a framework mod for PMDO. It implements various helper functions for a bunch of features that are required for quest mods, such as handling dialogue and handling cameras. It also re-uses some functions from Halycon."
 
Imbion (talk | contribs)
Instructions and such
Line 2: Line 2:


'''Knightcore''' is a framework [[mod]] for PMDO. It implements various helper functions for a bunch of features that are required for quest mods, such as handling dialogue and handling cameras. It also re-uses some functions from Halycon.
'''Knightcore''' is a framework [[mod]] for PMDO. It implements various helper functions for a bunch of features that are required for quest mods, such as handling dialogue and handling cameras. It also re-uses some functions from Halycon.
== Usage ==
To use knightcore as a framework, copy the folder named <code>knightcore</code> found in the path <code>Data/Script</code> of the mod into the using mod's <code>Data/Script</code> folder.
Then, to use the scripts, use the <code>require</code> keyword to include any script files that will be used in the other mod's script. For example, to use the function <code>ActorsKC.SpyAround</code>, the require keyword would be used like <code>require 'knightcore.ActorsKC'</code>.
The script can then be called like any other function, for example like <code>ActorsKC.SpyAround(...)</code>.
== Script Files ==
{| class="wikitable"
! Name !! Purpose
|-
| [[Mod:Knightcore/ActorsKC|ActorsKC]] || Moving actors/character around and controlling emotes on the ground map.
|-
| [[Mod:Knightcore/Knightcore|Knightcore]] || General knightcore functions that don't belong elsewhere.
|-
| [[Mod:Knightcore/MonsKC|MonsKC]]  || Creating mons and doing things with them, including adding them to the team.
|-
| [[Mod:Knightcore/SceneKC|SceneKC]] || Controlling the current ground map scene, such as camera position and re-used ground objects.
|-
| [[Mod:Knightcore/ScriptKC|ScriptKC]] || Controlling the behaviour of the game's dialouge script and other related functions.
|-
| [[Mod:Knightcore/StringKC|StringKC]] || Manipulation of strings.
|-
| [[Mod:Knightcore/IntroKC|IntroKC]] || Running actions with quest introductions and setup.
|}

Revision as of 02:07, 29 September 2025

Namespace knightcore
Creator Imbion
Type Framework
PMDO Version 0.8.11
Download Link(s) https://codeberg.org/Imbion/pmdo_knightcore


Knightcore is a framework mod for PMDO. It implements various helper functions for a bunch of features that are required for quest mods, such as handling dialogue and handling cameras. It also re-uses some functions from Halycon.

Usage

To use knightcore as a framework, copy the folder named knightcore found in the path Data/Script of the mod into the using mod's Data/Script folder.

Then, to use the scripts, use the require keyword to include any script files that will be used in the other mod's script. For example, to use the function ActorsKC.SpyAround, the require keyword would be used like require 'knightcore.ActorsKC'.

The script can then be called like any other function, for example like ActorsKC.SpyAround(...).

Script Files

Name Purpose
ActorsKC Moving actors/character around and controlling emotes on the ground map.
Knightcore General knightcore functions that don't belong elsewhere.
MonsKC Creating mons and doing things with them, including adding them to the team.
SceneKC Controlling the current ground map scene, such as camera position and re-used ground objects.
ScriptKC Controlling the behaviour of the game's dialouge script and other related functions.
StringKC Manipulation of strings.
IntroKC Running actions with quest introductions and setup.