PSwiki - User contributions [en]

Unreal Performance Tests

2026-09-02T07:29:21Z

Talad:

>>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<<

1280x720 windowed mode, all settings to EPIC

Numbers are FPS

Note: on Mac I had to upgrade XCode from 15.4 (used by the old release) to 16.2 (used by the new release).

Note: On a PC, textures and render targets live in the GPU's '''dedicated VRAM,''' Apple Silicon uses '''Unified Memory''' - CPU and GPU share one physical pool. So on the Mac, that same ~5 GB of textures/render targets shows up ''in the process footprint'' and counts against the RAM you see with 'top'.

<nowiki>#</nowiki>hydlaa main (worst spot)

UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604;

Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb)

Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb) Here we are trashing memory to swap, as we go above about 1.5Gb of the physical memory. In a case where it was not swapping we got 19FPS.

Linux: old: 24 new: 31 (memory used: old: 1.3Gb new: 1.7Gb)

<nowiki>#</nowiki>harnquist stair, looking towards jayose

UPDATE planeshift_prod2.characters t SET t.loc_x = 198075.67, t.loc_y = -315402.4, t.loc_z = 10657.97, t.loc_yrot = 3.6 WHERE t.id = 9087604;

Windows: old: 51 new: 68

Mac: old: 10 (all low 25) new: 20 (all low 55)

Linux: old: 26 new: 34

<nowiki>#</nowiki>ojaveda top

UPDATE planeshift_prod2.characters t SET t.loc_x = 526936.98, t.loc_y = -358348.34, t.loc_z = 16021.26, t.loc_yrot = 5.57 WHERE t.id = 9087604;

Windows: old: 76 new: 125

Mac: old: 14.6 new: 32

Linux: old: 32 new: 43

<nowiki>#</nowiki>bronze doors

UPDATE planeshift_prod2.characters t SET t.loc_x = 127914.89, t.loc_y = -707701.47, t.loc_z = 13639.43, t.loc_yrot = 4.7 WHERE t.id = 9087604;

Windows: old: 113 new: 165

Mac: old: 16.3 new: 36.5 (memory used: old: 2.431Gb new: 5.759Gb)

Linux: old: 37 new: 55

Unreal Performance Tests

2026-09-02T06:50:25Z

Talad:

>>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<<

1280x720 windowed mode, all settings to EPIC

Numbers are FPS

Note: on Mac I had to upgrade XCode from 15.4 (used by the old release) to 16.2 (used by the new release).

Note: On a PC, textures and render targets live in the GPU's '''dedicated VRAM,''' Apple Silicon uses '''Unified Memory''' - CPU and GPU share one physical pool. So on the Mac, that same ~5 GB of textures/render targets shows up ''in the process footprint'' and counts against the RAM you see with 'top'.

<nowiki>#</nowiki>hydlaa main (worst spot)

UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604;

Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb)

Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb)

Linux: old: 24 new: 31 (memory used: old: 1.3Gb new: 1.7Gb)

<nowiki>#</nowiki>harnquist stair, looking towards jayose

UPDATE planeshift_prod2.characters t SET t.loc_x = 198075.67, t.loc_y = -315402.4, t.loc_z = 10657.97, t.loc_yrot = 3.6 WHERE t.id = 9087604;

Windows: old: 51 new: 68

Mac: old: 10 (all low 25) new: 20 (all low 55)

Linux: old: 26 new: 34

<nowiki>#</nowiki>ojaveda top

UPDATE planeshift_prod2.characters t SET t.loc_x = 526936.98, t.loc_y = -358348.34, t.loc_z = 16021.26, t.loc_yrot = 5.57 WHERE t.id = 9087604;

Windows: old: 76 new: 125

Mac: old: 14.6 new: 32

Linux: old: 32 new: 43

<nowiki>#</nowiki>bronze doors

UPDATE planeshift_prod2.characters t SET t.loc_x = 127914.89, t.loc_y = -707701.47, t.loc_z = 13639.43, t.loc_yrot = 4.7 WHERE t.id = 9087604;

Windows: old: 113 new: 165

Mac: old: 16.3 new: 36.5 (memory used: old: 2.431Gb new: 5.759Gb)

Linux: old: 37 new: 55

Unreal Performance Tests

2026-09-01T23:07:47Z

Talad:

>>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<<

1280x720 windowed mode, all settings to EPIC

Numbers are FPS

Note: on Mac I had to upgrade XCode from 15.4 (used by the old release) to 16.2 (used by the new release).

Note: On a PC, textures and render targets live in the GPU's '''dedicated VRAM,''' Apple Silicon uses '''Unified Memory''' - CPU and GPU share one physical pool. So on the Mac, that same ~5 GB of textures/render targets shows up ''in the process footprint'' and counts against the 8 GB.

<nowiki>#</nowiki>hydlaa main (worst spot)

UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604;

Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb)

Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb)

Linux: old: 24 new: 31 (memory used: old: 1.3Gb new: 1.7Gb)

<nowiki>#</nowiki>harnquist stair, looking towards jayose

UPDATE planeshift_prod2.characters t SET t.loc_x = 198075.67, t.loc_y = -315402.4, t.loc_z = 10657.97, t.loc_yrot = 3.6 WHERE t.id = 9087604;

Windows: old: 51 new: 68

Mac: old: 10 (all low 25) new: 20 (all low 55)

Linux: old: 26 new: 34

<nowiki>#</nowiki>ojaveda top

UPDATE planeshift_prod2.characters t SET t.loc_x = 526936.98, t.loc_y = -358348.34, t.loc_z = 16021.26, t.loc_yrot = 5.57 WHERE t.id = 9087604;

Windows: old: 76 new: 125

Mac: old: 14.6 new: 32

Linux: old: 32 new: 43

<nowiki>#</nowiki>bronze doors

UPDATE planeshift_prod2.characters t SET t.loc_x = 127914.89, t.loc_y = -707701.47, t.loc_z = 13639.43, t.loc_yrot = 4.7 WHERE t.id = 9087604;

Windows: old: 113 new: 165

Mac: old: 16.3 new: 36.5 (memory used: old: 2.431Gb new: 5.759Gb)

Linux: old: 37 new: 55

Unreal Performance Tests

2026-09-01T22:40:11Z

Talad:

>>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<<

1280x720 windowed mode, all settings to EPIC

Numbers are FPS

Note: on Mac I had to upgrade XCode from 15.4 (used by the old release) to 16.2 (used by the new release).

<nowiki>#</nowiki>hydlaa main (worst spot)

UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604;

Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb)

Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb)

Linux: old: 24 new: 31 (memory used: old: 1.3Gb new: 1.7Gb)

<nowiki>#</nowiki>harnquist stair, looking towards jayose

UPDATE planeshift_prod2.characters t SET t.loc_x = 198075.67, t.loc_y = -315402.4, t.loc_z = 10657.97, t.loc_yrot = 3.6 WHERE t.id = 9087604;

Windows: old: 51 new: 68

Mac: old: 10 (all low 25) new: 20 (all low 55)

Linux: old: 26 new: 34

<nowiki>#</nowiki>ojaveda top

UPDATE planeshift_prod2.characters t SET t.loc_x = 526936.98, t.loc_y = -358348.34, t.loc_z = 16021.26, t.loc_yrot = 5.57 WHERE t.id = 9087604;

Windows: old: 76 new: 125

Mac: old: 14.6 new: 32

Linux: old: 32 new: 43

<nowiki>#</nowiki>bronze doors

UPDATE planeshift_prod2.characters t SET t.loc_x = 127914.89, t.loc_y = -707701.47, t.loc_z = 13639.43, t.loc_yrot = 4.7 WHERE t.id = 9087604;

Windows: old: 113 new: 165

Mac: old: 16.3 new: 36.5 (memory used: old: 2.431Gb new: 5.759Gb)

Linux: old: 37 new: 55

Unreal Performance Tests

2026-09-01T22:32:05Z

Talad: Created page with ">>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<< 1280x720 windowed mode, all settings to EPIC Numbers are FPS <nowiki>#</nowiki>hydlaa main (worst spot) UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604; Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb) Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb) L..."

>>>>> PERFORMANCE TESTING for Unreal Migration from 5.4.3 (old) to 5.7.4 (new) <<<<<<

1280x720 windowed mode, all settings to EPIC

Numbers are FPS

<nowiki>#</nowiki>hydlaa main (worst spot)

UPDATE planeshift_prod2.characters t SET t.loc_x = 205529.87, t.loc_y = -313437.28, t.loc_z = 10587, t.loc_yrot = 2.6 WHERE t.id = 9087604;

Windows: old: 46-47 new: 65 (memory used: old: 1.34Gb new: 1.639Gb)

Mac: old: 9.5 new: 2.5!! (memory used: old: 3.381Gb new: 7.375Gb)

Linux: old: 24 new: 31 (memory used: old: 1.3Gb new: 1.7Gb)

<nowiki>#</nowiki>harnquist stair, looking towards jayose

UPDATE planeshift_prod2.characters t SET t.loc_x = 198075.67, t.loc_y = -315402.4, t.loc_z = 10657.97, t.loc_yrot = 3.6 WHERE t.id = 9087604;

Windows: old: 51 new: 68

Mac: old: 10 (all low 25) new: 20 (all low 55)

Linux: old: 26 new: 34

<nowiki>#</nowiki>ojaveda top

UPDATE planeshift_prod2.characters t SET t.loc_x = 526936.98, t.loc_y = -358348.34, t.loc_z = 16021.26, t.loc_yrot = 5.57 WHERE t.id = 9087604;

Windows: old: 76 new: 125

Mac: old: 14.6 new: 32

Linux: old: 32 new: 43

<nowiki>#</nowiki>bronze doors

UPDATE planeshift_prod2.characters t SET t.loc_x = 127914.89, t.loc_y = -707701.47, t.loc_z = 13639.43, t.loc_yrot = 4.7 WHERE t.id = 9087604;

Windows: old: 113 new: 165

Mac: old: 16.3 new: 36.5

Linux: old: 37 new: 55

PSUnreal Programming

2026-09-01T22:03:00Z

Talad: /* PS Unreal Engine */

== Installation of Unreal Engine ==

The overall process begins by installing Unreal Engine and building from source, then follows through the PSUnreal setup page.

{| style="width: 85%;"
|-
| http://www.planeshift.it/graphics/bullets/windows_icon.png|| http://www.planeshift.it/graphics/bullets/linux_icon.png || http://www.planeshift.it/graphics/bullets/mac_icon.png
|-
| [[Building PSUnreal on Windows]]|| [[Building PSUnreal on Linux]]|| [[Building PSUnreal on macOS]]
|}

[[Errors in Database connection]]

[[Errors Unreal Compile]]

[[Errors in Running the client]]

== Engine ==

[[Best tutorials to start]] with UE

[[Packing and shipping a project]]

[[CS Code convertion]]

[[PSUnreal Classes]]

[[PSUnreal Navigation Meshes]]

[[Engine inner working]]

[[List of all Unreal Engine Log categories]]

[[Build one Unreal Engine Plugin only]]

Check this article if you are suffering from slow Intellisense parsing: https://forums.unrealengine.com/development-discussion/c-gameplay-programming/65252-for-those-who-suffer-from-visual-studio-intellisense-slowness

[[Network load]]

[[PSUnreal GDB Debug Hints]]

[[PNG File Validation]]

[[Enhanced Input]]

[[JetBrains Rider]]

== PS Unreal Engine ==

Put here the notes of our architecture for Unreal.

[[PSUECharacter setup]]

[[Unreal Performance Tests]]

== Update Unreal Engine and Git commands ==
If you messed up your repository, try: git reset --hard

If you miss files try : git checkout .

To update to a newer UE version:

* git fetch
* git reset --hard (to discard local changes in case you have)
* git checkout 5.1.1-release --force
* (OPTIONAL to check if you have the right version now) git status
* (OPTIONAL if things go bad) Delete all files contained in UnrealEngine\Intermediate AND PSUnreal\Intermediate
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* COPY the files under PSUnreal\UESource in UnrealEngine main dir
* Clean the UE4 project from VS
* Rebuild UE from VS

To see tags:
* git tag --list (to list all available new tags)
* git log --tags --simplify-by-decoration --pretty="format:%ai %d" (to see all tags with dates)

If you get an error for the new authentication token: "Support for password authentication was removed on August 13, 2021. Please use a personal access token instead."

See: https://magecomp.com/blog/generate-personal-access-token-github/

and use this for the last line: git remote set-url origin https://<token>@github.com/EpicGames/UnrealEngine.git/

== Advanced Locomotion System (ALS_CPP v4) ==
[[ALS for UE5.4]]

[[ALS Idle Animations]]

== Alternative Update Unreal Engine using Tortoise Git GUI ==

[https://tortoisegit.org/download/ Get TortoiseGit here].

To update to a newer UE version, In windows explorer right click on folder containing Unreal engine then:

* Delete all files contained in PSUnreal\Intermediate and UnrealEngine\Engine\Intermediate
* select > TortoiseGit > fetch. (make sure in window that opens "tags" is selected under options
* TortoiseGit > revert (to discard local changes in case you have)
* TortoiseGit > switch/checkout
** Then select tag and choose 5.1.1-release from dropdown
** Under options only have "overwrite working tree changes (force)" selected
** Press "ok" and allow it to update.
* Copy files in PSUnreal\UESource > to the appropriate folder in UnrealEngine\Engine\Source.
* launch Setup.bat to update dependencies
* launch GenerateProjectFiles.bat
* Clean the UE4 project from VS
* Rebuild

== Unreal Engine 5 ==
1) Tried minimal clone as the full one was failing continuously. This will create a subdirectory called 5.4.3-release<blockquote>git clone <nowiki>https://github.com/EpicGames/UnrealEngine.git</nowiki> --depth=1 --single-branch 5.4.3-release</blockquote>2) Setup.bat (or .sh or .command)

3) GenerateProjectFiles.bat ( or .sh or .command)

3) From VS 2022, it required install of Net framework 3.1, done.

4) open UE5.sln and Build Unreal Engine 5 with Development Editor configuration and Win64 Platform

== Other Stuff ==
[[Compiling Mumble Lib]]

Building PSUnreal on Linux

2026-08-30T11:29:34Z

Talad: /* Building PSUnreal */

== Building UEEditor on Linux ==

=== References ===

https://docs.unrealengine.com/en-US/Platforms/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/index.html

https://www.ue4community.wiki/Legacy/Running_On_Linux
https://www.ue4community.wiki/Legacy/Cooking_On_Linux

[[Some Linux commands]]

=== Installation steps ===

# Register for a free account at github.com
# Per the first link above, join the unreal project

'''Be sure to install all dependencies first'''

> sudo apt-key update
> sudo apt-get update
> sudo apt-get upgrade
> sudo apt-get install git

get source code. On Linux I had to use the SSH git URL. I had to create a new key with:
> ssh-keygen -t ed25519 -C my@email.it
> ssh-add ~/.ssh/id_ed25519
> cat ~/.ssh/id_ed25519.pub (and copy the result in github.com under Settings add new SSH Key)
> ssh -T git@github.com (then this command should give you a success result)

> git clone --depth=1 --single-branch -b 5.7.4-release git@github.com:EpicGames/UnrealEngine.git 5.7.4-release

this will create a "5.4.3-release" directory as child of the dir where you run the command

Launch the setup to download '''19.2Gb''' of dependencies
> ./Setup.sh

Generate project files
> ./GenerateProjectFiles.sh

Build UnrealEngine (this builds Shipping)
> make
Build UnrealEngine (this buildings Development)
./Engine/Build/BatchFiles/Linux/Build.sh UnrealEditor Linux Development

== Running the editor ==

Before moving to PlaneShift Unreal, its best to test if the standard Unreal Engine works.

To do this you need to have X available. If you are in a server only configuration, you need to install X.

> sudo apt-get install xinit
> sudo apt-get install ubuntu-desktop

and you need then to start it:

> sudo startx

When you are in X, open a terminal window and

> cd Engine/Binaries/Linux/
> ./UE4Editor

== Building PSUnreal ==

Download the PSUnreal project
> cd \
> svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal

You need to install '''MariaDB Connector''' from: https://mariadb.com/downloads/#connectors

* Select C connector and the linux platform
* PLEASE NOTE UBUNTU 20.4 requires the new version of mariadb connector: mariadb-connector-c-3.1.11-ubuntu-focal-amd64.tar.gz or you will get a libssl1.0 error when running the server.
* Extract in a temporary directory the file you get
tar -xzvf mariadb-connector-c-3.1.7-linux-x86_64.tar.gz

* From the MariaDB extracted directory, copy both <code>lib/</code> and <code>include/</code> (with subfolders) into <code>PSUnreal\ThirdParty\MariaDB\</code>
cp -r * /home/planeshift/PSUnreal/ThirdParty/MariaDB/

* Recompile Wordnet
> cd /home/planeshift/PSUnreal/ThirdParty/Wordnet/
> cd /home/planeshift/disk2/PSUnreal511/ThirdParty/Wordnet/
> gcc -c -fPIC *.h *.c -Wformat-overflow=0
> ar -cvq libWordnet.so *.o
> mv libWordnet.so lib/x64/Wordnet.so

* generate project files
> /home/planeshift/UnrealEngine/GenerateProjectFiles.sh -project="/home/planeshift/PSUnreal/PSUnreal.uproject" -game -engine
> /home/planeshift/disk2/5.1.1-release/GenerateProjectFiles.sh -project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"

* recompile the project
> /home/planeshift/UnrealEngine/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/PSUnreal/PSUnreal.uproject"
> /home/planeshift/disk2/5.1.1-release/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"
> /home/luke/External/5.7.4-release/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/luke/PSUnreal511/PSUnreal.uproject"

* Be sure to have Unreal Engine find all the libraries needed
> export LD_LIBRARY_PATH=/home/planeshift/UnrealEngine/Engine/Binaries/Linux:/home/planeshift/PSUnreal/ThirdParty/MariaDB/lib/mariadb

== Package Development server and client ==
/mnt/nvme/ue/UnrealEngine-4.27/Engine/Build/BatchFiles/RunUAT.sh -ScriptsForProject=<PATH TO PROJECT>.uproject BuildCookRun -project=<PATH TO PROJECT>.uproject -noP4 -clientconfig=Development -serverconfig=Development -utf8output -platform=Linux -server -serverplatform=Linux -targetplatform=Linux -build -cook -allmaps -compressed -stage -archive -unversionedcookedcontent -archivedirectory="<Archive Dir>"

== Troubleshooting ==

=== File couldn't be loaded by the OS===

I got this error:

[2020.05.05-17.04.04:228][ 0]LogCore: Warning: dlopen failed: (null)
[2020.05.05-17.04.04:228][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so' because the file couldn't be loaded by the OS.

So I used this to get the list of libraries he is in need of

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so

and then added the export LD_LIBRARY_PATH mentioned above, and it worked

Same error on PSUpdater module:

[2020.07.03-14.59.50:796][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so' because the file couldn't be loaded by the OS.

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so

I set the environment variable LD_DEBUG and then launch the program
export LD_DEBUG=libs

=== Can't connect to local MySQL server ===

Error: Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

Check your /etc/mysql/my.cnf , and see where is the socket location. for me it was /var/run/mysqld/mysqld.sock , so I added a symbolic link to it.

ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock

=== Some errors that you may encounter along the way ===

You see a file named something like "GitDependencies-crash.log" in your UnrealEngine directory. The contents of the file contains this message:

mono GitDependencies.exe --prompt crashed with return code 134

Solution: Ensure your copy of mono is up to date and rerun the Setup.sh script
At time of writing, I am using mono 3.2.8

Reason - This could be due to an old version of mono, but it seems to happen for other reasons too.

Should probably clean and recompile UEEditor at this point.

=== error while loading shared libraries: libLND.so ===

<code>
user@u13:~/Development/UnrealEngine/Engine/Binaries/Linux$ ./UE4Editor
./UE4Editor: error while loading shared libraries: libLND.so: cannot open shared object file: No such file or directory
</code>

To fix this, copy libLND.so (there are several flavors) from another directory to the Binaries/Linux directory. Do not use a symbolic link, just make a copy of the file. On my installation, a sym link worked in some places but failed in miserably others.

<code>
$ find ../../../../ -name libLND.so -print
../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so
cp ../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so .
</code>

=== Some fonts are in the wrong place. Its important to fix this ===

<code>
[2015.05.03-07.28.52:548][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Slate/Fonts/Roboto-Italic.ttf'
$ find ../../../ -name Roboto-Italic.ttf -print
../../../Engine/Content/Editor/Slate/Fonts/Roboto-Italic.ttf
../../../Engine/Content/Slate/Testing/Fonts/Roboto-Italic.ttf
cp ../../../Engine/Content/Editor/Slate/Fonts/* ../../../Engine/Content/Slate/Fonts/
cp ../../../Engine/Content/Slate/Testing/Fonts/* ../../../Engine/Content/Slate/Fonts/
</code>

=== I don't know what to do about these two errors yet ===

<code>
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Error: inotify_add_watch cannot watch folder /home/user/Development/UnrealEngine/Engine/Plugins/Experimental/CharacterAI/Content/
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Warning: Failed to begin reading directory changes for ../../../Engine/Plugins/Experimental/CharacterAI/Content/.
</code>

=== asoundlib error after adding voice and midi modules ===
/home/planeshift/PSUnreal/Plugins/MidiAsset/Source/MidiInterface/Classes/RtMidi.cpp:1449:10: fatal error: 'alsa/asoundlib.h' file not found
#include <alsa/asoundlib.h>

Had to:

> sudo apt-get install libasound2-dev libasound2
==Manual Compile==

===Create and Save the "Blank" project from the Blueprint Tab===

once you have the Editor open and working, create the "Blank" project and save it. We need to do this, otherwise we will not be able to cook content later on and will get an error message stating that some folder ( /Saved/Sandbox/DefaultGame/ ? ) is missing. This seems to be some sort of a bug or perhaps lazy initialization.

#Open the editor
#Click on New Project
# Click on "Blank" ( In the Blueprint tab, not the one in the C++ tab )
# Click "Create Project"
#Save All and exit for now.

===Clone and Import the psunreal project:===

Get the svn password and the link from Talad. We are going to download the source and put it into the UnrealEngine directory in order to work around yet another bug. After that, we run GenerateProjectFiles.sh once more to add our project to The Makefile.

<code>
cd ~/Development/UnrealEngine/
svn co svn://super.secret.source.path
</code>

we now have ~/Development/UnrealEngine/psunreal. Run the script below to add our project to the Makefile

<code>
./GenerateProjectFiles.sh
</code>

===Open the PSUNREAL project ( finally.. )===

Click File and then Open Project

You will now see the Blank Project and another named MyProject2 ( that's ours )

Click MyProject2 and then open.

You will get another error message:

There are a few errors about missing Android stuff. I don't we need to worry about this.
<code>
[2015.05.03-08.14.15:716][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidRuntimeSettings' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.

[2015.05.03-08.14.15:719][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidPlatformEditor' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.
</code>

For this missing font, we need to repeat the solution above for Roboto-Italic...

<code>
[2015.05.03-08.14.18:469][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Regular.ttf'
[2015.05.03-08.14.18:471][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Bold.ttf'
</code>

===Building, cooking, packaging... oh my.===

So when you build the game there are several things that need to be built:
*shaders
* the code itself
*some lighting resources

You also need to cook the game's content. This means, you are taking all the art, models, textures, etc.. and converting them into a format that the Unreal engine likes. When you go to build the game for another platform - like an android tablet, pc, mac, or whatever, it will convert those "assets" into a format that is more suitable for the target platform.

After you have cooked the content, you should be able to "package" the game. This simply means, you are setting up the files that will be distributed to the client. They will be formatted to work on the target platform and will be laid out into a directory structure.

===Setting up the server===

Follow the instructions in the "Planeshift Compiling Guide" for setting up the mysql database. You'll need to set it up ( either Mariadb or mysql ) and then run a few scripts to get a planeshift user account set up along with some needed data.

When you run the new unreal server ( make target is: MyProject2Server ), it will attempt to connect to the DB. If successful, you will see something like this in the shell that you ran it from:

<code>
[2015.05.02-08.25.58:359][ 0]LogWorld: Bringing up level for play took: 0.000330
[2015.05.02-08.25.58:359][ 0]LogTemp:Warning: Hello world! BEFORE
[2015.05.02-08.25.58:359][ 0]LogTemp: Hello world! AFTER 4 5
[2015.05.02-08.25.58:371][ 0]LOG_STARTUP:Display: Database Host: 'localhost' User: 'planeshift' Databasename: 'planeshift' Port: 128880496
[2015.05.02-08.25.58:559][ 0]LOG_STARTUP:Display: Started Database with version: 1279
</code>

You can also check to see if the server connected to your mysql or mariadb server by making a simple script

<code>

SELECT SUBSTRING_INDEX(host, ':', 1) AS host_short,
GROUP_CONCAT(DISTINCT USER) AS users,
COUNT(*)
FROM information_schema.processlist
GROUP BY host_short
ORDER BY COUNT(*),
host_short;

</code>

Save this to a file called show_connected.sql and then log into the db and run it from there.

<code>
$ mysql -u root -pMYSECRETPASSWORD
Welcome to the MariaDB monitor. Commands end with ; or \g.
Your MariaDB connection id is 51
Server version: 5.5.41-MariaDB-1ubuntu0.14.10.1 (Ubuntu)
Copyright (c) 2000, 2014, Oracle, MariaDB Corporation Ab and others.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MariaDB $ \. show_connected.sql
+------------+-----------------+----------+
| host_short | users | COUNT(*) |
+------------+-----------------+----------+
| localhost | planeshift,root | 2 |
+------------+-----------------+----------+
1 row in set (0.03 sec)

</code>

===cmake command for libzip===
mkdir build
cd build
>cmake -DZLIB_LIBRARY=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/lib/Linux/x86_64-unknown-linux-gnu/libz_fPIC.a -DZLIB_INCLUDE_DIR=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/include/Linux/x86_64-unknown-linux-gnu/ -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..

===build xdelta===
cd xdelta/xdelta3
rm -rf build
mkdir build
cd build

I had to add -fPIC to this line:
vi CMakeLists.txt

set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC -DSIZEOF_SIZE_T=8 -DSIZEOF_UNSIGNED_LONG=8 -DSIZEOF_UNSIGNED_LONG_LONG=8")

cmake ..
cmake --build .

Building PSUnreal on Linux

2026-08-30T10:27:15Z

Talad: /* Installation steps */

== Building UEEditor on Linux ==

=== References ===

https://docs.unrealengine.com/en-US/Platforms/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/index.html

https://www.ue4community.wiki/Legacy/Running_On_Linux
https://www.ue4community.wiki/Legacy/Cooking_On_Linux

[[Some Linux commands]]

=== Installation steps ===

# Register for a free account at github.com
# Per the first link above, join the unreal project

'''Be sure to install all dependencies first'''

> sudo apt-key update
> sudo apt-get update
> sudo apt-get upgrade
> sudo apt-get install git

get source code. On Linux I had to use the SSH git URL. I had to create a new key with:
> ssh-keygen -t ed25519 -C my@email.it
> ssh-add ~/.ssh/id_ed25519
> cat ~/.ssh/id_ed25519.pub (and copy the result in github.com under Settings add new SSH Key)
> ssh -T git@github.com (then this command should give you a success result)

> git clone --depth=1 --single-branch -b 5.7.4-release git@github.com:EpicGames/UnrealEngine.git 5.7.4-release

this will create a "5.4.3-release" directory as child of the dir where you run the command

Launch the setup to download '''19.2Gb''' of dependencies
> ./Setup.sh

Generate project files
> ./GenerateProjectFiles.sh

Build UnrealEngine (this builds Shipping)
> make
Build UnrealEngine (this buildings Development)
./Engine/Build/BatchFiles/Linux/Build.sh UnrealEditor Linux Development

== Running the editor ==

Before moving to PlaneShift Unreal, its best to test if the standard Unreal Engine works.

To do this you need to have X available. If you are in a server only configuration, you need to install X.

> sudo apt-get install xinit
> sudo apt-get install ubuntu-desktop

and you need then to start it:

> sudo startx

When you are in X, open a terminal window and

> cd Engine/Binaries/Linux/
> ./UE4Editor

== Building PSUnreal ==

Download the PSUnreal project
> cd \
> svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal

You need to install '''MariaDB Connector''' from: https://mariadb.com/downloads/#connectors

* Select C connector and the linux platform
* PLEASE NOTE UBUNTU 20.4 requires the new version of mariadb connector: mariadb-connector-c-3.1.11-ubuntu-focal-amd64.tar.gz or you will get a libssl1.0 error when running the server.
* Extract in a temporary directory the file you get
tar -xzvf mariadb-connector-c-3.1.7-linux-x86_64.tar.gz

* From the MariaDB extracted directory, copy both <code>lib/</code> and <code>include/</code> (with subfolders) into <code>PSUnreal\ThirdParty\MariaDB\</code>
cp -r * /home/planeshift/PSUnreal/ThirdParty/MariaDB/

* Recompile Wordnet
> cd /home/planeshift/PSUnreal/ThirdParty/Wordnet/
> cd /home/planeshift/disk2/PSUnreal511/ThirdParty/Wordnet/
> gcc -c -fPIC *.h *.c -Wformat-overflow=0
> ar -cvq libWordnet.so *.o
> mv libWordnet.so lib/x64/Wordnet.so

* generate project files
> /home/planeshift/UnrealEngine/GenerateProjectFiles.sh -project="/home/planeshift/PSUnreal/PSUnreal.uproject" -game -engine
> /home/planeshift/disk2/5.1.1-release/GenerateProjectFiles.sh -project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"

* recompile the project
> /home/planeshift/UnrealEngine/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/PSUnreal/PSUnreal.uproject"
> /home/planeshift/disk2/5.1.1-release/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"

* Be sure to have Unreal Engine find all the libraries needed
> export LD_LIBRARY_PATH=/home/planeshift/UnrealEngine/Engine/Binaries/Linux:/home/planeshift/PSUnreal/ThirdParty/MariaDB/lib/mariadb

== Package Development server and client ==
/mnt/nvme/ue/UnrealEngine-4.27/Engine/Build/BatchFiles/RunUAT.sh -ScriptsForProject=<PATH TO PROJECT>.uproject BuildCookRun -project=<PATH TO PROJECT>.uproject -noP4 -clientconfig=Development -serverconfig=Development -utf8output -platform=Linux -server -serverplatform=Linux -targetplatform=Linux -build -cook -allmaps -compressed -stage -archive -unversionedcookedcontent -archivedirectory="<Archive Dir>"

== Troubleshooting ==

=== File couldn't be loaded by the OS===

I got this error:

[2020.05.05-17.04.04:228][ 0]LogCore: Warning: dlopen failed: (null)
[2020.05.05-17.04.04:228][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so' because the file couldn't be loaded by the OS.

So I used this to get the list of libraries he is in need of

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so

and then added the export LD_LIBRARY_PATH mentioned above, and it worked

Same error on PSUpdater module:

[2020.07.03-14.59.50:796][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so' because the file couldn't be loaded by the OS.

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so

I set the environment variable LD_DEBUG and then launch the program
export LD_DEBUG=libs

=== Can't connect to local MySQL server ===

Error: Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

Check your /etc/mysql/my.cnf , and see where is the socket location. for me it was /var/run/mysqld/mysqld.sock , so I added a symbolic link to it.

ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock

=== Some errors that you may encounter along the way ===

You see a file named something like "GitDependencies-crash.log" in your UnrealEngine directory. The contents of the file contains this message:

mono GitDependencies.exe --prompt crashed with return code 134

Solution: Ensure your copy of mono is up to date and rerun the Setup.sh script
At time of writing, I am using mono 3.2.8

Reason - This could be due to an old version of mono, but it seems to happen for other reasons too.

Should probably clean and recompile UEEditor at this point.

=== error while loading shared libraries: libLND.so ===

<code>
user@u13:~/Development/UnrealEngine/Engine/Binaries/Linux$ ./UE4Editor
./UE4Editor: error while loading shared libraries: libLND.so: cannot open shared object file: No such file or directory
</code>

To fix this, copy libLND.so (there are several flavors) from another directory to the Binaries/Linux directory. Do not use a symbolic link, just make a copy of the file. On my installation, a sym link worked in some places but failed in miserably others.

<code>
$ find ../../../../ -name libLND.so -print
../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so
cp ../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so .
</code>

=== Some fonts are in the wrong place. Its important to fix this ===

<code>
[2015.05.03-07.28.52:548][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Slate/Fonts/Roboto-Italic.ttf'
$ find ../../../ -name Roboto-Italic.ttf -print
../../../Engine/Content/Editor/Slate/Fonts/Roboto-Italic.ttf
../../../Engine/Content/Slate/Testing/Fonts/Roboto-Italic.ttf
cp ../../../Engine/Content/Editor/Slate/Fonts/* ../../../Engine/Content/Slate/Fonts/
cp ../../../Engine/Content/Slate/Testing/Fonts/* ../../../Engine/Content/Slate/Fonts/
</code>

=== I don't know what to do about these two errors yet ===

<code>
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Error: inotify_add_watch cannot watch folder /home/user/Development/UnrealEngine/Engine/Plugins/Experimental/CharacterAI/Content/
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Warning: Failed to begin reading directory changes for ../../../Engine/Plugins/Experimental/CharacterAI/Content/.
</code>

=== asoundlib error after adding voice and midi modules ===
/home/planeshift/PSUnreal/Plugins/MidiAsset/Source/MidiInterface/Classes/RtMidi.cpp:1449:10: fatal error: 'alsa/asoundlib.h' file not found
#include <alsa/asoundlib.h>

Had to:

> sudo apt-get install libasound2-dev libasound2
==Manual Compile==

===Create and Save the "Blank" project from the Blueprint Tab===

once you have the Editor open and working, create the "Blank" project and save it. We need to do this, otherwise we will not be able to cook content later on and will get an error message stating that some folder ( /Saved/Sandbox/DefaultGame/ ? ) is missing. This seems to be some sort of a bug or perhaps lazy initialization.

#Open the editor
#Click on New Project
# Click on "Blank" ( In the Blueprint tab, not the one in the C++ tab )
# Click "Create Project"
#Save All and exit for now.

===Clone and Import the psunreal project:===

Get the svn password and the link from Talad. We are going to download the source and put it into the UnrealEngine directory in order to work around yet another bug. After that, we run GenerateProjectFiles.sh once more to add our project to The Makefile.

<code>
cd ~/Development/UnrealEngine/
svn co svn://super.secret.source.path
</code>

we now have ~/Development/UnrealEngine/psunreal. Run the script below to add our project to the Makefile

<code>
./GenerateProjectFiles.sh
</code>

===Open the PSUNREAL project ( finally.. )===

Click File and then Open Project

You will now see the Blank Project and another named MyProject2 ( that's ours )

Click MyProject2 and then open.

You will get another error message:

There are a few errors about missing Android stuff. I don't we need to worry about this.
<code>
[2015.05.03-08.14.15:716][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidRuntimeSettings' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.

[2015.05.03-08.14.15:719][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidPlatformEditor' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.
</code>

For this missing font, we need to repeat the solution above for Roboto-Italic...

<code>
[2015.05.03-08.14.18:469][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Regular.ttf'
[2015.05.03-08.14.18:471][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Bold.ttf'
</code>

===Building, cooking, packaging... oh my.===

So when you build the game there are several things that need to be built:
*shaders
* the code itself
*some lighting resources

You also need to cook the game's content. This means, you are taking all the art, models, textures, etc.. and converting them into a format that the Unreal engine likes. When you go to build the game for another platform - like an android tablet, pc, mac, or whatever, it will convert those "assets" into a format that is more suitable for the target platform.

After you have cooked the content, you should be able to "package" the game. This simply means, you are setting up the files that will be distributed to the client. They will be formatted to work on the target platform and will be laid out into a directory structure.

===Setting up the server===

Follow the instructions in the "Planeshift Compiling Guide" for setting up the mysql database. You'll need to set it up ( either Mariadb or mysql ) and then run a few scripts to get a planeshift user account set up along with some needed data.

When you run the new unreal server ( make target is: MyProject2Server ), it will attempt to connect to the DB. If successful, you will see something like this in the shell that you ran it from:

<code>
[2015.05.02-08.25.58:359][ 0]LogWorld: Bringing up level for play took: 0.000330
[2015.05.02-08.25.58:359][ 0]LogTemp:Warning: Hello world! BEFORE
[2015.05.02-08.25.58:359][ 0]LogTemp: Hello world! AFTER 4 5
[2015.05.02-08.25.58:371][ 0]LOG_STARTUP:Display: Database Host: 'localhost' User: 'planeshift' Databasename: 'planeshift' Port: 128880496
[2015.05.02-08.25.58:559][ 0]LOG_STARTUP:Display: Started Database with version: 1279
</code>

You can also check to see if the server connected to your mysql or mariadb server by making a simple script

<code>

SELECT SUBSTRING_INDEX(host, ':', 1) AS host_short,
GROUP_CONCAT(DISTINCT USER) AS users,
COUNT(*)
FROM information_schema.processlist
GROUP BY host_short
ORDER BY COUNT(*),
host_short;

</code>

Save this to a file called show_connected.sql and then log into the db and run it from there.

<code>
$ mysql -u root -pMYSECRETPASSWORD
Welcome to the MariaDB monitor. Commands end with ; or \g.
Your MariaDB connection id is 51
Server version: 5.5.41-MariaDB-1ubuntu0.14.10.1 (Ubuntu)
Copyright (c) 2000, 2014, Oracle, MariaDB Corporation Ab and others.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MariaDB $ \. show_connected.sql
+------------+-----------------+----------+
| host_short | users | COUNT(*) |
+------------+-----------------+----------+
| localhost | planeshift,root | 2 |
+------------+-----------------+----------+
1 row in set (0.03 sec)

</code>

===cmake command for libzip===
mkdir build
cd build
>cmake -DZLIB_LIBRARY=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/lib/Linux/x86_64-unknown-linux-gnu/libz_fPIC.a -DZLIB_INCLUDE_DIR=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/include/Linux/x86_64-unknown-linux-gnu/ -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..

===build xdelta===
cd xdelta/xdelta3
rm -rf build
mkdir build
cd build

I had to add -fPIC to this line:
vi CMakeLists.txt

set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC -DSIZEOF_SIZE_T=8 -DSIZEOF_UNSIGNED_LONG=8 -DSIZEOF_UNSIGNED_LONG_LONG=8")

cmake ..
cmake --build .

Building PSUnreal on macOS

2026-08-28T15:28:53Z

Talad: /* Compiling Unreal Engine */

== Reference docs ==

* Downloading Unreal Engine source code: https://docs.unrealengine.com/en-US/GettingStarted/DownloadingUnrealEngine/index.html
* Compiling Unreal Engine source code: https://github.com/EpicGames/UnrealEngine/blob/release/README.md

== Compiling Unreal Engine ==

Note: As of 2024, you need ~XXXGB of disk space for a compiled version of the Unreal Engine 5.

* Step 1: Install the latest version of Xcode.
** Install the latest version of [https://itunes.apple.com/us/app/xcode/id497799835 Xcode] from the App Store.
** Install the Command Line Tools by running '''xcode-select --install''' from a Terminal.

* Step 2: Get access to the Unreal Engine source code.
** You must be an Unreal Engine subscriber (if not, open an account there: https://www.unrealengine.com)
** You must have a GitHub account (if not, open an account there: https://github.com)
** Have associated your GitHub account with your Unreal Engine account as described on the [https://www.unrealengine.com/en-US/ue4-on-github UE4 on GitHub page].
** At this point you should be able to access the [https://github.com/EpicGames/UnrealEngine Unreal Engine repository] on GitHub.

* Step 3: Get the Unreal Engine source code.
** On MacI had to use the SSH git URL. I had to create a new key with:
> ssh-keygen -t ed25519 -C my@email.it
> ssh-add --apple-use-keychain ~/.ssh/id_ed25519
> cat ~/.ssh/id_ed25519.pub (and copy the result in github.com under Settings add new SSH Key)
> ssh -T git@github.com (then this command should give you a success result)

> git clone --depth=1 --single-branch -b 5.7.4-release git@github.com:EpicGames/UnrealEngine.git 5.7.4-release
* This will create an '''5.7.4-release''' sub-directory where you run the commands of the next step. Step 4: Prepare the Xcode workspace.
** In the '''UnrealEngine''' directory, run the script '''Setup.command'''. It downloads 19.4GB of dependencies and may take a while.
** At the same location, run the script '''GenerateProjectFiles.command'''. It generates the '''UE5 (Mac).xcworkspace''' Xcode workspace.

* Step 5: Compile Unreal Engine with Xcode.
** Load the '''UE5 (Mac).xcworkspace''' into Xcode.
** Select the "Project Navigator" icon (looks like a folder icon) on the left, then click on "Unreal Editor (Mac)" , the right panel will populate.
** Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
** Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
** Select the '''ShaderCompileWorker > My Mac''' target in the title bar, then build with '''Product > Build''' menu item.
** Click on the last icon "Report Navigator" , looks like a document, you can see here the log of the build. Wait for the build to complete.
** Select the '''UnrealEditor > My Mac''' target, and build again.
** Compiling may take a long time, depending on your system specs.
** After the compilation finishes, select the 'Product > Run' menu item to load the editor.

* Step 6: set xcode tools
** Open Xcode and go to Preferences>Locations and set the Command Line Tools or Unreal will give this error: "Xcode is not installed on this Mac ... Falling back to runtime text shaders, which are slower. "

* Launch the Editor to test if it works
** You can launch the editor with \UnrealEngine\Engine\Binaries\Mac\UE4Editor.app

If you get this error:
xcode command codesign failed with exit code 1
Check the error log detail, I had some old files in /Users/luke/UnrealEngine/Engine/Binaries/Mac/UE4Editor.app/Contents/MacOS/ which I had to delete, and then it worked.

== Obtaining PSUnreal ==

* Create PSUnreal dir
> cd \
> mkdir PSUnreal

* Install macports and svn command line
** Install macports: Download https://distfiles.macports.org/MacPorts/MacPorts-2.6.2-10.15-Catalina.pkg
> sudo port install subversion

Get the sources from the Planeshift repository.
* Open a Terminal and go to you home directory with
> '''cd ~'''. We will build from there; adapt if needed.

* Checkout the sources from the PS Unreal repository with:
> svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal

== Building dependencies ==

=== MariaDB connector ===

* Build the MariaDB Connector from source.
** Install prerequisites: sudo port install cmake jemalloc judy openssl boost gnutls
** Download the MariaDB Connector for C (source code version) from https://downloads.mariadb.com/Connectors/c/connector-c-3.3.10/mariadb-connector-c-3.3.10-src.tar.gz
** In your home directory: tar -xvf mariadb-connector-c-3.3.10-src.tar.gz.
**From your terminal, '''cd ~/mariadb-connector-c-3.3.10-src''', to go to the directory that contain the MariaDB Connector sources.
** move the sources in PSUnreal: mv * /Users/luke/PSUnreal511/ThirdParty/MariaDB
**cd /Users/luke/PSUnreal511/ThirdParty/MariaDB
** Generate the makefiles with '''cmake . '''.
** Build and install the connector in your PSUnreal source tree with '''make all install'''.
**file /Users/luke/PSUnreal511/ThirdParty/MariaDB/libmariadb/libmariadb.dylib (check if it's arm64 or x86_64)

=== Wordnet ===

* Build Wordnet
> cd /Users/luke/PSUnreal511/ThirdParty/Wordnet
Compiles the library for arm64 architecture:
> gcc -shared -o Wordnet.dylib -fPIC *.c
Compiles the library for x86_64 architecture:
> gcc -shared -arch x86_64 -o Wordnet.dylib -fPIC *.c
Compiles for arm64
> gcc -shared -arch arm64 -o Wordnet.dylib -fPIC *.c

=== libzip ===

* Obtain https://libzip.org with:
> git clone git@github.com:nih-at/libzip.git
* In the newly created '''libzip''' directory, create a '''build''' sub-directory.
> cd libzip
> mkdir build
* In '''libzip/build''' run '''cmake''' as follows (this turns off all the options we do not need):
> cd build
> cmake -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..
* Then build with:
> make --build .
* Copy the '''libzip''' library and headers to the third party subfolder of PSUnreal.
> cp lib/libzip.5.3.dylib PSUnreal/ThirdParty/Libzip/Libraries/Mac/libzip.5.dylib
> cp ../lib/zip.h PSUnreal/ThirdParty/Libzip/Includes/.
> cp zipconf.h PSUnreal/ThirdParty/Libzip/Includes/Mac/.
* Finalize the library.
> cd PSUnreal/ThirdParty/Libzip/Libraries/Mac
> install_name_tool

=== Create a signing certificate ===
(OPTIONAL) If you need to create a signing certificate, you can do it by opening XCode, click on the top menu "XCode" then "Preferences", then Accounts, and Manage Certificates.

== Build PS Unreal. ==
* Generate project files (NO QUOTATION MARKS on -project option):
> /Volumes/DATA-2TB/5.4.3-release/GenerateProjectFiles.command -project=/Users/luke/PSUnreal511/PSUnreal.uproject -game
* The resulting files should be directories, not files, like:
drwxr-xr-x@ 5 luke staff 160 Aug 24 18:10 PSUnreal (Mac).xcworkspace
*Launch XCode and open PSUnreal.xcworkspace
* Select the UE4 blue icon for the project on the left, and click on "Project Navigator" icon (looks like a folder icon)
* Click on "Signing and Capabilities" and leave "Team" empty, "Sign to run locally"
* Click on "Build Settings", search "Signing Identity", remove everything there by clicking on "Others" and clearing the field. Or use Sign Run Locally. This way we disable the signing completely.
* Build with Product > Build menu item.

== Finalize PS Unreal ==

Note: The following should be added to the build process. To be done by hand for now.

* Copy '''Wordnet.dylib''', '''libmariadb.3.dylib''', '''libmariadb.dylib''' to inside folder '''./PSUnreal.app/Content/MacOS'''.
* Modify the library paths in the main '''PSUnreal''' executable as follows:
** '''install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib @loader_path/libmariadb.3.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
** '''install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib ./PSUnreal.app/Contents/MacOS/PSUnreal'''
* Add file '''serverlist.xml''' to inside folder '''./PSUnreal.app/Contents/UE4/PSUnreal/Config'''. ('''Config''' directory needs to be created)
* Finally, you can sign the app bundle with the following '''codesign -s <email> PSUnreal.app''', where <email> is the E-mail for your Apple Development ID (check it in your Keychain Access app > My Certificates).

== Troubleshooting ==

=== PSLauncher codesign error ===
I got this error while trying to build PSLauncher:
/usr/bin/codesign --force --sign - --entitlements /Users/luke/PSLauncher511/Binaries/PSLauncher\ $Mac$.build/Mac/PSLauncher.build/PSLauncher-Mac-Shipping.app.xcent --timestamp\=none --generate-entitlement-der /Users/luke/PSLauncher511/Binaries/Mac/PSLauncher-Mac-Shipping.app
/Users/luke/PSLauncher511/Binaries/Mac/PSLauncher-Mac-Shipping.app: code object is not signed at all
In subcomponent: /Users/luke/PSLauncher511/Binaries/Mac/PSLauncher-Mac-Shipping.app/Contents/MacOS/libzip.5.dylib
Command CodeSign failed with a nonzero exit code
** BUILD FAILED **
The following build commands failed:
CodeSign /Users/luke/PSLauncher511/Binaries/Mac/PSLauncher-Mac-Shipping.app (in target 'PSLauncher' from project 'PSLauncher (Mac)')
(1 failure)
ERROR: Failed to finalize the .app with Xcode. Check the log for more information
I had to recompile the libzip located in ThirdParty and codesign it, otherwise when it's copied over the PSLauncher install during the build it fails on codesign.

=== XCode 16.0 ===
After an update to Xcode 16.0 , I got this error while building UE 5.4.3 from Xcode
Platform Mac is not a valid platform to build.
I downgraded my XCode to 15.4 by downloading it from this page:

https://developer.apple.com/download/all/?q=xcode

=== Undecorated configuration ===
When building with PSUnreal.Target.cs modified with :
UndecoratedConfiguration = UnrealTargetConfiguration.Shipping;
I get this error

fatal error: cannot open file '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/c++/v1/__functional/operations.h': No such file or directory

The only way in 5.4.3 is to comment out the UndecoratedConfiguration line.

=== Could not create socket ===
https://forums.unrealengine.com/t/ue-5-4-3-macosx-shipping-build-could-not-create-socket-for-bind-address-and-error-initializing-network-layer/1990023

For some reason the "PSUnrealClient (Mac)" project in XCode, under "Signing & Capabilities" -> "App Sandbox" had "Incoming/Outgoing Connections" disabled. Must be enabled.

=== arm64 vs x86_64 ===
When you are compiling you will see a tag on each line saying if you are compiling for arm64 [Apple] or for x86_64 [Intel], example:
[1681/3233] Compile '''[Apple]''' Module.LandscapeEditor.4.cpp
vs
[1681/3233] Compile '''[Intel]''' Module.LandscapeEditor.4.cpp
you can change the way the solution is compiled by using the -specifiedarchitecture and -architecture flags on RunUAT. For some reason after 5.4 upgrade the -architecture was not enough anymore, and I had to add also -specifiedarchitecture

Example:
-specifiedarchitecture=x86_64 -platform=Mac -architecture=x86_64

=== Unable to load module ===
If there is a problem like:
Unable to load module '/Users/luke/PSUnreal/Binaries/Mac/UE4Editor-PSUnreal.dylib' because the file couldn't be loaded by the OS.
OR
The game module 'PSUnreal' could not be loaded. There may be an operating system error, the module may not be properly set up....

You can use otool to see the dependencies
otool -L /Users/luke/PSUnreal/Binaries/Mac/UE4Editor-PSUnreal.dylib

If the problem is Wordnet then use this command:
install_name_tool -change Wordnet.dylib @loader_path/Wordnet.dylib /Users/luke/PSUnreal/Binaries/Mac/UE4Editor-PSUnreal.dylib
AND/OR
install_name_tool -change /Users/luke/PSUnreal/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib /Users/luke/PSUnreal511/ThirdParty/MariaDB/libmariadb/libmariadb.3.dylib /Users/luke/PSUnreal511/Binaries/Mac/UnrealEditor-PSUnreal.dylib

After this command you should relaunch RunUAT, but without -build or it will recreate the same problem.

=== Your session has expired ===
While building , RunUAT is trying to read this URL: <nowiki>https://developerservices2.apple.com/services/QH65B2/viewDeveloper.action</nowiki> , but this URL gets a "Your session has expired. Please log in." message. This is the error in the log
DVTPortal: Error: Error Domain=DVTPortalServiceErrorDomain Code=1100 "Your session has expired. Please log in."
The problem seems to happen only if you run the build command from ssh, running it directly on the Mac works well.

=== Info.plist During compilation from XCode you may get this error: ===
Cannot code sign because the target does not have an Info.plist file and one is not being generated automatically. Apply an Info.plist file to the target using the INFOPLIST_FILE build setting or generate one automatically by setting the GENERATE_INFOPLIST_FILE build setting to YES (recommended).
Click on the left on the Folder icon, then PSUnreal, then on the right select "Build Settings", search for "Generate Info.plist File" and set it to YES.

During compilation from XCode you may get this error:
/Users/luke/UnrealEngine/Engine/Source/Runtime/Core/Public/Math/BigInt.h:964:9: variable 'Result' set but not used [-Werror,-Wunused-but-set-variable]
In this case open
Engine/Source/Programs/UnrealBuildTool/Platform/Mac/MacToolChain.cs
and change line 218 to this:
Result += " -Wall -Werror -Wno-error=unused-but-set-variable";
I got this error after XCode was updated to 13.0 , previous was 12.3.
/Users/luke/UnrealEngine/clang:1:1: no such sysroot directory: '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk' [-Werror,-Wmissing-sysroot]
a clean build of everything, including Unreal Engine fixed this error.

AutomationTool exiting with ExitCode=25 (Error_UnknownCookFailure)

This error was not saying anything in the log file, so I had to
tail -f /Volumes/DATA-2TB/5.1.1-release/Engine/Programs/AutomationTool/Saved/Cook-2023.02.19-23.53.38.txt
and in that file the real error showed: "The game module 'PSUnreal' could not be loaded. " which is the otool thing.

=== Compilation on M1 hardware ===
ld: warning: ignoring file /Users/luke/UnrealEngine/Engine/Source/ThirdParty/rd_route/lib/Mac/librd_route.a, building for macOS-arm64 but attempting to link with file built for macOS-x86_64
ld: warning: ignoring file /Users/luke/UnrealEngine/Engine/Binaries/Mac/UnrealHeaderTool-BuildSettings.dylib, building for macOS-arm64 but attempting to link with file built for macOS-x86_64
Undefined symbols for architecture arm64:
"BuildSettings::GetBuildDate()", referenced from:
FApp::GetBuildDate() in Module.Core.9_of_15.cpp.o
"BuildSettings::GetBranchName()", referenced from:
FApp::GetBranchName() in Module.Core.9_of_15.cpp.o
FGlobalEngineVersions::FGlobalEngineVersions() in Module.Core.10_of_15.cpp.o
"BuildSettings::GetBuildVersion()", referenced from:
FApp::GetBuildVersion() in Module.Core.9_of_15.cpp.o
FApp::PrintStartupLogMessages() in Module.Core.9_of_15.cpp.o
"BuildSettings::IsPromotedBuild()", referenced from:
FApp::GetEngineIsPromotedBuild() in Module.Core.9_of_15.cpp.o
"BuildSettings::IsLicenseeVersion()", referenced from:
FMacCrashContext::GenerateCrashInfoAndLaunchReporter() const in Module.Core.7_of_15.cpp.o
FMacCrashContext::GenerateEnsureInfoAndLaunchReporter() const in Module.Core.7_of_15.cpp.o
FGlobalEngineVersions::FGlobalEngineVersions() in Module.Core.10_of_15.cpp.o
"BuildSettings::GetCurrentChangelist()", referenced from:
FGlobalEngineVersions::FGlobalEngineVersions() in Module.Core.10_of_15.cpp.o
"BuildSettings::GetCompatibleChangelist()", referenced from:
FNetworkVersion::GetNetworkCompatibleChangelist() in Module.Core.10_of_15.cpp.o
FGlobalEngineVersions::FGlobalEngineVersions() in Module.Core.10_of_15.cpp.o
ld: symbol(s) not found for architecture arm64
https://forums.unrealengine.com/t/building-shipping-package-on-mac-m1-for-intel-architecture/685206

Was giving me again the problem, what I did was to go on the macmini, and recompile UnrealHeaderTool forcing x86_64 architecture, then the compilation worked

Exceeded max memory on all configured triggers
Change BaseEditor.ini

MemoryMinFreePhysical=1024

MemoryMinFreeVirtual=1024

Detected max mem exceeded - forcing shader compilation flush
MemoryMinFreePhysical=256

== Running a local server ==

=== Prepare the server database ===

* Connect to your database as root, create the planeshift database and user.

> mysql -u root -p

mysql> CREATE DATABASE planeshift;
mysql> CREATE USER 'planeshift'@'localhost' IDENTIFIED WITH mysql_native_password BY 'planeshift';
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO 'planeshift'@'localhost';
mysql> quit

* Connect to the database as planeshift, populate the database (adapt psunreal_mysql_XXXXXXXX.sql to the currently available file).

> cd PSUnreal\Scripts
> mysql -u planeshift -pplaneshift

mysql> USE planeshift;
mysql> SOURCE psunreal_mysql_XXXXXXXX.sql;
mysql> quit

* If you need to upgrade your database, perform the following as root, and re-populate the database as done above.

> mysql -u root -p

mysql> DROP DATABASE planeshift;
mysql> CREATE DATABASE planeshift;
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO 'planeshift'@'localhost';
mysql> quit

Building PSUnreal on Linux

2026-08-28T15:27:22Z

Talad: /* References */

== Building UEEditor on Linux ==

=== References ===

https://docs.unrealengine.com/en-US/Platforms/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/index.html

https://www.ue4community.wiki/Legacy/Running_On_Linux
https://www.ue4community.wiki/Legacy/Cooking_On_Linux

[[Some Linux commands]]

=== Installation steps ===

# Register for a free account at github.com
# Per the first link above, join the unreal project

'''Be sure to install all dependencies first'''

> sudo apt-key update
> sudo apt-get update
> sudo apt-get upgrade
> sudo apt-get install git

get source code. On Linux I had to use the SSH git URL. I had to create a new key with:
> ssh-keygen -t ed25519 -C my@email.it
> ssh-add ~/.ssh/id_ed25519
> cat ~/.ssh/id_ed25519.pub (and copy the result in github.com under Settings add new SSH Key)
> ssh -T git@github.com (then this command should give you a success result)

> git clone --depth=1 --single-branch -b 5.7.4-release git@github.com:EpicGames/UnrealEngine.git 5.7.4-release

this will create a "5.4.3-release" directory as child of the dir where you run the command

Launch the setup to download '''19.2Gb''' of dependencies
> ./Setup.sh

Generate project files
> ./GenerateProjectFiles.sh

Build UnrealEngine
> make

== Running the editor ==

Before moving to PlaneShift Unreal, its best to test if the standard Unreal Engine works.

To do this you need to have X available. If you are in a server only configuration, you need to install X.

> sudo apt-get install xinit
> sudo apt-get install ubuntu-desktop

and you need then to start it:

> sudo startx

When you are in X, open a terminal window and

> cd Engine/Binaries/Linux/
> ./UE4Editor

== Building PSUnreal ==

Download the PSUnreal project
> cd \
> svn co svn://xxx.xxx.xxx/psunreal/PSUnreal PSUnreal

You need to install '''MariaDB Connector''' from: https://mariadb.com/downloads/#connectors

* Select C connector and the linux platform
* PLEASE NOTE UBUNTU 20.4 requires the new version of mariadb connector: mariadb-connector-c-3.1.11-ubuntu-focal-amd64.tar.gz or you will get a libssl1.0 error when running the server.
* Extract in a temporary directory the file you get
tar -xzvf mariadb-connector-c-3.1.7-linux-x86_64.tar.gz

* From the MariaDB extracted directory, copy both <code>lib/</code> and <code>include/</code> (with subfolders) into <code>PSUnreal\ThirdParty\MariaDB\</code>
cp -r * /home/planeshift/PSUnreal/ThirdParty/MariaDB/

* Recompile Wordnet
> cd /home/planeshift/PSUnreal/ThirdParty/Wordnet/
> cd /home/planeshift/disk2/PSUnreal511/ThirdParty/Wordnet/
> gcc -c -fPIC *.h *.c -Wformat-overflow=0
> ar -cvq libWordnet.so *.o
> mv libWordnet.so lib/x64/Wordnet.so

* generate project files
> /home/planeshift/UnrealEngine/GenerateProjectFiles.sh -project="/home/planeshift/PSUnreal/PSUnreal.uproject" -game -engine
> /home/planeshift/disk2/5.1.1-release/GenerateProjectFiles.sh -project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"

* recompile the project
> /home/planeshift/UnrealEngine/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/PSUnreal/PSUnreal.uproject"
> /home/planeshift/disk2/5.1.1-release/Engine/Build/BatchFiles/Linux/Build.sh PSUnrealEditor Linux Development -Project="/home/planeshift/disk2/PSUnreal511/PSUnreal.uproject"

* Be sure to have Unreal Engine find all the libraries needed
> export LD_LIBRARY_PATH=/home/planeshift/UnrealEngine/Engine/Binaries/Linux:/home/planeshift/PSUnreal/ThirdParty/MariaDB/lib/mariadb

== Package Development server and client ==
/mnt/nvme/ue/UnrealEngine-4.27/Engine/Build/BatchFiles/RunUAT.sh -ScriptsForProject=<PATH TO PROJECT>.uproject BuildCookRun -project=<PATH TO PROJECT>.uproject -noP4 -clientconfig=Development -serverconfig=Development -utf8output -platform=Linux -server -serverplatform=Linux -targetplatform=Linux -build -cook -allmaps -compressed -stage -archive -unversionedcookedcontent -archivedirectory="<Archive Dir>"

== Troubleshooting ==

=== File couldn't be loaded by the OS===

I got this error:

[2020.05.05-17.04.04:228][ 0]LogCore: Warning: dlopen failed: (null)
[2020.05.05-17.04.04:228][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so' because the file couldn't be loaded by the OS.

So I used this to get the list of libraries he is in need of

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUnreal.so

and then added the export LD_LIBRARY_PATH mentioned above, and it worked

Same error on PSUpdater module:

[2020.07.03-14.59.50:796][ 0]LogModuleManager: Warning: ModuleManager: Unable to load module '/home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so' because the file couldn't be loaded by the OS.

ldd /home/planeshift/PSUnreal/Binaries/Linux/libUE4Editor-PSUpdater.so

I set the environment variable LD_DEBUG and then launch the program
export LD_DEBUG=libs

=== Can't connect to local MySQL server ===

Error: Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

Check your /etc/mysql/my.cnf , and see where is the socket location. for me it was /var/run/mysqld/mysqld.sock , so I added a symbolic link to it.

ln -s /var/run/mysqld/mysqld.sock /tmp/mysql.sock

=== Some errors that you may encounter along the way ===

You see a file named something like "GitDependencies-crash.log" in your UnrealEngine directory. The contents of the file contains this message:

mono GitDependencies.exe --prompt crashed with return code 134

Solution: Ensure your copy of mono is up to date and rerun the Setup.sh script
At time of writing, I am using mono 3.2.8

Reason - This could be due to an old version of mono, but it seems to happen for other reasons too.

Should probably clean and recompile UEEditor at this point.

=== error while loading shared libraries: libLND.so ===

<code>
user@u13:~/Development/UnrealEngine/Engine/Binaries/Linux$ ./UE4Editor
./UE4Editor: error while loading shared libraries: libLND.so: cannot open shared object file: No such file or directory
</code>

To fix this, copy libLND.so (there are several flavors) from another directory to the Binaries/Linux directory. Do not use a symbolic link, just make a copy of the file. On my installation, a sym link worked in some places but failed in miserably others.

<code>
$ find ../../../../ -name libLND.so -print
../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so
cp ../../../../UnrealEngine/Engine/Source/ThirdParty/LinuxNativeDialogs/UELinuxNativeDialogs/lib/Linux/x86_64-unknown-linux-gnu/libLND.so .
</code>

=== Some fonts are in the wrong place. Its important to fix this ===

<code>
[2015.05.03-07.28.52:548][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Slate/Fonts/Roboto-Italic.ttf'
$ find ../../../ -name Roboto-Italic.ttf -print
../../../Engine/Content/Editor/Slate/Fonts/Roboto-Italic.ttf
../../../Engine/Content/Slate/Testing/Fonts/Roboto-Italic.ttf
cp ../../../Engine/Content/Editor/Slate/Fonts/* ../../../Engine/Content/Slate/Fonts/
cp ../../../Engine/Content/Slate/Testing/Fonts/* ../../../Engine/Content/Slate/Fonts/
</code>

=== I don't know what to do about these two errors yet ===

<code>
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Error: inotify_add_watch cannot watch folder /home/user/Development/UnrealEngine/Engine/Plugins/Experimental/CharacterAI/Content/
[2015.05.03-07.29.12:524][ 0]LogDirectoryWatcher:Warning: Failed to begin reading directory changes for ../../../Engine/Plugins/Experimental/CharacterAI/Content/.
</code>

=== asoundlib error after adding voice and midi modules ===
/home/planeshift/PSUnreal/Plugins/MidiAsset/Source/MidiInterface/Classes/RtMidi.cpp:1449:10: fatal error: 'alsa/asoundlib.h' file not found
#include <alsa/asoundlib.h>

Had to:

> sudo apt-get install libasound2-dev libasound2
==Manual Compile==

===Create and Save the "Blank" project from the Blueprint Tab===

once you have the Editor open and working, create the "Blank" project and save it. We need to do this, otherwise we will not be able to cook content later on and will get an error message stating that some folder ( /Saved/Sandbox/DefaultGame/ ? ) is missing. This seems to be some sort of a bug or perhaps lazy initialization.

#Open the editor
#Click on New Project
# Click on "Blank" ( In the Blueprint tab, not the one in the C++ tab )
# Click "Create Project"
#Save All and exit for now.

===Clone and Import the psunreal project:===

Get the svn password and the link from Talad. We are going to download the source and put it into the UnrealEngine directory in order to work around yet another bug. After that, we run GenerateProjectFiles.sh once more to add our project to The Makefile.

<code>
cd ~/Development/UnrealEngine/
svn co svn://super.secret.source.path
</code>

we now have ~/Development/UnrealEngine/psunreal. Run the script below to add our project to the Makefile

<code>
./GenerateProjectFiles.sh
</code>

===Open the PSUNREAL project ( finally.. )===

Click File and then Open Project

You will now see the Blank Project and another named MyProject2 ( that's ours )

Click MyProject2 and then open.

You will get another error message:

There are a few errors about missing Android stuff. I don't we need to worry about this.
<code>
[2015.05.03-08.14.15:716][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidRuntimeSettings' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.

[2015.05.03-08.14.15:719][ 0]LogModuleManager:Warning: ModuleManager: Unable to load module 'AndroidPlatformEditor' because the file '/home/user/Development2/UnrealEngine/Engine/Binaries/Linux/' was not found.
</code>

For this missing font, we need to repeat the solution above for Roboto-Italic...

<code>
[2015.05.03-08.14.18:469][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Regular.ttf'
[2015.05.03-08.14.18:471][ 0]LogSlate:Warning: Failed to load font data from '../../../Engine/Content/Editor/Slate/Fonts/Roboto-Bold.ttf'
</code>

===Building, cooking, packaging... oh my.===

So when you build the game there are several things that need to be built:
*shaders
* the code itself
*some lighting resources

You also need to cook the game's content. This means, you are taking all the art, models, textures, etc.. and converting them into a format that the Unreal engine likes. When you go to build the game for another platform - like an android tablet, pc, mac, or whatever, it will convert those "assets" into a format that is more suitable for the target platform.

After you have cooked the content, you should be able to "package" the game. This simply means, you are setting up the files that will be distributed to the client. They will be formatted to work on the target platform and will be laid out into a directory structure.

===Setting up the server===

Follow the instructions in the "Planeshift Compiling Guide" for setting up the mysql database. You'll need to set it up ( either Mariadb or mysql ) and then run a few scripts to get a planeshift user account set up along with some needed data.

When you run the new unreal server ( make target is: MyProject2Server ), it will attempt to connect to the DB. If successful, you will see something like this in the shell that you ran it from:

<code>
[2015.05.02-08.25.58:359][ 0]LogWorld: Bringing up level for play took: 0.000330
[2015.05.02-08.25.58:359][ 0]LogTemp:Warning: Hello world! BEFORE
[2015.05.02-08.25.58:359][ 0]LogTemp: Hello world! AFTER 4 5
[2015.05.02-08.25.58:371][ 0]LOG_STARTUP:Display: Database Host: 'localhost' User: 'planeshift' Databasename: 'planeshift' Port: 128880496
[2015.05.02-08.25.58:559][ 0]LOG_STARTUP:Display: Started Database with version: 1279
</code>

You can also check to see if the server connected to your mysql or mariadb server by making a simple script

<code>

SELECT SUBSTRING_INDEX(host, ':', 1) AS host_short,
GROUP_CONCAT(DISTINCT USER) AS users,
COUNT(*)
FROM information_schema.processlist
GROUP BY host_short
ORDER BY COUNT(*),
host_short;

</code>

Save this to a file called show_connected.sql and then log into the db and run it from there.

<code>
$ mysql -u root -pMYSECRETPASSWORD
Welcome to the MariaDB monitor. Commands end with ; or \g.
Your MariaDB connection id is 51
Server version: 5.5.41-MariaDB-1ubuntu0.14.10.1 (Ubuntu)
Copyright (c) 2000, 2014, Oracle, MariaDB Corporation Ab and others.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
MariaDB $ \. show_connected.sql
+------------+-----------------+----------+
| host_short | users | COUNT(*) |
+------------+-----------------+----------+
| localhost | planeshift,root | 2 |
+------------+-----------------+----------+
1 row in set (0.03 sec)

</code>

===cmake command for libzip===
mkdir build
cd build
>cmake -DZLIB_LIBRARY=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/lib/Linux/x86_64-unknown-linux-gnu/libz_fPIC.a -DZLIB_INCLUDE_DIR=/home/planeshift/UnrealEngine/Engine/Source/ThirdParty/zlib/v1.2.8/include/Linux/x86_64-unknown-linux-gnu/ -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF ..

===build xdelta===
cd xdelta/xdelta3
rm -rf build
mkdir build
cd build

I had to add -fPIC to this line:
vi CMakeLists.txt

set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC -DSIZEOF_SIZE_T=8 -DSIZEOF_UNSIGNED_LONG=8 -DSIZEOF_UNSIGNED_LONG_LONG=8")

cmake ..
cmake --build .

Building PSUnreal on Windows

2026-08-23T17:41:53Z

Talad: /* Compiling Unreal Engine */

== Reference docs ==

Check this page as reference: https://wiki.unrealengine.com/Dedicated_Server_Guide_%28Windows_%26_Linux%29

There are two ways to compile and run your project:
* Compiling the editor and then running/debugging the game within the editor. Please note VS breakpoints will work also in this mode. THIS IS THE ONE WE USE AS DEFAULT.
* Compiling the client without editor, and you will then need cooked content (prepared art files). All non-editor builds require cooked content, however, you can run an editor build with the "-game" command line flag to run the game directly using the editor data; please note however that this will be slower than a cooked build as the editor is essentially processing assets on the fly.

== Compiling Unreal Engine ==

High level steps:

* Step 1: Register an account at UnrealEngine and GitHub
* Step 2: Add your GitHub username to in your UnrealEngine profile under your dashboard
* Step 3: Download the source code from UE4 Repo
** list remote branches with: git ls-remote https://github.com/EpicGames/UnrealEngine.git
** get source code with: git clone --depth=1 --single-branch -b 5.4.3-release https://github.com/EpicGames/UnrealEngine.git
** this will create a "Unreal Engine" directory as child of the dir where you run the command
* Step 4: Install Visual Studio 2022, follow [https://docs.unrealengine.com/en-us/Programming/Development/VisualStudioSetup#optionsforanewvisualstudioinstallation these instructions] to get the right components in your Visual Studio
* Step 5: Run Setup.bat to download and install the prerequisites
* Step 6: Run GenerateProjectFiles.bat to make project files
** if it complains about windows 8.1 sdk, just install it from [https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk here]
** If you get the error "The reference assemblies for framework ".NETFramework,Version=v4.6.2" were not found." just install it from [https://www.microsoft.com/en-us/download/details.aspx?id=53321 here]
* Step 7: If you dont have it yet, you need to make an account to login to Visual Studio.
* Step 8: Launch Visual Studio, open UE5.sln and Build Unreal Engine 5 with Development Editor configuration and Win64 Platform
* Step 9: Copy F:\UnrealEngine\Engine\Source\ThirdParty\zlib\v1.2.8\lib\Win64\VS2015\zlib.dll to F:\Unreal Projects\MyProject2\PSUnreal\Binaries\Win64
* Step 10: Run the UnrealEditor.exe from Engine\Binaries\Win64\ subdirectory

== Compiling PSUnreal ==

You need to install MariaDB Connector from: https://mariadb.com/downloads/#connectors

* Select C connector , version 3.3.1GA and MS Windows (64-bit) as platform
* It will install it in C:\Program Files\MariaDB\MariaDB Connector C 64-bit
* From the MariaDB install directory, copy both lib/ and include/ (with subfolders) into PSUnreal\ThirdParty\MariaDB\

Compile Wordnet
* Open PSUnreal\ThirdParty\Wordnet\Wordnet.sln with Visual Studio
* Click on Compile
* Copy this file: PSUnreal\ThirdParty\Wordnet\x64\Debug\Wordnet.lib in PSUnreal\ThirdParty\Wordnet\lib\x64\Wordnet.lib

In this mode you will use the Editor to run/debug the game

* Generate project files, by right clicking on PSUnreal.uproject and "Generate Visual Studio project files"
* Open Visual Studio '''2017'''
* Open PSUnreal.sln
* Be sure you have PSUnreal selected as startup project
[[File:Psunreal compile1.png|400px]]

* Select "PSUnreal" project from the left tree view and "DebugGame Editor" as configuration from the top dropdown
[[File:Psunreal compile2.png]]
* NOTE: DebugGame configuration builds the engine as optimized, but leaves the game code debuggable. This configuration is ideal for debugging only game modules.
* Compile

== Preparing the server ==

* Install mysql server and launch it
* Create the PlaneShift database
> mysql -u username -ppassword

* IF you get 'mysql' is not recognized command, means windows cannot find it. Do the following
** press start, type "advanced setting", the click on "View advanced system settings"
** Click on "Environment Variables" at the bottom
** Click on PATH line, end "Edit".
** Then click on "New" to add a new element in the PATH variable
** Copy paste the directory where your mysql.exe is , for me is "F:\Develop\MySQL\MySQL Server 5.5\bin"
** Click on OK on both windows to apply
** open A NEW command prompt, now it will work

The default username is root with no password.

Then from within mysql:

mysql> create database planeshift;
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO planeshift@localhost IDENTIFIED BY 'planeshift';
mysql> quit

> cd PSUnreal\Scripts
> mysql -u planeshift -pplaneshift

mysql> use planeshift;
mysql> source psunreal_mysql_20200401.sql;
mysql> quit

* To test if you can connect to your database install: https://dbeaver.io/
* Provide the connect information : locahost , port 3306, you should see the planeshift schema with a set of tables.

== Launching the server and client ==

There are different ways to launch the client in debug mode:

1) PREFERRED. PSUnreal\Scripts\client.bat (you may need to adapt the path to your installation)

2) From Visual Studio
* Select the DebugGameEditor configuration
* From VS properties on PSUnreal add command line -debug -game
* It will launch directly without opening the editor app

3) From Visual Studio with the Editor first
* Select the DebugGameEditor configuration
* From VS properties on PSUnreal remove -game from command line
* It will launch the Editor, then you press "Play" in the editor. The breakpoints placed in VS are working as expected.

If you want to launch the server:
1) PREFERRED. Use PSUnreal\Scripts\server.bat (you may need to adapt the path to your installation)

2) from VS:
* Select the "DebugGame Editor" configuration (if you select Development Editor then the Editor will start instead of the server)
* From VS properties on PSUnreal , select "Debugging" and then add this in the command line: -server -log
* The resulting property will be like: "$(SolutionDir)$(ProjectName).uproject" -server -log
* It will launch directly without going through the editor

== Updating your database ==

From time to time a new database is posted under \Scripts, example: psunreal_mysql_20200401.sql

To update your database you need to:

> cd PSUnreal\Scripts
> mysql -u root -p

mysql> drop database planeshift;
mysql> create database planeshift;
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO planeshift@localhost IDENTIFIED BY 'planeshift';
mysql> quit

> mysql -u planeshift -pplaneshift

mysql> use planeshift;
mysql> source psunreal_mysql_20200401.sql;
mysql> quit

== Troubleshooting ==

If you need to debug the server or the client in Visual Studio:

# Keep the configuration "DebugGame Editor"
# Right click on PSUnreal project -> Properties
# Select the "Debugging" category
# To debug the client add -game to the "Command Arguments"
# To debug the server add -server to the "Command Arguments"

[[File:Vs_debug.png|500px]]

Running the PSLauncher I got this error:
Assetion failed: GraphicsContext. There is no active graphics context on this command list. There may be a missing call to Switchpipeline().
It was caused by this line in Target.cs
bUseChecksInShipping = true;
seems to be broken in UE5

=== GetObjectFromNetGUID: Network checksum mismatch. ===
In 5.4.3 I was getting this error, as there is a UE bug in the replication code. use my patch UESource\replication_bug.diff
LogNetPackageMap: Warning: GetObjectFromNetGUID: Network checksum mismatch. FullNetGUIDPath: [19]/Game/Blueprints/dummyChar.[17]Default__dummyChar_C, 124483537, 159126252
LogNetPackageMap: Warning: InternalLoadObject: Unable to resolve object from path. Path: Default__dummyChar_C, Outer: /Game/Blueprints/dummyChar, NetGUID: 17
LogNetPackageMap: Warning: InternalLoadObject: Unable to resolve object. FullNetGUIDPath: [19]/Game/Blueprints/dummyChar.[17]Default__dummyChar_C
LogNetPackageMap: Error: UPackageMapClient::SerializeNewActor. Unresolved Archetype GUID. Path: Default__dummyChar_C, NetGUID: 17.
LogNetPackageMap: Error: UPackageMapClient::SerializeNewActor Unable to read Archetype for NetGUID 21904 / 17
LogNet: Warning: UActorChannel::ProcessBunch: SerializeNewActor failed to find/spawn actor. Actor: None, Channel: 4

== cmake command for libzip ==
mkdir build
cd build
C:\PSUnreal\ThirdParty\Libzip\libzip\build>"F:\My Programs\Develop\CMake\bin\cmake" -DZLIB_LIBRARY=C:\UnrealEngine\Engine\Source\ThirdParty\zlib\v1.2.8\lib\Win64\VS2015\Release\zlibstatic.lib -DZLIB_INCLUDE_DIR=C:\UnrealEngine\Engine\Source\ThirdParty\zlib\v1.2.8\include -DENABLE_COMMONCRYPTO=OFF -DENABLE_GNUTLS=OFF -DENABLE_MBEDTLS=OFF -DENABLE_OPENSSL=OFF -DENABLE_WINDOWS_CRYPTO=OFF -DENABLE_BZIP2=OFF -DENABLE_LZMA=OFF -G "Visual Studio 15 2017 Win64" ..

== LoadConfig - import failed ==
I got this error:

LogInit: Display: LogObj: Error: LoadConfig (/Script/GLTFExporter.Default__GLTFExportOptions): import failed for DefaultMaterialBakeSize in: POT_1024

I solved it by deleting G:\PSUnreal511\Saved\Config . You must have the Editor closed, or the editor is resaving those ini files.

Compendium entries

2026-07-23T20:08:44Z

Talad: Created page with "To add a new creature/plant/mineral compendium entry look at codex_nature.item_type and codex_nature.ref_id"

To add a new creature/plant/mineral compendium entry look at [[Codex natureTable|codex_nature]].item_type and [[Codex natureTable|codex_nature]].ref_id

PSUnreal Config

2026-07-23T20:01:41Z

Talad: /* Dynamic elements */

== Static elements ==

* [[Config Races]]

* [[Config Character Creation]]

* [[How to define Sectors]]

* [[Music and Ambience Sounds]]
*[[Creatures and Attack sounds]]
*[[Creatures, Attack Types and Attacks]]

* Lights

* [[HowtoAddASpellToTheDatabase|Howto add a spell to the database.]]
*[[Combat and chase acceptance range]]
*[[Factions and Organizations]]
*[[Weapon Trails]]
*[[Voiceovers (audio files)]]

== Dynamic elements ==

* [[PSUnreal Proximity Triggers]]

* [[Random Generated events]]

* [[Hunt Locations and Natural Resources]]

* [[Levers and Interactable Objects]]

* [[Traps]]
* [[Instances]]
*[[Loot]]
*[[PSUnreal Guildhouses|Guildhouses (action locations)]]
*[[Setting Items]]
*[[Add new NPC]]
*[[Add Waypoints and paths]]
*[[Minigames]]
*[[Procedural Dungeon Generation]]
*[[Reload - Reloading at runtime]]
*[[PSUnreal Fishing Setup|Fishing Setup]]
*[[Compendium entries]]

== Npcs ==

* Behaviours: Nearly all we have is documented in [[NpcClient Design|this page]] and its sub pages
* [[KAs (Knowledge Areas) list and structure|Knowledge Areas]] (for dialogues)

== Quests ==

* [[Quest scripts syntax]]

== Mechanisms ==
TODO

Loot

2026-07-21T20:58:09Z

Talad:

You can get loot through a number of methods:

1) Through quests, we have the possibility to reward players items or money. See [https://planeshift.top-ix.org/pswiki/index.php/Quest_scripts_syntax#Give Give] script directive. At the moment this cannot be randomized.

2) Harvesting loot items from [[Hunt Locations and Natural Resources]], which spawn items on the ground or allow you to dig for items. At the moment this cannot be randomized. Only quality changes when harvesting.

2.1) Special chests, declared as 'CONSUMABLE' . This is the current list of items:

* Hardened treasure crate
* Adorned treasure Crate
* Sturdy treasure Chest
* Metal treasure Chest
* Reinforced treasure Chest
* Wide treasure Chest
* Ancient treasure Chest
*Jeweled treasure Chest

These have a special consume script stored in [[ItemStatsTable|item_stats.consume_script]] which is pointing to a [[ProgressionEventsTable|progression event]] . This can be the legacy 'treasure_chest' script looking at the base price and scaling rewards accordingly, OR it can be a new script using the [[ProgressionEvents#LootSetOp|LootSetOp]] which points to [[Loot rulesTable|loot_rules.id]].

2.2) For Procedural Dungeon Generation we added a new feature. The chests are generated with a defined item_quality, which will determine the loot rule to use. In psScheduleItem::CreateItem() we set the quality, and then the consume script (treasure_chest_rnd_loot) uses the quality to determine the loot rules. The chest used is ID 7111 (Arcana treasure Chest).

3) Killing creatures will allow players to loot. Loot is defined in [[CharactersTable|characters.npc_addl_loot_category_id]] field, which points to [[Loot rulesTable|loot_rules.id]] , and then to [[Loot rule detailsTable|loot_rule_details]] table. Here we can control the list of items and the % of chance to be random.

4) Buy from merchants. Any item present in the inventory of a NPC in a bulk slot can be bought is the NPC is a merchant. This is defined in table [[Merchant item categoriesTable|merchant_item_categories]] where all item categories are listed for this NPC.

5) Generated events:

* may spawn chests or puzzles providing rewards. in this case we may spawn a chest listed in point 2.1) above, but we will then specify in the event XML the traps properties.
*may spawn creatures with special loot tables, see point 3) above
* may spawn merchants with special goods to sell, see point 4) above
6) Main loot and furniture loot in generated dungeons

Loot

2026-07-21T20:53:55Z

Talad:

You can get loot through a number of methods:

1) Through quests, we have the possibility to reward players items or money. See [https://planeshift.top-ix.org/pswiki/index.php/Quest_scripts_syntax#Give Give] script directive. At the moment this cannot be randomized.

2) Harvesting loot items from [[Hunt Locations and Natural Resources]], which spawn items on the ground or allow you to dig for items. At the moment this cannot be randomized. Only quality changes when harvesting.

2.1) Special chests, declared as 'CONSUMABLE' . This is the current list of items:

* Hardened crate
* Adorned Crate
* Sturdy Chest
* Metal Chest
* Reinforced Chest
* Wide Chest
* Ancient Chest
*Jeweled Chest

These have a special consume script stored in [[ItemStatsTable|item_stats.consume_script]] which is pointing to a [[ProgressionEventsTable|progression event]] . This can be the legacy 'treasure_chest' script looking at the base price and scaling rewards accordingly, OR it can be a new script using the [[ProgressionEvents#LootSetOp|LootSetOp]] which points to [[Loot rulesTable|loot_rules.id]].

2.2) For Procedural Dungeon Generation we added a new feature. The chests are generated with a defined item_quality, which will determine the loot rule to use. In psScheduleItem::CreateItem() we set the quality, and then the consume script (treasure_chest_rnd_loot) uses the quality to determine the loot rules. The chest used is ID 7111 (Arcana treasure Chest).

3) Killing creatures will allow players to loot. Loot is defined in [[CharactersTable|characters.npc_addl_loot_category_id]] field, which points to [[Loot rulesTable|loot_rules.id]] , and then to [[Loot rule detailsTable|loot_rule_details]] table. Here we can control the list of items and the % of chance to be random.

4) Buy from merchants. Any item present in the inventory of a NPC in a bulk slot can be bought is the NPC is a merchant. This is defined in table [[Merchant item categoriesTable|merchant_item_categories]] where all item categories are listed for this NPC.

5) Generated events:

* may spawn chests or puzzles providing rewards. in this case we may spawn a chest listed in point 2.1) above, but we will then specify in the event XML the traps properties.
*may spawn creatures with special loot tables, see point 3) above
* may spawn merchants with special goods to sell, see point 4) above
6) Main loot and furniture loot in generated dungeons

Quest scripts syntax

2026-06-17T20:24:18Z

Talad: /* Give */

== Structure of a quest script ==
Quests are written out in chunks called steps. Each step covering the requirements of the previous one.

== Things to know before you start ==

* Quest scripts should written ideally in a text editor and now in MS Word or similar so that no illegal characters make it into the quest dialog which would result in errors when viewed in game.
* Quotes are usually the ones which break the scripts and :
* Only ' " should be used
* ‘ ’ ” “ … These should not be present in the text at all.
* Any line of text in the script which begins with a ‘#’ character is ignored by the server and only acts as a comment by the author so that they can leave explanations as to what is happening, or, give information about the step number.
* The start of a ‘step’ is defined by a series of three dots ‘...’ Everything after this text up until the next ‘...’ is included in the step. The only unique case is the first step, this does not need ‘...’ and includes all the text before the first ‘...’

== Important rules concerning steps ==

* Every step in the quest should be explicitly completed or locked correctly. Example: "Complete Quest Name Step #" before the Quest is completed.
* A step can require the completion of another step by the command: "Requires completion of Quest Name Step #"
* Step 1 does not exist, step 1 is part of the start script (where you use the command "give me a quest") and cannot be used as a require completion of step number.
* You may have multiple Require Completes at the beginning of a step.
* A step may also require another step NOT to have been completed with the command: "Require no completion of Quest Name Step #".
* The Quest name must be exact! It is case sensitive. The same goes for NPC names.
* Each step should be commented like this: "# Step 2 - A description of actions of this step". # Marks it as a comment not processed by the engine.
* You can also check for statements with this syntax: "Require <no/not> operator1 | <no/not> operator2 | ...| <no/not> operatorN." Where operator is a prerequisite (see below the prerequisite chapter), from completion of to time of day etc. The | represents the OR. ''Example: "Require completion of Questname Step 3 | completion of Questname Step 7."''

Let's see an example before beginning the explanation. The following example is made of two steps.

'''Example: Structure 1'''
P: Short Trigger.

Menu: Do you have any work for me to do?

NPC Name: Yes I do. Just breathe one time.

Assign Quest.

...

P: Ok, I did it!

NPC Name: Great, your quest is completed.

== Syntax Basics ==

=== Comments ===
To create a comment line you must start the line with a "#". These lines are not evaluated by the engine as things that need to be done. These comment lines show what is going on and what are the intentions of the quest writer. This is important because more than one person are often working on a quest script, or eventually for laterbug fixing it will be easier to find the exact problem without reading the entire quest.

Each step in a quest should be started by a comment like this "#Step 2 - Description of step.". You can use comments to more that just noting the step number. Any where within the script you can add comments to help your fellow scripters understand the code. We will use comments to explain things within the scripts here.

=== Trigger and Menu ===
The trigger is for the engine, while the menu is what shows up in the player quest menu. The trigger is defined by a "P:".

P: use to be what the player typed to trigger the step, but with the menu system are now used as a description of what step the player is choosing, for example P:yeshelp. (slide 3). The only time you must use exact text is when a player types the answer to a question you pose them

Because you are talking to the engine it must be exact a colon after the "P:" and a period at the end of the sentence. This is also true of the Menu in every case in which the player (P) says something to the NPC in question "P: Short Trigger." comes first, then below comes the "Menu:" line, with exactly the same requirements.

"Menu": Text is what the player sees when they look at the quest menu.

Please remember that the engine does not think, it reacts to the written cues, so the syntax MUST be exact. The first player statement gives the engine the quest name. The Menu allows the player to ask for the quest from the NPC.

Having the two "P:" and two "Menu:" on the same line informs the engine that the player has two different options. It is standard that the "P:" line is above the "Menu:" line and the "No." answer comes first.

These lines trigger the NPC response. In more elaborate quests the "Menu:" line may have variations on the No. or Yes. response. However remember KISS (Keep It Simple Stupid) is generally a good thing to keep in mind when you are beginning. You can have many options, but remember each "P:" must have a matching "Menu:" and they must be put in the same order

In order to include a free textfield, you will have to include a quotation mark after the menu. The <?> has to be followed by <=> and a text. This will produce a printout of the text and the user will be able to enter a free text. E.g. "Menu: ?=What shall Jardet do?" This will result in the text "What shall Jardet do?" being printed, followed by free form input.

P: *. P: rock pick.
Menu: ?=Please tell me your answer.
Smith: No, you didn't get the right answer.
Smith: Yes, it's a rock pick!.

P: Nothirstyinterst. P: Yesthirstyintrest.
Menu: No, sounds like work. Menu: Sure, I can get it for you.
Serana Tuvi: Alright. I will see you around then, stranger.
Serana Tuvi: Ah, good good.
<blockquote>'''Note:''' Remember the ": " after the P and Menu are important, as is the "." at the end of the line.

'''Note:''' For triggers used to start quests, never use NPC names into it, because this will confuse the engine, and the trigger will not be recognized.

'''Note:''' Every P: used in one step must be on the same line

'''Note:''' Every Menu: used in one step must be on the same line

'''Note:''' Every NPC: used in one step must be on different lines.</blockquote>

=== NPC Response ===
Aono Rikas: here you can add a response.

The line above is interpreted as an answer from the NPC and the engine will extract the name before the colon (:) + space as the NPC involved in this step of the quest. From now on, we will call this a response.

The full name of the NPC is required, just the first name will not work. If it is only one name e.g Harnquist use that, and if your NPC somehow ends up with three names use all of them.

In the first step of a quest the NPC statement will end in a question mark and is triggered by the first 2 lines. Responses are linked to each of the Triggers and Menus. So if you have two triggers you need two menu options and two NPC responses. All arranged in the same order.

=== Dialogues ===
The dialogues are the most important part of the quest for a player to get immersed. So let us talk about how to make the dialogue.

* Every punctuation, exclamation mark and question mark will create a short pause in the dialogue and create a new line.
* To create actions all you have to do is to use square brackets within the dialogue like this "Blablabla [NPC Name picks his nose] Bla bla blabla"
You may use also these commands:

* $playerrace can be used in an impersonal and a personal manner in terms of context, consider its usage carefully.

* $sir which gives you "Sir" or "Madam" or "Gemma" depending on the gender of the player's character. Again, this can be used to positive and negative effect. Be mindful of the NPCâ€™s tone. (Gemma is the honorific for Kran.)
* $playername clearly not to be used in newbie quests, have NPC establish rapport use this in second quest or even the third time a player works with a given NPC.

=== Quest Notes ===
Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Make sure to leave a hint of where to go next.

Example:
QuestNote You met Harnquist the local blacksmith.

== A sample quest script ==

=== The first step ===
As previously mentioned Step 1 does not exist, it is just the start of the quest, and can not be required by subsequent steps. The Start of the Quest will look something like the example at the beginning (Structure 1).

The same example can also be scripted like this:

'''Example: Structure 2'''
P: Short trigger.

Menu: Initial question, give me a quest.

NPC Name: Yes, I do have a quest for you. I need you to give Item of Importance to NPC2 Name.

P: Yes P: No.

Menu: Yes, I will do that. Menu: No way stupid.

NPC Name: This is the response from the NPC if answer is Yes.

Give 1 Item of Importance.

Assign Quest.

NPC Name: This is the response from the NPC if answer is No.

In Structure 2 the answers "No" and "Yes" are inverted, like the two "Menu:" commands, so it will give the same result as Structure 1. (Answer No: nothing happens. Answer Yes: the player will get 1Item of Importance and the Quest.)

Now, let us use a more detailed example. We will make a very simple quest: Aono wants to deliver a bottle of milk to Orchibaly. The player can choose the quest from Aono's quest menu. Orchibaly will then give the player 2 pies and a receipt to give back to Aono. The first step will be the step that assigns the quest. The P: tells the engine that this line represents something the player will say to the NPC, but what you must pay extra attention to is the "Menu:" This will be what the player will see as an option in the quest menu. If there are several options you will have to create one "P:" and a "Menu:" for each of them.

Here we firstly gives the player the option to ask for the quest. Then Aono describes the nature of the quest and the player can choose yes or no. Right after the "Menu:" line the NPC responsewill be put. In this example Aono will reply: "Well, I will get someone else to do it for me." if the player says no or "That's great. Here is the milk. Be sure not to spill it. TellOrchibaly I sent you.", give the player 1 Milk Bottle and assign the quest.

'''Example: Assign Quest'''
# Quest: Delivery for Aono Rikas

# Quest Description: Sample Quest.

# The rest of the header will not be covered here.

# Step 1 Aono Rikas in Hydlaa needs someone to deliver milk to Orchibally Gurpleferd in Ojaveda.

P: Delivery for Aono Rikas.

Menu: Are there any jobs you need done?

Aono Rikas: Well, yes. I need some milk delivered to Orchibaly in Ojaveda. Can you do this for me?

P: No. P: Yes.

Menu: No. Menu: Yes.

Aono Rikas: Well I will get someone else to do it for me.

Aono Rikas: That's great. Here is the milk. Be sure not to spill it. Tell Orchibaly I sent you.

Give 1 Milk Bottle.

Assign Quest.

A quest can be automatically assigned or there can be a step at the beginning of the quest to ask the player if he accepts it.

If you want to assign it automatically use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here.
Assign quest.

If you want to ask the player use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here, with the question if you want to help.
P: nohelp. P: yeshelp.
Menu: I don't want to. Menu: Yes I will help.
NPC: Fine... Go away.
NPC: Good great.
Assign quest.
<blockquote>'''Note:''' The “Assign quest.” command will only trigger after the second NPC: dialogue line is triggered, nothing happens if the first is triggered.</blockquote>

=== The next step ===
To separate the step we use "..." and then a comment on what step it is and what the step is about. If you don't want this step to be repeatable you will also have to add "NoRepeat" after the "...". The second step does not need a completion of Step 1, because Step 1 does not exist so to speak. The structure will be more or less the same as for the initial step.

Let us continue our Delivery for Aono Quest. We have assigned the quest and the player has been given 1 Milk Bottle to give to Orchibaly. Now the player must give that milk to Orchibaly. Either by using the give GUI or by using the quest menu. The first thing we have to do here is to set up the give trigger. If the player gives Orchibaly the milk, he will answer "Oh, yes the milk. Please give it to me. Now i need you to deliver these two pies and this receipt back toAono.", Give the player 2 pies and a Receipt from Orchibaly. The step is then completed.

In this example although the player is given two pies no "s" is added to the line. This is important, especially because most writers tend to add a plural automatically to plural items. Remember the engine does not. An item is designated in the singular, the engine always interprets it in the singular regardless of the number included. The numbers are again not spelt out and Arabic numerals used. Remember that each "Player gives"-command must have menu option in the next line.

'''Example: Step 2'''
... NoRepeat

# Step 2 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this bottle of milk.

Orchibaly Gurpleferd: Thanks, please give it to me. Now deliver two pies and a receipt back to Aono.

Give 2 Pie. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 2.

Completing a step

At the end of a step remember to insert the line:

"Complete Delivery for Aono Rikas Step 2."
<blockquote>
Note the use of Capitals, the use of the quest name, the use of the appropriate numeral and the period at the end of the sentence. The line marks the step as complete and allows the player and the quest to move forward.</blockquote>

=== Last step ===
To make sure the player has completed the previous step we start with "Require completion of delivery for Aono step 2.". Then we move on to the trigger which is the player giving 2 pies and the receipt to Aono. Aono answers "Ah, pie. Thank you. Please accept this for your time.", gives the player a pie and 100Tria. The step is closed and so is the quest with "Complete Delivery for Aono Rikas."

'''Example: Last Step'''
...NoRepeat.

# Step 3 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of delivery for Aono step 2.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here are your pies and your receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.
<blockquote>
'''NOTE:''' If you use multiple options in the last step of a quest you have to explicitly complete the quest with a command for the first option.</blockquote>
'''Example: Last step with multiple options'''

P: No. P: Yes.

Merchant: Quest doesn't complete automatically so make sure you have added a complete line for this response.

Complete Harnquist Needs Gold Step 2. Complete Harnquist Needs Gold.

Merchant: Quest completes automatically because it is the last line in quest so no complete line is required.

Complete Harnquist Needs Gold Step 2.

If you omit the Complete Step and Complete Quest line, the quest will not end properly when choosing "no".

=== Branches of a quest (Non exclusive) ===
Some times you want to have several different outcomes for a quest. Let us use the Delivery quest once again. If the first NPC says that you must NOT give the milk to some one else... specially NPC3. Then you should also add the option for the player to actually give the milk to NPC3 . This will complicate your script a bit, but is not as hard as it might seem. Most of the job is done by placing the right "Require completion of" and "Require no completion of" commands.

Let us take a look at that Delivery Quest again. Now we want to add an option for the player to give the milk to Reffitia instead. Reffitia will shake the milk until it becomes butter and this will make Orchibaly angry and demand a new bottle of milk. To do that we will have to add a few more steps and we will start from step 2 as step 1 will be the same as above.

The Third step will be our previous Step 2. And the last step will be the same. Though Aono should mention something like: "Make sure you don't give that milk toReffitia." in Step 1.<blockquote>
IMPORTANT NOTE: This is a non exclusive branching, meaning that the first branch is available also when executing the second one.

IMPORTANT NOTE: We will not add an additional step for the player to get milk again from Aono, but the player have to figure out another way to get hold of it (Buy from an NPC).</blockquote>

'''Example: Branching'''
... NoRepeat

# Step 2 - Alternative is to give the milk to refittia

Player gives 1 Milk Bottle to Reffitia

Menu: Here Reffitia, take this milk.

Reffitia Thamal: Ah! Orchibaly's milk. Here, now you can give the bottle to Orchibaly.

Give 1 Bottle of Butter.

Complete Delivery for Aono Rikas Step 2.

... NoRepeat

# Step 3 - Player gives bottle of butter to Orchy.
# The player then have to find another way of getting a bottle of milk (buy from NPC?)

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 4.

... NoRepeat

# Step 5 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

=== Alternative outcome ===
If we wanted the quest to have a different outcome if the player gives the milk to Reffitia than to Orchibaly we would need to get creative with the require commands. Let us say that if the player gives butter to Orchibaly he will give "bad pies" so when Aono receives them and takes a taste he will be very angry and no reward is given. To do this we will have to add just one more step. Let us start with step 3. Here we will have to change only the NPC response a bit to something like "Milk? This is butter. Have you been shaking the bottle all the way over here? This is completely useless to me, butter I have more than enough of. Any way someMenki came with another bottle just before you. Here takes these pies to Aono . Oh, and don't forget this receipt.". Step 4 will be the step where the player gives the bad pies to Aono, this step will complete the quest. Step 5 and 6 are the outcome if the player gives the milk directly toOrchibaly. Notice that Step 5 require a NO completion of Step 4. This is actually not necessary for this script, because the previous the other branch of the quest, ending in step 4 closes the quest it self.

'''Example: Alternative Outcome'''
# Step 3 - Player gives bottle of butter to Orchy. And receives 2 pies and a receipt

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Give 2 Pie. Give 1 Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the "bad" pies and the receipt to Aono. Receives gunk as reward and Quest is completed.

Require completion of Delivery for Aono Rikas Step 3

Player gives Orchibaly Gurpleferd 2 Pie, 1 Receipt from Orchibaly.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. [Aono takes a bite at the pie] You have tricked me!

Give 1 Gunk.

Complete Delivery for Aono Rikas Step 4.

Complete Delivery for Aono Rikas.

...
# Step 5 - Player gives the milk directly to Orchibaly.

Require no completion of Delivery for Aono Step 4.

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 5.

... NoRepeat

# Step 6 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

=== Quest Timeout (Passing of time) ===

If you want to allow a certain part of the quest to wait a certain amount of time before it can be a executed, you can use this script:
Run script give_quest_timeout <<'Time until Harnquist is ready',6>>
this will create a temporary active magic with name 'Time until Harnquist is ready' which will last for 6 minutes.

Then in the prerequisite of the step have this:
# Step 12.
Require active magic Time until Harnquist is ready.
P: swordnotready.
Menu: Is Vresa's sword ready yet?
Harnquist: No, not yet.

...
# Step 13.
Require no active magic Time until Harnquist is ready.
P: about Vresa sword.
Menu: Is Vresa's sword ready?
Harnquist: Yes, Vresa's sword is done.

=== Important commands and expressions used ===

=== Assign Quest. ===
This line tells the engine to assign the quest to the player and generally results in the "YOU GOT A QUEST". and placing the quest in the player's quest log, under "uncompleted". Again remember to be exact here, Capitalize the two words and put a "." at the end. It cannot be emphasized enough that the engine only interprets what it sees and the way it sees it. If you are not precise the quest will NOT happen or in the cases of the next steps move forward.

=== ... ===
The three dots mark the beginning of a new step. Better, the three dots create a new step. So you need a "three dots" line before every "Complete Quest Name Step #"

=== NoRepeat. ===
This line means that the quest step cannot be done over and over. Note that there are three periods "..." a space and 'NoRepeat.' is one word not two. Each part of this sentence is required in exactly this form.

Basically "..." tells the engine that some time can pass before the next lines are used.

NoRepeat allows this quest step to be only done one time. This also applies to actions as seen in later steps. (in reality NoRepeat is a synonym for Require no completion of "this step")

=== Require completion of Quest Name Step #. ===
This command is like a closed door. To open it and enter in the current step the player needs to complete the step number #. You can also refer to a future step (for example, you're on step 4 and add "Require completion of Quest Name Step 8.")

=== Require no completion of Quest Name Step #. ===
This command is like an open door. The player is free to continue the quest and entering the current step, UNLESS he completed the step number #. Completing the step number # will close the door. Forever! You can also refer to a future step.

=== Complete Quest A Step. ===
You can complete one step in another one. But remember to insert one "..." line for every "Complete Quest Name Step #." line.
Complete Delivery for Aono Rikas Step 2.

=== Complete Quest Name. ===
This command will end the quest. After this the quest will be deleted from the uncompleted quest list and appear in the Completed quest list.
Complete Delivery for Aono Rikas.

=== P: ===
The trigger is actually a ghost from the previous scripting system, but it is still needed (for now). Before the player had to type the exact trigger stated after the "P:". Now they click the option from "Menu:". Triggers must be four words or less. Triggers must end with a period, no other punctuation is allowed (question marks especially are known to break aquest on the server).

If you want multiple phrases to activate the same trigger, you can just separate the phrases by a period; for example: "P: about guards. about hydlaa guards. about hydlaa militia." In this case the NPC's response will be fired on any of the three options. This technique can be used also when you have multiple choices: "P: one. two. P: more.". Both 'one' and 'two' will trigger the first response, while 'more' will trigger the second.

WARNING: Triggers cannot contain any of the following words: a, am, an, and, any, anything, are, do, I, is, isnâ€™t, please, that, the, this, to, too.

They also may not contain the name of the NPC you're talking to as that'll be stripped.

These words just take up space in a trigger as they are dropped by the engine when evaluating player response. To make the best use of your word counts ignore them when writing your triggers.Example: If you wanted the player to say 'please help Levrus' the trigger would become 'help' as please would be an ignored word and Levrus would confuse the server.

WARNING: If a player needs to write "NPC needs this" syntax it as "NPC wants this".

=== Menu: ===
After this command you can add the sentence said by the player in game. This sentence will appear on the screen and could be selected when one talks to the NPC.

Remember that for every menu line you need to create a response from the NPC.

=== Give ===
Give is a very useful command. It tells the engine to give the player items. Be it rewards or special items needed for the quest. When you reward a player, you can basically give items and/or experience. The syntax to award 1500 experience points would be: "Give 1500 Exp." Note that "Exp" is case-sensitive. You can also reward items AND experience, using this syntax: "Give Leather Gloves. Give 1500 Exp." Remember that you can only have two give commands on the same line, but you can have multiple lines, Remember to keep a clean style, it is prefered to only have one item per line.

'''Example: Give more than two items'''
Give 1 Leather Gloves.
Give 1500 Exp.
Give 1 Apple.

You can also add a number if you need to give more than one item (like you do for experience) example: "Give 5 Iron Ingot." It is not necessary in the case of one item to include the numeral, however it is good practice to do so as numerals tell the engine how many and should be written as a numeral, a word will NOT work as the engine cannot interpret it as such. Remember that all special items must be declared in the script header.

Another option you have is to give one item OR another. The following will pop up a window in which the player has to choose just one item:

'''Example: Give the player a choice between items'''
Give Cold or Arrow or Energy.
You can also specify the quality of the item to give. Example to give 1 Hammer of 150 quality

Give 1 150 Hammer.

'''WARNING:''' At this time, don't use the following in an OR option: Tria, hexa, octa, circles, or items without a graphic. Also, for now, do NOT put quantities in front of items that are given using the "OR" parameter. An example of what NOT to do: "Give 1 Cold or 1 Arrow or 1 Energy." This will lock the server right up. An example of what SHOULD be done: "Give Cold or Arrow or Energy." (Check this statement if it is correct. --Katu)

=== Player gives NPC Name 1 Item ===
This can be used as a trigger (instead of the "P:"). It tells the engine to trigger the NPC dialogue when one or any fixed amount of a special item.

When a player have to give multiple items just add them to the original line using a comma:

'''Example Player gives item'''
Player gives Harnquist Water Pouch, 1 Pie.

'''WARNING:''' Item name rules must be followed at all times.

=== Item Name Rules ===

* Notice that the item name is "Iron Ingot", so "Iron Ingots" will not work, even if itâ€™s the correct plural form. Keep all names singular.
* Also, do not use a number (3, 14, etc) in the name of an item. An item called 3 Circles Receipt will probably generate problems when we script "Give 3 Circles Receipt." It is better named "Three Circles Receipt."
* Numbers should be spelled out everywhere unless you are referring to the quantity given or dealing with a trigger (give me 5 apples. give me five apples.) as both would be correct in a trigger.
* Character limit for an item name is 60 characters.
* Do not use an s' in an item name, like "Levrus' Left Shoe," use "Left Shoe of Levrus" or a similar substitute instead.

=== Set and unset a variable and Require a variable ===
You can set a variable to be later used by the quest or other quests. Variables are set on the character and visible from all quests.
Variables here are only boolean, so the only valid value is 1. The requirements only checks if the variable is set or not.

Use a prefix for all variables, so they don't get confused with other variables: "Quest_questname_variablename".
Smith: Here is your winch access
Setvariable Quest_Winch_Access 1

You can then require a variable to be set as prerequisite of a quest step.
Require variable Quest_Winch_Access.
P: access.
Menu: I have access
Bobaus: Ok, good.

If you want to unset a variable use the "Unsetvariable" command:
Unsetvariable Quest_Alchemy_Winch_Access.

=== Rewards at the end of the quest ===
When completing a quest, the player usually gets experience and money, or some items. In particular for experience and money you should use the following scripts. This allows us to split the rewards on a scale from 1 to 10 and then to tweak the actual values in the engine. The values in brackets indicate the complexity of the quest. The more complex the more rewards the player will get.

Run script give_quest_money <<3>>.
Run script give_quest_exp <<2>>.
You can also award faction points by using "give_quest_faction" , the number given is multiplied by 5 so if you want +5 point, you need 1 on the second parameter:
Run script give_quest_faction <<'Essential Trail', 1>>.
We have script also to push the faction point up to a given value, if you are already higher, this script will do nothing.
Run script give_quest_faction_level <<'Essential Trail', 2>>.

* value = 1-> max faction points = 10;
* value = 2-> max faction points = 20;
* value = 3-> max faction points = 35;
* value = 4-> max faction points = 55;
* value = 5-> max faction points = 75;
* value = 6-> max faction points = 100;
* value = 7-> max faction points = 125;
* value = 8-> max faction points = 150;
* value = 9-> max faction points = 200;

If you want to assign a faction title you can use this script. In the example it will assign the second title.
Run script give_quest_faction_title <<'Essential Trail', 2>>.

== The Quest Header ==
The header should contain a lot of information. All the information is commented out by a "#". The example below is from one of the mount quests.
First section is information about the quest itself. Name of the quest, a short description and category. Categories will be discussed in detail later on.

The next sections are for unique items used in the quest, name of the item followed by the description.

The third section is for recording versions of the script and all naming authors. Also who last edited the quest should be noted.

The last section is for additional metadata which will be added to the quest in the database (not part of the db) and will be used by the engine to determine lockouts and prerequisites. Here it locks all players from doing the quest again and locks all other players to take the quest with 60 seconds.

Lastly we tell the engine that the player have to complete the Ring of Familiar quest before this one. Note that these comments aren't taken by the engine; it's the duty of who loads the quest to fill the correct entries with the data found in the header: so it's just a way to keep all data together on the script.

'''Example: Header'''
# Quest name: Drifting for a Drifter
# Quest Description: Taemian wants to sell you a mount
# Quest Category: General
# ----------------------
# Quest Items: Item name/Item description
# Taemian's Pouch: - Pouch with all sorts of coins
# Green Gem of the Drifter - A magical gem with a green glow
# Unsigned Drifter Permit - A permit that still needs to be signed by Datal
# Signed Drifter Permit - A permit that has been signed by Datal
# ----------------------
# Variables used in this quest
# ----------------------
# Quest specific variables used in this quest
# ----------------------
# Author(s): Ravna, Katu, weltall
# Current Version: 1.01
# Player lockout: -1
# Quest lockout: 60
# Prerequisites: <nowiki><pre><completed quest="Ring of Familiar"/></pre></nowiki>
# Variables used: Quest_Variable_Name used to do.....
# ----------------------
# Version history and change log
# Last edited by: weltall
# Version 1.00: Initial draft - 05/01/2010 - Katu.
# Version 1.01: Added extra steps - 1/22/2011 - Venalan.
# ----------------------

==== Quest Lockouts ====
Each quest has two different lockout types:

* Player lockout: When this parameter is set, the engine will wait the specified amount of seconds before allowing the same player to redo the same quest. If you want a quest to be available to each player only one time, then set the lockout to -1. Setting it to 600 will have the engine wait 10 minutes before unlocking the quest again.
* Quest lockout: When this parameter is set, the engine will wait the specified amount of seconds before reactivating the quest for ALL players. This means no one can start the same quest during this period, but the ones that had it already active can complete it.

Usually we want quests to be unique to players, so most have a player lockout -1, except the very simple ones. Try always to think if itâ€™s meaningful for that player to redo it. (For example, Harnquist can require iron ore more than once, but won't need to teach you how to make a sword more than once.)

=== Prerequisites ===
'''Example: Prerequisites'''

A sample of the coding used to set prerequisites for a quest (All on one line):
<nowiki><pre><and></nowiki>
<completed quest="Test Quest One"/>
<completed quest="Test Quest Two"/>
<completed quest="Test Quest Three"/>
<assigned quest="Test Quest Four"/>
<not><completed quest="Delivery for Aono Riskas"/></not>
<not><completed quest="Gorbiak Disease"/></not>
</and><nowiki></pre></nowiki>

This sample requires that the player have completed Test Quests 1 through 3, have Test Quest 4 assigned (not completed) and have NOT completed Fancy Dancing and High-Class Aspirations. To get these arranged correctly can take some practice if one is not familiar with working with booleans, so it is best to include a plain-English comments of what you wish your pre-requisites to be in addition to the one with the "pre" coding statements.

== Requirements and Prerequisites ==
You can have as many requirements as you wish for a step, but again we remind you to keep it as simple as possible, so thing thoroughly through your choices here.

=== Multiple Requirements with OR ===
You can have an "or" statement between requirements by using "|":
Require Completion of Quest Winch Access | Completion of Harnquist is Hungry.
This needs all to be on one line.

=== Require Compendium ===
You can require the player to have a certain knowledge in the Compendium.
Require compendium creature StoneHammer.
P: comps
Menu: I know everything about the StoneHammers!
Fighter3: WOW
...
Require no compendium creature StoneHammer.
P: nocomps
Menu: Sorry I dont know anything about StoneHammers!
Fighter3: Ah, study more!
The syntax is: compendium <creature/plant/mineral> <name>

Another more complex version of the prerequisites is the: REQUIRE MIN <number>: this tells the engine that there are specific requirements to be fulfilled before the player is able to get the quest. This script indicated it requires a minimum number of quests to be completed in a given list.

=== Require min and Require Category Min ===
Example:
require min 2 of Quest1, Quest2, Quest3.
To match this prerequisite the player can complete Quest1 and Quest3 or 2 and 3, or all 3. The request is minimum 2 in the given list.

CATEGORY MIN <number>: quests have an attribute called "category", we use it to identify the difficulty of quests, but can be used of any other purpose, for example one can say that a group of quests is "Evil" or "Laanx related" or " Newbie". Just one category is allowed per quest. This prerequisite allows you to specify the category and the minimum number of quests completed in that category.

=== Require Time of Day ===
Requires the time of day to be at a specific point. The in game time has 24 hours.

Example:
Require time of day 1-2.
This example will trigger when the game time is between 1 and 2.

=== Require Active Magic ===
Checks if the player character has active magic.
Require active magic Weakness.

=== Require Race ===
"race" (working)
Require not race Klyros. Require race Kran.

=== Require Gender ===
"gender" (working)
Require gender female.

=== Require Possessed ===
Checking if the player character possesses an item/ has it in their inventory:
Require possessed item Ruby Crystal.
You can also check the amount of items as well as the quality of the items:
Require Possessed amount 3 200-300 item Steel Falchion.
it works also with money, as we handle this specifically. It will convert any currency, and check player total money for it.
Require no possessed amount 500 item Tria.

=== Require Skill ===
Require skill <buffed> name <skillmin>-<skillmax>.

=== Require Variable ===
Require variable Quest_Winch_Access.

=== Require Trait ===
Check if the player character has certain traits.
Require trait Black in HAIR_COLOR.
The different traits are: "NONE","FACE","HAIR_STYLE","BEARD_STYLE","HAIR_COLOR","SKIN_TONE","ITEM", "EYE_COLOR"

=== Require Guild ===
Unknown if this works.

=== Require Known Spell ===
Check if the character knows a spell.
Require known spell Nature Intuition.

=== Require Equipped ===
Checks if the player has a certain item equipped.
Require equipped category Armor - Helms.

Require no equipped category Armor - Helms.

Require equipped item Sword Handle.

Require not equipped item Sword Handle.

=== Require Married ===
This is untested and unknown if it works.

= Notes on Creating Quest Files (Rules and Header Information) =

* The quest documents you submit should always be in notepad format: this is to avoid special characters added by Word or other text editors, most notably "smart quotes" which will appear as squares in game. Notepad++ is recommended, HIGHLY recommended.
* Use only ANSI encoding.
* The file name when saving the quest should begin with 'Quest' , then have the name of the quest. For example: Quest Hinoserri Cannot See.txt
* Titles of quests should follow some scheme of capitalization. There are many sets of rules, but a quick and easy format is to capitalize the first word and then all other words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor.
* Each quest script begins with the title and a one or two sentence description; this is what the player reads so keep that in mind. The proper way to do this is to "comment out" your description and quest title, this is done by beginning a line with the number sign or pound symbol (#). Also, any quest item created for your quest should have a description written into the quest. Notes on quest items should also be commented out. Lastly, there should also be a "Quest Category" line that must be commented out as well. Approved quest categories are: Alchemy, Black Flame, Chain (don't use this one unless told), Cooking, Death Realm, Easy, Gugrontid, Magic Ways, Medium, Metal Working, Newbie, Repeatable. This is a work in progress, so if you have any questions ask an associate dev or developer. No quest can have more than one category - pick one and ONLY one. New quest categories must be approved by the associate devs/devs before use.

Damage Types and Resistance

2026-05-21T22:42:29Z

Talad:

Through various means you can get resistance to certain types of damage. For example in character creation your choices will determine some of those resistances. Also when equipping an item or casting a spell you may get resistance to certain elements.

For Magic, there are 6 types of resistance, one for each way:
* Crystal Way Resistance (generally energy/blind/light damage)
* Blue Way Resistance (generally freeze/ice damage)
* Red Way Resistance (generally fire/lava/lightning damage)
* Azure Way Resistance (generally psychic damage)
* Dark Way Resistance (generally drain/weakness damage)
* Brown Way Resistance (generally impact damage, like rocks, sand wind, thorns, ...)

There are also other damage types, and specific resistances:
* Poison Resistance
* Disease Resistance
Resistances may come from different sources:

- through character creation: are stored in the database in the form of [[Character variablesTable|character variables]]. A progression script runs at char creation and sets <variableset aim="Actor" name="Crystal Way Resistance" value="4"/>. The variables are loaded when the char is loaded.

- Through loot modifiers in player crafted armor. Example suffix "of Confusion" as armor increases Brown, Dark, Blue resistance by 6.

- through spells. Most spells have a Saving Throw, which is calculated by the Caster Way skill vs defender Way Skill. Plus there is reduction of damage based on the Way resistance. Both are directly in the spell cast script.

There are also damage types by type of weapon:

* Slashing (reference weapon Long Sword)
* Bludgeoning (reference weapon Mace)
* Piercing (reference weapon Long Bow)

Maps editing workflow

2026-05-16T13:41:51Z

Talad:

== How Landscape is setup ==
In the outliner we have a Landscape Object. If you click on it, you see the details it's linked to a MI_Landscape.

MI_Landscape contains all the parameters including the visibility of rocks , grass, etc...

The actual meshes are part of "Landscape Grass Type" a special object that can contain a mesh, its density, culling distance, etc...

M_Landscape has a special node called : "Landscape Grass" of type "Landscape Grass Output". It the detail panel of this node, there are all the "Landscape Grass Type" linked with a name (which is the name of the layer).

You HAVE to use grass.FlushCache in console after you do changes to this node or you will NOT see the changes!

M_Landscape has a special node called : "MF_LandscapeLayers" it determines how the landscape looks (color, roughness, normal), defines the textures.

=== Landscape limits ===
Vertically our landscape can go from -250 meters up to +250 meters, if you try to go beyond these values you just get flat terrain at the max height and you cant go beyond.

Our maps at the moment have the lowest point to the south of Homestead where it reach -177 meters. Plus we need to consider the Death Ream boundaries, that reach at the moment -199 meters.

We have set the Kill Z value to -185 meters.

=== Notes ===

* BuiltData files are storing:
** lightmap textures (created by Build Lighting only)
** volumetric light probes / samples (created by Build Lighting only)
* umap files are storing:
** navigation paths (created by Build Paths)

=== Map creation flow ===
You should never upload BuiltData file in SVN. Those will be regenerated when we create the shipping release.

If you want to test locally the full game including lights then you need to:

* Load all the levels and Build Lighting only, this gives the best result on map borders, but I think you can avoid it

OR

* Load Persistent Level + one or more maps you want relit, and Build Lighting only. In this case the single maps will be ok, but the borders between maps will not

If you want to test locally the full game including NPC movement then you need to:

* Follow Option 1 in [[PSUnreal Navigation Meshes|this page]].

Quest scripts syntax for AI

2026-04-25T18:07:18Z

Talad:

In our game PlaneShift MMO, we have a script syntax to create new quests. I want to create quest script for the following quest. I'm giving you only the Player and NPC answers, you have to transform it in the syntax below.

This quest is named: "The ink of the desert", and has ID: 1510

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

We also have the possibility to have multiple questions and answers in the same step, this is done usually when the discussion is about the same topic and doesn't require a separate QuestNote. In this case the structure is P: , then Menu: , then the npc line. The P must be unique so here we append a letter to the end, example 15005a, 15005b, ... But please note the step number will still be 5. So all Require and Complete will refer to 5, not to 5a or 5b.

When we move to another NPC it's required to have a separate step.

If the dialogue branches and then we need to merge it again in one step later on, we can use the OR operator that's a pipe |. This example requires step 3 or step 4 to be completed:

Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.

A full example follows. In this example there are two parallel possible answers to the NPC question, and also a longer discussion in one last step:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001.
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: Yes I want to help, but I can do it tomorrow.
Harnquist: Ok, come back tomorrow then and please bring me 10 iron ore.
QuestNote I had to ask one more day, and Harnquist asked for 10 iron ore to be delivered tomorrow.
Complete Searching the blacksmith Step 4.

... NoRepeat
# Step 5
Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.
P: 15005.
Menu: I have the ore you requested.
Harnquist: Very good!
P: 15005a.
Menu: Can you evaluate its quality?
Harnquist: Sure I can, let me look. [Harnquist puts on a set of glasses to inspect the ore]
QuestNote I brought the ore to Harnquist.
Complete Searching the blacksmith Step 5.

Hunt Locations and Natural Resources

2026-04-24T22:26:26Z

Talad: /* Natural Resources */

We have two different ways to configure locations where players can gather materials.

== Natural Resources ==
Used when we need invisible items to be harvested, example a mine will be modeled in 3d, but the individual ore are not 3d objects in the world.

So we configure a location on the map, defined by a center (in x/y/z coordinates) and a radius, where the player will be able to harvest. We also define the tool to be used (example a rock pick), the difficulty, and the resulting item.
* The table [[natural_resourcesTable|natural_resources]] is holding this information

For '''wood harvesting''', we created a different system, based on the mesh name you right click on. To have one type of tree being recognized for harvesting you need to do the following:

1) Set Collision = "Custom" and "Query Only". Set all channels to "Ignore" except "InteractMouseTrace" to Block.

2) In the mesh object (Example oak_03) set the "Collision Complexity" to "Use Simple as Complex", this is because when we LineTrace we use Complex.

3) Save the level again

4) Set the mesh name in [[natural_resourcesTable|natural_resources]].trace_mesh. This name can be set just with the first part of the name, example "oak_", so that all trees with name "oak_*" will be picked up, like oak_01, oak_02, .....

5) In [[natural_resourcesTable|natural_resources]] set the location and sector to 0, as it will be ignored anyway.

For '''flowers/plants''', the engine is spawning a mesh on the location of the natural resources, line tracing down to the ground, remember to:

1) Remove the collision from the mesh in Unreal

2) set the mesh name in [[natural_resourcesTable|natural_resources]].spawn_mesh.

3) If you want the plant to ALWAYS be available, then do not add any children to it

4) If you want to use the new random spawn system, then add a new child resource in natural_resources_items . This will make the main resource just a container (nothing will spawn there) and the system will select at random X locations to spawn, where X is defined by [[natural_resourcesTable|natural_resources]].active_locations. Then [[natural_resourcesTable|natural_resources]].amount will define how many times you can harvest that resource before its depleted. When it's depleted it will disappear and the game will wait [[natural_resourcesTable|natural_resources]].interval + [[natural_resourcesTable|natural_resources]].max_random milliseconds before spawning a new one in a non active location.

To spawn new natural resources in game do this:

/resource display (shows all resources)

/resource add <itemname> <active_locations> <amount> (creates the starting point for one plant area, but doesnt spawn anything)

where <active_locations> is how many locations are active at the same time, and <amount> is how many times you can harvest before the resource disappears

/resource addsub <natural_resource_id> Create a location to SPAWN an item, it refers to the starting point

where <natural_resource_id> is the starting point you created with "/resource add" above.

For '''fishing''' we created a linked table natural_resource_items and [[natural_resourcesTable|natural_resources]].item_group points to natural_resource_items.group_id . This table contains the characteristics of the group.

== Hunt Locations ==
Used when we want a visual 3d object to be spawned as a pickupable item. When the player picks up the item, a new item is scheduled to be spawn later on based on configured interval.

* The table [[hunt_locationsTable|hunt_locations]] is holding this information

Quest scripts syntax

2026-04-21T21:46:40Z

Talad: /* More Prerequisites */

= Structure of a quest script =
Quests are written out in chunks called steps. Each step covering the requirements of the previous one.

= Things to know before you start =
Quest scripts should written ideally in a text editor and now in MS Word or similar so that no illegal characters make it into the quest dialog which would result in errors when viewed in game.

Quotes are usually the ones which break the scripts and :

• Only ' " should be used

• ‘ ’ ” “ … These should not be present in the text at all.

Any line of text in the script which begins with a ‘#’ character is ignored by the server and only acts as a comment by the author so that they can leave explanations as to what is happening, or, give information about the step number.

The start of a ‘step’ is defined by a series of three dots ‘...’ Everything after this text up until the next ‘...’ is included in the step. The only unique case is the first step, this does not need ‘...’ and includes all the text before the first ‘...’

== Important rules concerning steps ==

* Every step in the quest should be explicitly completed or locked correctly. Example: "Complete Quest Name Step #" before the Quest is completed.
* A step can require the completion of another step by the command: "Requires completion of Quest Name Step #"
* Step 1 does not exist, step 1 is part of the start script (where you use the command "give me a quest") and cannot be used as a require completion of step number.
* You may have multiple Require Completes at the beginning of a step.
* A step may also require another step NOT to have been completed with the command: "Require no completion of Quest Name Step #".
* The Quest name must be exact! It is case sensitive. The same goes for NPC names.
* Each step should be commented like this: "# Step 2 - A description of actions of this step". # Marks it as a comment not processed by the engine.
* You can also check for statements with this syntax: "Require <no/not> operator1 | <no/not> operator2 | ...| <no/not> operatorN." Where operator is a prerequisite (see below the prerequisite chapter), from completion of to time of day etc. The | represents the OR. ''Example: "Require completion of Questname Step 3 | completion of Questname Step 7."''

Let's see an example before beginning the explanation. The following example is made of two steps.

'''Example: Structure 1'''
P: Short Trigger.

Menu: Do you have any work for me to do?

NPC Name: Yes I do. Just breathe one time.

Assign Quest.

...

P: Ok, I did it!

NPC Name: Great, your quest is completed.

== Syntax Basics ==

=== Comments ===
To create a comment line you must start the line with a "#". These lines are not evaluated by the engine as things that need to be done. These comment lines show what is going on and what are the intentions of the quest writer. This is important because more than one person are often working on a quest script, or eventually for laterbug fixing it will be easier to find the exact problem without reading the entire quest.

Each step in a quest should be started by a comment like this "#Step 2 - Description of step.". You can use comments to more that just noting the step number. Any where within the script you can add comments to help your fellow scripters understand the code. We will use comments to explain things within the scripts here.

=== Trigger and Menu ===
The trigger is for the engine, while the menu is what shows up in the player quest menu. The trigger is defined by a "P:".

P: use to be what the player typed to trigger the step, but with the menu system are now used as a description of what step the player is choosing, for example P:yeshelp. (slide 3). The only time you must use exact text is when a player types the answer to a question you pose them

Because you are talking to the engine it must be exact a colon after the "P:" and a period at the end of the sentence. This is also true of the Menu in every case in which the player (P) says something to the NPC in question "P: Short Trigger." comes first, then below comes the "Menu:" line, with exactly the same requirements.

"Menu": Text is what the player sees when they look at the quest menu.

Please remember that the engine does not think, it reacts to the written cues, so the syntax MUST be exact. The first player statement gives the engine the quest name. The Menu allows the player to ask for the quest from the NPC.

Having the two "P:" and two "Menu:" on the same line informs the engine that the player has two different options. It is standard that the "P:" line is above the "Menu:" line and the "No." answer comes first.

These lines trigger the NPC response. In more elaborate quests the "Menu:" line may have variations on the No. or Yes. response. However remember KISS (Keep It Simple Stupid) is generally a good thing to keep in mind when you are beginning. You can have many options, but remember each "P:" must have a matching "Menu:" and they must be put in the same order

In order to include a free textfield, you will have to include a quotation mark after the menu. The <?> has to be followed by <=> and a text. This will produce a printout of the text and the user will be able to enter a free text. E.g. "Menu: ?=What shall Jardet do?" This will result in the text "What shall Jardet do?" being printed, followed by free form input.

P: *. P: rock pick.
Menu: ?=Please tell me your answer.
Smith: No, you didn't get the right answer.
Smith: Yes, it's a rock pick!.

P: Nothirstyinterst. P: Yesthirstyintrest.
Menu: No, sounds like work. Menu: Sure, I can get it for you.
Serana Tuvi: Alright. I will see you around then, stranger.
Serana Tuvi: Ah, good good.

'''Note:''' Remember the : after the P and Menu are important, as is the . at the end of the line.

'''Note:''' For triggers used to start quests, never use NPC names into it, because this will confuse the engine, and the trigger will not be recognized.

'''Note:''' Every P: used in one step must be on the same line

'''Note:''' Every Menu: used in one step must be on the same line

'''Note:''' Every NPC: used in one step must be on different lines.

=== NPC Response ===
Aono Rikas: here you can add a response.

The line above is interpreted as an answer from the NPC and the engine will extract the name before the colon (:) + space as the NPC involved in this step of the quest. From now on, we will call this a response.

The full name of the NPC is required, just the first name will not work. If it is only one name e.g Harnquist use that, and if your NPC somehow ends up with three names use all of them.

In the first step of a quest the NPC statement will end in a question mark and is triggered by the first 2 lines. Responses are linked to each of the Triggers and Menus. So if you have two triggers you need two menu options and two NPC responses. All arranged in the same order.

=== Dialogues ===
The dialogues are the most important part of the quest for a player to get immersed. So let us talk about how to make the dialogue.

* Every punctuation, exclamation mark and question mark will create a short pause in the dialogue and create a new line.
* To create actions all you have to do is to use square brackets within the dialogue like this "Blablabla [NPC Name picks his nose] Bla bla blabla"

You may use also these commands:

$playerrace can be used in an impersonal and a personal manner in terms of context, consider its usage carefully.

$sir which gives you "Sir" or "Madam" or "Gemma" depending on the gender of the player's character. Again, this can be used to positive and negative effect. Be mindful of the NPCâ€™s tone. (Gemma is the honorific for Kran.)

$playername clearly not to be used in newbie quests, have NPC establish rapport use this in second quest or even the third time a player works with a given NPC.

Give me a quest..

= A sample quest script =

== The first step ==
As previously mentioned Step 1 does not exist, it is just the start of the quest, and can not be required by subsequent steps. The Start of the Quest will look something like the example at the beginning (Structure 1).

The same example can also be scripted like this:

'''Example: Structure 2'''
P: Short trigger.

Menu: Initial question, give me a quest.

NPC Name: Yes, I do have a quest for you. I need you to give Item of Importance to NPC2 Name.

P: Yes P: No.

Menu: Yes, I will do that. Menu: No way stupid.

NPC Name: This is the response from the NPC if answer is Yes.

Give 1 Item of Importance.

Assign Quest.

NPC Name: This is the response from the NPC if answer is No.

In Structure 2 the answers "No" and "Yes" are inverted, like the two "Menu:" commands, so it will give the same result as Structure 1. (Answer No: nothing happens. Answer Yes: the player will get 1Item of Importance and the Quest.)

Now, let us use a more detailed example. We will make a very simple quest: Aono wants to deliver a bottle of milk to Orchibaly. The player can choose the quest from Aono's quest menu. Orchibaly will then give the player 2 pies and a receipt to give back to Aono. The first step will be the step that assigns the quest. The P: tells the engine that this line represents something the player will say to the NPC, but what you must pay extra attention to is the "Menu:" This will be what the player will see as an option in the quest menu. If there are several options you will have to create one "P:" and a "Menu:" for each of them.

Here we firstly gives the player the option to ask for the quest. Then Aono describes the nature of the quest and the player can choose yes or no. Right after the "Menu:" line the NPC responsewill be put. In this example Aono will reply: "Well, I will get someone else to do it for me." if the player says no or "That's great. Here is the milk. Be sure not to spill it. TellOrchibaly I sent you.", give the player 1 Milk Bottle and assign the quest.

'''Example: Assign Quest'''
# Quest: Delivery for Aono Rikas

# Quest Description: Sample Quest.

# The rest of the header will not be covered here.

# Step 1 Aono Rikas in Hydlaa needs someone to deliver milk to Orchibally Gurpleferd in Ojaveda.

P: Delivery for Aono Rikas.

Menu: Are there any jobs you need done?

Aono Rikas: Well, yes. I need some milk delivered to Orchibaly in Ojaveda. Can you do this for me?

P: No. P: Yes.

Menu: No. Menu: Yes.

Aono Rikas: Well I will get someone else to do it for me.

Aono Rikas: That's great. Here is the milk. Be sure not to spill it. Tell Orchibaly I sent you.

Give 1 Milk Bottle.

Assign Quest.

A quest can be automatically assigned or there can be a step at the beginning of the quest to ask the player if he accepts it.

If you want to assign it automatically use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here.
Assign quest.

If you want to ask the player use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here, with the question if you want to help.
P: nohelp. P: yeshelp.
Menu: I don't want to. Menu: Yes I will help.
NPC: Fine... Go away.
NPC: Good great.
Assign quest.

'''Note:''' The “Assign quest.” command will only trigger after the second NPC: dialogue line is triggered, nothing happens if the first is triggered.

== The next step ==
To separate the step we use "..." and then a comment on what step it is and what the step is about. If you don't want this step to be repeatable you will also have to add "NoRepeat" after the "...". The second step does not need a completion of Step 1, because Step 1 does not exist so to speak. The structure will be more or less the same as for the initial step.

Let us continue our Delivery for Aono Quest. We have assigned the quest and the player has been given 1 Milk Bottle to give to Orchibaly. Now the player must give that milk to Orchibaly. Either by using the give GUI or by using the quest menu. The first thing we have to do here is to set up the give trigger. If the player gives Orchibaly the milk, he will answer "Oh, yes the milk. Please give it to me. Now i need you to deliver these two pies and this receipt back toAono.", Give the player 2 pies and a Receipt from Orchibaly. The step is then completed.

In this example although the player is given two pies no "s" is added to the line. This is important, especially because most writers tend to add a plural automatically to plural items. Remember the engine does not. An item is designated in the singular, the engine always interprets it in the singular regardless of the number included. The numbers are again not spelt out and Arabic numerals used. Remember that each "Player gives"-command must have menu option in the next line.

'''Example: Step 2'''
... NoRepeat

# Step 2 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this bottle of milk.

Orchibaly Gurpleferd: Thanks, please give it to me. Now deliver two pies and a receipt back to Aono.

Give 2 Pie. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 2.

Completing a step

At the end of a step remember to insert the line:

"Complete Delivery for Aono Rikas Step 2."

Note the use of Capitals, the use of the quest name, the use of the appropriate numeral and the period at the end of the sentence. The line marks the step as complete and allows the player and the quest to move forward.

== Last step ==
To make sure the player has completed the previous step we start with "Require completion of delivery for Aono step 2.". Then we move on to the trigger which is the player giving 2 pies and the receipt to Aono. Aono answers "Ah, pie. Thank you. Please accept this for your time.", gives the player a pie and 100Tria. The step is closed and so is the quest with "Complete Delivery for Aono Rikas."

'''Example: Last Step'''
...NoRepeat.

# Step 3 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of delivery for Aono step 2.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here are your pies and your receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

'''NOTE:''' If you use multiple options in the last step of a quest you have to explicitly complete the quest with a command for the first option.

'''Example: Last step with multiple options'''

P: No. P: Yes.

Merchant: Quest doesn't complete automatically so make sure you have added a complete line for this response.

Complete Harnquist Needs Gold Step 2. Complete Harnquist Needs Gold.

Merchant: Quest completes automatically because it is the last line in quest so no complete line is required.

Complete Harnquist Needs Gold Step 2.

If you omit the Complete Step and Complete Quest line, the quest will not end properly when choosing "no".

== Branches of a quest (Non exclusive) ==
Some times you want to have several different outcomes for a quest. Let us use the Delivery quest once again. If the first NPC says that you must NOT give the milk to some one else... specially NPC3. Then you should also add the option for the player to actually give the milk to NPC3 . This will complicate your script a bit, but is not as hard as it might seem. Most of the job is done by placing the right "Require completion of" and "Require no completion of" commands.

Let us take a look at that Delivery Quest again. Now we want to add an option for the player to give the milk to Reffitia instead. Reffitia will shake the milk until it becomes butter and this will make Orchibaly angry and demand a new bottle of milk. To do that we will have to add a few more steps and we will start from step 2 as step 1 will be the same as above.

The Third step will be our previous Step 2. And the last step will be the same. Though Aono should mention something like: "Make sure you don't give that milk toReffitia." in Step 1.

IMPORTANT NOTE: This is a non exclusive branching, meaning that the first branch is available also when executing the second one.

IMPORTANT NOTE: We will not add an additional step for the player to get milk again from Aono, but the player have to figure out another way to get hold of it (Buy from an NPC).

'''Example: Branching'''
... NoRepeat

# Step 2 - Alternative is to give the milk to refittia

Player gives 1 Milk Bottle to Reffitia

Menu: Here Reffitia, take this milk.

Reffitia Thamal: Ah! Orchibaly's milk. Here, now you can give the bottle to Orchibaly.

Give 1 Bottle of Butter.

Complete Delivery for Aono Rikas Step 2.

... NoRepeat

# Step 3 - Player gives bottle of butter to Orchy.
# The player then have to find another way of getting a bottle of milk (buy from NPC?)

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 4.

... NoRepeat

# Step 5 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Alternative outcome ==
If we wanted the quest to have a different outcome if the player gives the milk to Reffitia than to Orchibaly we would need to get creative with the require commands. Let us say that if the player gives butter to Orchibaly he will give "bad pies" so when Aono receives them and takes a taste he will be very angry and no reward is given. To do this we will have to add just one more step. Let us start with step 3. Here we will have to change only the NPC response a bit to something like "Milk? This is butter. Have you been shaking the bottle all the way over here? This is completely useless to me, butter I have more than enough of. Any way someMenki came with another bottle just before you. Here takes these pies to Aono . Oh, and don't forget this receipt.". Step 4 will be the step where the player gives the bad pies to Aono, this step will complete the quest. Step 5 and 6 are the outcome if the player gives the milk directly toOrchibaly. Notice that Step 5 require a NO completion of Step 4. This is actually not necessary for this script, because the previous the other branch of the quest, ending in step 4 closes the quest it self.

'''Example: Alternative Outcome'''
# Step 3 - Player gives bottle of butter to Orchy. And receives 2 pies and a receipt

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Give 2 Pie. Give 1 Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the "bad" pies and the receipt to Aono. Receives gunk as reward and Quest is completed.

Require completion of Delivery for Aono Rikas Step 3

Player gives Orchibaly Gurpleferd 2 Pie, 1 Receipt from Orchibaly.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. [Aono takes a bite at the pie] You have tricked me!

Give 1 Gunk.

Complete Delivery for Aono Rikas Step 4.

Complete Delivery for Aono Rikas.

...
# Step 5 - Player gives the milk directly to Orchibaly.

Require no completion of Delivery for Aono Step 4.

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 5.

... NoRepeat

# Step 6 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Quest Timeout (Passing of time) ==
If you want to allow a certain part of the quest to wait a certain amount of time before it can be a executed, you can use this script:<blockquote>Run script give_quest_timeout <<'Time until Harnquist is ready',6>></blockquote>this will create a temporary active magic with name 'Time until Harnquist is ready' which will last for 6 minutes.

Then in the prerequisite of the step have this:<blockquote># Step 12.

Require active magic Time until Harnquist is ready.

P: swordnotready.

Menu: Is Vresa's sword ready yet?

Harnquist: No, not yet.

...

# Step 13.

Require no active magic Time until Harnquist is ready.

P: about Vresa sword.

Menu: Is Vresa's sword ready?

Harnquist: Yes, Vresa's sword is done. </blockquote>

= Important commands and expressions used =

== Assign Quest. ==
This line tells the engine to assign the quest to the player and generally results in the "YOU GOT A QUEST". and placing the quest in the player's quest log, under "uncompleted". Again remember to be exact here, Capitalize the two words and put a "." at the end. It cannot be emphasized enough that the engine only interprets what it sees and the way it sees it. If you are not precise the quest will NOT happen or in the cases of the next steps move forward.

== ... ==
The three dots mark the beginning of a new step. Better, the three dots create a new step. So you need a "three dots" line before every "Complete Quest Name Step #"

== NoRepeat. ==
This line means that the quest step cannot be done over and over. Note that there are three periods "..." a space and 'NoRepeat.' is one word not two. Each part of this sentence is required in exactly this form.

Basically "..." tells the engine that some time can pass before the next lines are used.

NoRepeat allows this quest step to be only done one time. This also applies to actions as seen in later steps. (in reality NoRepeat is a synonym for Require no completion of "this step")

== Require completion of Quest Name Step #. ==
This command is like a closed door. To open it and enter in the current step the player needs to complete the step number #. You can also refer to a future step (for example, you're on step 4 and add "Require completion of Quest Name Step 8.")

== Require no completion of Quest Name Step #. ==
This command is like an open door. The player is free to continue the quest and entering the current step, UNLESS he completed the step number #. Completing the step number # will close the door. Forever! You can also refer to a future step.

== Complete Quest Name Step #. ==
This command completes a step, # being the step number. You can complete one step in another one. But remember to insert one "..." line for every "Complete Quest Name Step #." line.

== Complete Quest Name. ==
This command will end the quest. After this the quest will be deleted from the uncompleted quest list and appear in the Completed quest list.

== P: ==
The trigger is actually a ghost from the previous scripting system, but it is still needed (for now). Before the player had to type the exact trigger stated after the "P:". Now they click the option from "Menu:". Triggers must be four words or less. Triggers must end with a period, no other punctuation is allowed (question marks especially are known to break aquest on the server).

If you want multiple phrases to activate the same trigger, you can just separate the phrases by a period; for example: "P: about guards. about hydlaa guards. about hydlaa militia." In this case the NPC's response will be fired on any of the three options. This technique can be used also when you have multiple choices: "P: one. two. P: more.". Both 'one' and 'two' will trigger the first response, while 'more' will trigger the second.

WARNING: Triggers cannot contain any of the following words: a, am, an, and, any, anything, are, do, I, is, isnâ€™t, please, that, the, this, to, too.

They also may not contain the name of the NPC you're talking to as that'll be stripped.

These words just take up space in a trigger as they are dropped by the engine when evaluating player response. To make the best use of your word counts ignore them when writing your triggers.

Example: If you wanted the player to say 'please help Levrus' the trigger would become 'help levrus' as please would be an ignored word.

WARNING: If a player needs to write "NPC needs this" syntax it as "NPC wants this".

== Menu: ==
That's easy. After this command you can add the sentence said by the player in game. This sentence will appear on the screen and could be selected when one talks to the NPC.

Remember that for every menu line you need to create a response from the NPC.

== Give ==
Give is a very useful command. It tells the engine to give the player items. Be it rewards or special items needed for the quest. When you reward a player, you can basically give items and/or experience. The syntax to award 1500 experience points would be: "Give 1500 Exp." Note that "Exp" is case-sensitive. You can also reward items AND experience, using this syntax: "Give Leather Gloves. Give 1500 Exp." Remember that you can only have two give commands on the same line, but you can have multiple lines, Remember to keep a clean style, it is prefered to only have one item per line.

'''Example: Give more than two items'''
Give 1 Leather Gloves.
Give 1500 Exp.
Give 1 Apple.

You can also add a number if you need to give more than one item (like you do for experience) example: "Give 5 Iron Ingot." It is not necessary in the case of one item to include the numeral, however it is good practice to do so as numerals tell the engine how many and should be written as a numeral, a word will NOT work as the engine cannot interpret it as such. Remember that all special items must be declared in the script header.

Another option you have is to give one item OR another. The following will pop up a window in which the player has to choose just one item:

'''Example: Give the player a choice between items'''
Give Cold or Arrow or Energy.
'''WARNING:''' At this time, don't use the following in an OR option: Tria, hexa, octa, circles, or items without a graphic. Also, for now, do NOT put quantities in front of items that are given using the "OR" parameter. An example of what NOT to do: "Give 1 Cold or 1 Arrow or 1 Energy." This will lock the server right up. An example of what SHOULD be done: "Give Cold or Arrow or Energy." (Check this statement if it is correct. --Katu)

== Player gives NPC Name 1 Item ==
This can be used as a trigger (instead of the "P:"). It tells the engine to trigger the NPC dialogue when one or any fixed amount of a special item.

When a player have to give multiple items just add them to the original line using a comma:

'''Example Player gives item'''
Player gives Harnquist Water Pouch, 1 Pie.

'''WARNING:''' Item name rules must be followed at all times.

Notice that the item name is "Iron Ingot", so "Iron Ingots" will not work, even if itâ€™s the correct plural form. Keep all names singular.

Also, do not use a number (3, 14, etc) in the name of an item. An item called 3 Circles Receipt will probably generate problems when we script "Give 3 Circles Receipt." It is better named "Three Circles Receipt."

Numbers should be spelled out everywhere unless you are referring to the quantity given or dealing with a trigger (give me 5 apples. give me five apples.) as both would be correct in a trigger.

Character limit for an item name is 60 characters.

Do not use an s' in an item name, like "Levrus' Left Shoe," use "Left Shoe of Levrus" or a similar substitute instead.

== Set variable Require variable ==
You can set a variable to be later used by the quest or other quests. Variables are set on the character and visible from all quests.
Smith: Here is your winch access
Setvariable Quest_Winch_Access 1

You can then require a variable to be set as prerequisite of a quest step.
Require variable Quest_Winch_Access.
P: access.
Menu: I have access
Bobaus: Ok, good.

== Require Compendium ==
You can require the player to have a certain knowledge in the Compendium.
Require compendium creature StoneHammer
P: comps
Menu: I know everything about the StoneHammers!
Fighter3: WOW
...
Require no compendium creature StoneHammer
P: nocomps
Menu: Sorry I dont know anything about StoneHammers!
Fighter3: Ah, study more!

The syntax is: compendium <creature/plant/mineral> <name>

== Rewards at the end of the quest ==
When completing a quest, the player usually gets experience and money, or some items. In particular for experience and money you should use the following scripts. This allows us to split the rewards on a scale from 1 to 10 and then to tweak the actual values in the engine. The values in brackets indicate the complexity of the quest. The more complex the more rewards the player will get.

Run script give_quest_money <<3>>.
Run script give_quest_exp <<2>>.
You can also award faction points by using "give_quest_faction" , the number given is multiplied by 5 so if you want +5 point, you need 1 on the second parameter:
Run script give_quest_faction <<'Essential Trail', 1>>.
We have script also to push the faction point up to a given value, if you are already higher, this script will do nothing.
Run script give_quest_faction_level <<'Essential Trail', 2>>.
value = 1-> max faction points = 10;

value = 2-> max faction points = 20;

value = 3-> max faction points = 35;

value = 4-> max faction points = 55;

value = 5-> max faction points = 75;

value = 6-> max faction points = 100;

value = 7-> max faction points = 125;

value = 8-> max faction points = 150;

value = 9-> max faction points = 200;

If you want to assign a faction title you can use this script. In the example it will assign the second title.
Run script give_quest_faction_title <<'Essential Trail', 2>>.

=== The header ===
The header should contain a lot of information. All the information is commented out by a "#". The example below is from one of the mount quests.

First section is information about the quest itself. Name of the quest, a short description and category. Categories will be discussed in detail later on.

The next sections are for unique items used in the quest, name of the item followed by the description.

The third section is for recording versions of the script and all naming authors. Also who last edited the quest should be noted.

The last section is for additional metadata which will be added to the quest in the database (not part of the db) and will be used by the engine to determine lockouts and prerequisites. Here it locks all players from doing the quest again and locks all other players to take the quest with 60 seconds.

Lastly we tell the engine that the player have to complete the Ring of Familiar quest before this one. Note that these comments aren't taken by the engine; it's the duty of who loads the quest to fill the correct entries with the data found in the header: so it's just a way to keep all data together on the script.

'''Example: Header'''
# Quest name: Drifting for a Drifter
# Quest Description: Taemian wants to sell you a mount
# Quest Category: General
# ----------------------
# Quest Items: Item name/Item description
# Taemian's Pouch: - Pouch with all sorts of coins
# Green Gem of the Drifter - A magical gem with a green glow
# Unsigned Drifter Permit - A permit that still needs to be signed by Datal
# Signed Drifter Permit - A permit that has been signed by Datal
# ----------------------
# Variables used in this quest
# ----------------------
# Quest specific variables used in this quest
# ----------------------
# Author(s): Ravna, Katu, weltall
# Current Version: 1.01
# Player lockout: -1
# Quest lockout: 60
# Prerequisites: <nowiki><pre><completed quest="Ring of Familiar"/></pre></nowiki>
# Variables used: Quest_Variable_Name used to do.....
# ----------------------
# Version history and change log
# Last edited by: weltall
# Version 1.00: Initial draft - 05/01/2010 - Katu.
# Version 1.01: Added extra steps - 1/22/2011 - Venalan.
# ----------------------

==== Quest Lockouts ====
Each quest has two different lockout types:

* Player lockout: When this parameter is set, the engine will wait the specified amount of seconds before allowing the same player to redo the same quest. If you want a quest to be available to each player only one time, then set the lockout to -1. Setting it to 600 will have the engine wait 10 minutes before unlocking the quest again.
* Quest lockout: When this parameter is set, the engine will wait the specified amount of seconds before reactivating the quest for ALL players. This means no one can start the same quest during this period, but the ones that had it already active can complete it.

Usually we want quests to be unique to players, so most have a player lockout -1, except the very simple ones. Try always to think if itâ€™s meaningful for that player to redo it. (For example, Harnquist can require iron ore more than once, but won't need to teach you how to make a sword more than once.)

=== Prerequisites ===
Another more complex version of the prerequisites is the: REQUIRE MIN <number>: this tells the engine that there are specific requirements to be fulfilled before the player is able to get the quest. This script indicated it requires a minimum number of quests to be completed in a given list.

Example: require min 2 of Quest1, Quest2, Quest3.

To match this prerequisite the player can complete Quest1 and Quest3 or 2 and 3, or all 3. The request is minimum 2 in the given list.

CATEGORY MIN <number>: quests have an attribute called "category", we use it to identify the difficulty of quests, but can be used of any other purpose, for example one can say that a group of quests is "Evil" or "Laanx related" or " Newbie". Just one category is allowed per quest. This prerequisite allows you to specify the category and the minimum number of quests completed in that category.

A sample of the coding used to set prerequisites for a quest (All on one line):

'''Example: Prerequisites'''
<nowiki><pre><and></nowiki>
<completed quest="Test Quest One"/>
<completed quest="Test Quest Two"/>
<completed quest="Test Quest Three"/>
<assigned quest="Test Quest Four"/>
<not><completed quest="Delivery for Aono Riskas"/></not>
<not><completed quest="Gorbiak Disease"/></not>
</and><nowiki></pre></nowiki>

This sample requires that the player have completed Test Quests 1 through 3, have Test Quest 4 assigned (not completed) and have NOT completed Fancy Dancing and High-Class Aspirations. To get these arranged correctly can take some practice if one is not familiar with working with booleans, so it is best to include a plain-English comments of what you wish your pre-requisites to be in addition to the one with the "pre" coding statements.

Checks if the player has a certain item equipped . To be documented better

else if (!strncasecmp(block,"equipped",8))

=== More Prerequisites ===
"time of day" // require time of day starthh-endhh (working)

"active magic" (working)

"race" (working)

Example: Require not race Klyros. Require race Kran.

"gender" (working)

Example: Require gender female.

"possessed" (working)

Example: Require possessed item Ruby Crystal.

Example: Require Possessed amount 3 200-300 item Steel Falchion.

it works also with money, as we handle this specifically. It will convert any currency, and check player total money for it.

Example: Require no possessed amount 500 item Tria.

"skill" //Require skill <buffed> name <skillmin>-<skillmax>. (working)

"variable" //Require variable name. (working)

=== Untested Prerequisites ===
Please contact engine in case you want to use any of these prerequisites, because those are untested.

"trait" //require trait name in place

"guild" //NOTE: the both argument is implicitly defined

"known spell"

"married"

= Notes on Creating Quest Files (Rules and Header Information) =

* The quest documents you submit should always be in notepad format: this is to avoid special characters added by Word or other text editors, most notably "smart quotes" which will appear as squares in game. Notepad++ is recommended, HIGHLY recommended.
* Use only ANSI encoding.
* The file name when saving the quest should begin with 'Quest' , then have the name of the quest. For example: Quest Hinoserri Cannot See.txt
* Titles of quests should follow some scheme of capitalization. There are many sets of rules, but a quick and easy format is to capitalize the first word and then all other words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor.
* Each quest script begins with the title and a one or two sentence description; this is what the player reads so keep that in mind. The proper way to do this is to "comment out" your description and quest title, this is done by beginning a line with the number sign or pound symbol (#). Also, any quest item created for your quest should have a description written into the quest. Notes on quest items should also be commented out. Lastly, there should also be a "Quest Category" line that must be commented out as well. Approved quest categories are: Alchemy, Black Flame, Chain (don't use this one unless told), Cooking, Death Realm, Easy, Gugrontid, Magic Ways, Medium, Metal Working, Newbie, Repeatable. This is a work in progress, so if you have any questions ask an associate dev or developer. No quest can have more than one category - pick one and ONLY one. New quest categories must be approved by the associate devs/devs before use.

Quest scripts syntax

2026-04-21T21:10:23Z

Talad: /* More Prerequisites */

= Structure of a quest script =
Quests are written out in chunks called steps. Each step covering the requirements of the previous one.

= Things to know before you start =
Quest scripts should written ideally in a text editor and now in MS Word or similar so that no illegal characters make it into the quest dialog which would result in errors when viewed in game.

Quotes are usually the ones which break the scripts and :

• Only ' " should be used

• ‘ ’ ” “ … These should not be present in the text at all.

Any line of text in the script which begins with a ‘#’ character is ignored by the server and only acts as a comment by the author so that they can leave explanations as to what is happening, or, give information about the step number.

The start of a ‘step’ is defined by a series of three dots ‘...’ Everything after this text up until the next ‘...’ is included in the step. The only unique case is the first step, this does not need ‘...’ and includes all the text before the first ‘...’

== Important rules concerning steps ==

* Every step in the quest should be explicitly completed or locked correctly. Example: "Complete Quest Name Step #" before the Quest is completed.
* A step can require the completion of another step by the command: "Requires completion of Quest Name Step #"
* Step 1 does not exist, step 1 is part of the start script (where you use the command "give me a quest") and cannot be used as a require completion of step number.
* You may have multiple Require Completes at the beginning of a step.
* A step may also require another step NOT to have been completed with the command: "Require no completion of Quest Name Step #".
* The Quest name must be exact! It is case sensitive. The same goes for NPC names.
* Each step should be commented like this: "# Step 2 - A description of actions of this step". # Marks it as a comment not processed by the engine.
* You can also check for statements with this syntax: "Require <no/not> operator1 | <no/not> operator2 | ...| <no/not> operatorN." Where operator is a prerequisite (see below the prerequisite chapter), from completion of to time of day etc. The | represents the OR. ''Example: "Require completion of Questname Step 3 | completion of Questname Step 7."''

Let's see an example before beginning the explanation. The following example is made of two steps.

'''Example: Structure 1'''
P: Short Trigger.

Menu: Do you have any work for me to do?

NPC Name: Yes I do. Just breathe one time.

Assign Quest.

...

P: Ok, I did it!

NPC Name: Great, your quest is completed.

== Syntax Basics ==

=== Comments ===
To create a comment line you must start the line with a "#". These lines are not evaluated by the engine as things that need to be done. These comment lines show what is going on and what are the intentions of the quest writer. This is important because more than one person are often working on a quest script, or eventually for laterbug fixing it will be easier to find the exact problem without reading the entire quest.

Each step in a quest should be started by a comment like this "#Step 2 - Description of step.". You can use comments to more that just noting the step number. Any where within the script you can add comments to help your fellow scripters understand the code. We will use comments to explain things within the scripts here.

=== Trigger and Menu ===
The trigger is for the engine, while the menu is what shows up in the player quest menu. The trigger is defined by a "P:".

P: use to be what the player typed to trigger the step, but with the menu system are now used as a description of what step the player is choosing, for example P:yeshelp. (slide 3). The only time you must use exact text is when a player types the answer to a question you pose them

Because you are talking to the engine it must be exact a colon after the "P:" and a period at the end of the sentence. This is also true of the Menu in every case in which the player (P) says something to the NPC in question "P: Short Trigger." comes first, then below comes the "Menu:" line, with exactly the same requirements.

"Menu": Text is what the player sees when they look at the quest menu.

Please remember that the engine does not think, it reacts to the written cues, so the syntax MUST be exact. The first player statement gives the engine the quest name. The Menu allows the player to ask for the quest from the NPC.

Having the two "P:" and two "Menu:" on the same line informs the engine that the player has two different options. It is standard that the "P:" line is above the "Menu:" line and the "No." answer comes first.

These lines trigger the NPC response. In more elaborate quests the "Menu:" line may have variations on the No. or Yes. response. However remember KISS (Keep It Simple Stupid) is generally a good thing to keep in mind when you are beginning. You can have many options, but remember each "P:" must have a matching "Menu:" and they must be put in the same order

In order to include a free textfield, you will have to include a quotation mark after the menu. The <?> has to be followed by <=> and a text. This will produce a printout of the text and the user will be able to enter a free text. E.g. "Menu: ?=What shall Jardet do?" This will result in the text "What shall Jardet do?" being printed, followed by free form input.

P: *. P: rock pick.
Menu: ?=Please tell me your answer.
Smith: No, you didn't get the right answer.
Smith: Yes, it's a rock pick!.

P: Nothirstyinterst. P: Yesthirstyintrest.
Menu: No, sounds like work. Menu: Sure, I can get it for you.
Serana Tuvi: Alright. I will see you around then, stranger.
Serana Tuvi: Ah, good good.

'''Note:''' Remember the : after the P and Menu are important, as is the . at the end of the line.

'''Note:''' For triggers used to start quests, never use NPC names into it, because this will confuse the engine, and the trigger will not be recognized.

'''Note:''' Every P: used in one step must be on the same line

'''Note:''' Every Menu: used in one step must be on the same line

'''Note:''' Every NPC: used in one step must be on different lines.

=== NPC Response ===
Aono Rikas: here you can add a response.

The line above is interpreted as an answer from the NPC and the engine will extract the name before the colon (:) + space as the NPC involved in this step of the quest. From now on, we will call this a response.

The full name of the NPC is required, just the first name will not work. If it is only one name e.g Harnquist use that, and if your NPC somehow ends up with three names use all of them.

In the first step of a quest the NPC statement will end in a question mark and is triggered by the first 2 lines. Responses are linked to each of the Triggers and Menus. So if you have two triggers you need two menu options and two NPC responses. All arranged in the same order.

=== Dialogues ===
The dialogues are the most important part of the quest for a player to get immersed. So let us talk about how to make the dialogue.

* Every punctuation, exclamation mark and question mark will create a short pause in the dialogue and create a new line.
* To create actions all you have to do is to use square brackets within the dialogue like this "Blablabla [NPC Name picks his nose] Bla bla blabla"

You may use also these commands:

$playerrace can be used in an impersonal and a personal manner in terms of context, consider its usage carefully.

$sir which gives you "Sir" or "Madam" or "Gemma" depending on the gender of the player's character. Again, this can be used to positive and negative effect. Be mindful of the NPCâ€™s tone. (Gemma is the honorific for Kran.)

$playername clearly not to be used in newbie quests, have NPC establish rapport use this in second quest or even the third time a player works with a given NPC.

Give me a quest..

= A sample quest script =

== The first step ==
As previously mentioned Step 1 does not exist, it is just the start of the quest, and can not be required by subsequent steps. The Start of the Quest will look something like the example at the beginning (Structure 1).

The same example can also be scripted like this:

'''Example: Structure 2'''
P: Short trigger.

Menu: Initial question, give me a quest.

NPC Name: Yes, I do have a quest for you. I need you to give Item of Importance to NPC2 Name.

P: Yes P: No.

Menu: Yes, I will do that. Menu: No way stupid.

NPC Name: This is the response from the NPC if answer is Yes.

Give 1 Item of Importance.

Assign Quest.

NPC Name: This is the response from the NPC if answer is No.

In Structure 2 the answers "No" and "Yes" are inverted, like the two "Menu:" commands, so it will give the same result as Structure 1. (Answer No: nothing happens. Answer Yes: the player will get 1Item of Importance and the Quest.)

Now, let us use a more detailed example. We will make a very simple quest: Aono wants to deliver a bottle of milk to Orchibaly. The player can choose the quest from Aono's quest menu. Orchibaly will then give the player 2 pies and a receipt to give back to Aono. The first step will be the step that assigns the quest. The P: tells the engine that this line represents something the player will say to the NPC, but what you must pay extra attention to is the "Menu:" This will be what the player will see as an option in the quest menu. If there are several options you will have to create one "P:" and a "Menu:" for each of them.

Here we firstly gives the player the option to ask for the quest. Then Aono describes the nature of the quest and the player can choose yes or no. Right after the "Menu:" line the NPC responsewill be put. In this example Aono will reply: "Well, I will get someone else to do it for me." if the player says no or "That's great. Here is the milk. Be sure not to spill it. TellOrchibaly I sent you.", give the player 1 Milk Bottle and assign the quest.

'''Example: Assign Quest'''
# Quest: Delivery for Aono Rikas

# Quest Description: Sample Quest.

# The rest of the header will not be covered here.

# Step 1 Aono Rikas in Hydlaa needs someone to deliver milk to Orchibally Gurpleferd in Ojaveda.

P: Delivery for Aono Rikas.

Menu: Are there any jobs you need done?

Aono Rikas: Well, yes. I need some milk delivered to Orchibaly in Ojaveda. Can you do this for me?

P: No. P: Yes.

Menu: No. Menu: Yes.

Aono Rikas: Well I will get someone else to do it for me.

Aono Rikas: That's great. Here is the milk. Be sure not to spill it. Tell Orchibaly I sent you.

Give 1 Milk Bottle.

Assign Quest.

A quest can be automatically assigned or there can be a step at the beginning of the quest to ask the player if he accepts it.

If you want to assign it automatically use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here.
Assign quest.

If you want to ask the player use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here, with the question if you want to help.
P: nohelp. P: yeshelp.
Menu: I don't want to. Menu: Yes I will help.
NPC: Fine... Go away.
NPC: Good great.
Assign quest.

'''Note:''' The “Assign quest.” command will only trigger after the second NPC: dialogue line is triggered, nothing happens if the first is triggered.

== The next step ==
To separate the step we use "..." and then a comment on what step it is and what the step is about. If you don't want this step to be repeatable you will also have to add "NoRepeat" after the "...". The second step does not need a completion of Step 1, because Step 1 does not exist so to speak. The structure will be more or less the same as for the initial step.

Let us continue our Delivery for Aono Quest. We have assigned the quest and the player has been given 1 Milk Bottle to give to Orchibaly. Now the player must give that milk to Orchibaly. Either by using the give GUI or by using the quest menu. The first thing we have to do here is to set up the give trigger. If the player gives Orchibaly the milk, he will answer "Oh, yes the milk. Please give it to me. Now i need you to deliver these two pies and this receipt back toAono.", Give the player 2 pies and a Receipt from Orchibaly. The step is then completed.

In this example although the player is given two pies no "s" is added to the line. This is important, especially because most writers tend to add a plural automatically to plural items. Remember the engine does not. An item is designated in the singular, the engine always interprets it in the singular regardless of the number included. The numbers are again not spelt out and Arabic numerals used. Remember that each "Player gives"-command must have menu option in the next line.

'''Example: Step 2'''
... NoRepeat

# Step 2 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this bottle of milk.

Orchibaly Gurpleferd: Thanks, please give it to me. Now deliver two pies and a receipt back to Aono.

Give 2 Pie. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 2.

Completing a step

At the end of a step remember to insert the line:

"Complete Delivery for Aono Rikas Step 2."

Note the use of Capitals, the use of the quest name, the use of the appropriate numeral and the period at the end of the sentence. The line marks the step as complete and allows the player and the quest to move forward.

== Last step ==
To make sure the player has completed the previous step we start with "Require completion of delivery for Aono step 2.". Then we move on to the trigger which is the player giving 2 pies and the receipt to Aono. Aono answers "Ah, pie. Thank you. Please accept this for your time.", gives the player a pie and 100Tria. The step is closed and so is the quest with "Complete Delivery for Aono Rikas."

'''Example: Last Step'''
...NoRepeat.

# Step 3 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of delivery for Aono step 2.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here are your pies and your receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

'''NOTE:''' If you use multiple options in the last step of a quest you have to explicitly complete the quest with a command for the first option.

'''Example: Last step with multiple options'''

P: No. P: Yes.

Merchant: Quest doesn't complete automatically so make sure you have added a complete line for this response.

Complete Harnquist Needs Gold Step 2. Complete Harnquist Needs Gold.

Merchant: Quest completes automatically because it is the last line in quest so no complete line is required.

Complete Harnquist Needs Gold Step 2.

If you omit the Complete Step and Complete Quest line, the quest will not end properly when choosing "no".

== Branches of a quest (Non exclusive) ==
Some times you want to have several different outcomes for a quest. Let us use the Delivery quest once again. If the first NPC says that you must NOT give the milk to some one else... specially NPC3. Then you should also add the option for the player to actually give the milk to NPC3 . This will complicate your script a bit, but is not as hard as it might seem. Most of the job is done by placing the right "Require completion of" and "Require no completion of" commands.

Let us take a look at that Delivery Quest again. Now we want to add an option for the player to give the milk to Reffitia instead. Reffitia will shake the milk until it becomes butter and this will make Orchibaly angry and demand a new bottle of milk. To do that we will have to add a few more steps and we will start from step 2 as step 1 will be the same as above.

The Third step will be our previous Step 2. And the last step will be the same. Though Aono should mention something like: "Make sure you don't give that milk toReffitia." in Step 1.

IMPORTANT NOTE: This is a non exclusive branching, meaning that the first branch is available also when executing the second one.

IMPORTANT NOTE: We will not add an additional step for the player to get milk again from Aono, but the player have to figure out another way to get hold of it (Buy from an NPC).

'''Example: Branching'''
... NoRepeat

# Step 2 - Alternative is to give the milk to refittia

Player gives 1 Milk Bottle to Reffitia

Menu: Here Reffitia, take this milk.

Reffitia Thamal: Ah! Orchibaly's milk. Here, now you can give the bottle to Orchibaly.

Give 1 Bottle of Butter.

Complete Delivery for Aono Rikas Step 2.

... NoRepeat

# Step 3 - Player gives bottle of butter to Orchy.
# The player then have to find another way of getting a bottle of milk (buy from NPC?)

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 4.

... NoRepeat

# Step 5 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Alternative outcome ==
If we wanted the quest to have a different outcome if the player gives the milk to Reffitia than to Orchibaly we would need to get creative with the require commands. Let us say that if the player gives butter to Orchibaly he will give "bad pies" so when Aono receives them and takes a taste he will be very angry and no reward is given. To do this we will have to add just one more step. Let us start with step 3. Here we will have to change only the NPC response a bit to something like "Milk? This is butter. Have you been shaking the bottle all the way over here? This is completely useless to me, butter I have more than enough of. Any way someMenki came with another bottle just before you. Here takes these pies to Aono . Oh, and don't forget this receipt.". Step 4 will be the step where the player gives the bad pies to Aono, this step will complete the quest. Step 5 and 6 are the outcome if the player gives the milk directly toOrchibaly. Notice that Step 5 require a NO completion of Step 4. This is actually not necessary for this script, because the previous the other branch of the quest, ending in step 4 closes the quest it self.

'''Example: Alternative Outcome'''
# Step 3 - Player gives bottle of butter to Orchy. And receives 2 pies and a receipt

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Give 2 Pie. Give 1 Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the "bad" pies and the receipt to Aono. Receives gunk as reward and Quest is completed.

Require completion of Delivery for Aono Rikas Step 3

Player gives Orchibaly Gurpleferd 2 Pie, 1 Receipt from Orchibaly.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. [Aono takes a bite at the pie] You have tricked me!

Give 1 Gunk.

Complete Delivery for Aono Rikas Step 4.

Complete Delivery for Aono Rikas.

...
# Step 5 - Player gives the milk directly to Orchibaly.

Require no completion of Delivery for Aono Step 4.

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 5.

... NoRepeat

# Step 6 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Quest Timeout (Passing of time) ==
If you want to allow a certain part of the quest to wait a certain amount of time before it can be a executed, you can use this script:<blockquote>Run script give_quest_timeout <<'Time until Harnquist is ready',6>></blockquote>this will create a temporary active magic with name 'Time until Harnquist is ready' which will last for 6 minutes.

Then in the prerequisite of the step have this:<blockquote># Step 12.

Require active magic Time until Harnquist is ready.

P: swordnotready.

Menu: Is Vresa's sword ready yet?

Harnquist: No, not yet.

...

# Step 13.

Require no active magic Time until Harnquist is ready.

P: about Vresa sword.

Menu: Is Vresa's sword ready?

Harnquist: Yes, Vresa's sword is done. </blockquote>

= Important commands and expressions used =

== Assign Quest. ==
This line tells the engine to assign the quest to the player and generally results in the "YOU GOT A QUEST". and placing the quest in the player's quest log, under "uncompleted". Again remember to be exact here, Capitalize the two words and put a "." at the end. It cannot be emphasized enough that the engine only interprets what it sees and the way it sees it. If you are not precise the quest will NOT happen or in the cases of the next steps move forward.

== ... ==
The three dots mark the beginning of a new step. Better, the three dots create a new step. So you need a "three dots" line before every "Complete Quest Name Step #"

== NoRepeat. ==
This line means that the quest step cannot be done over and over. Note that there are three periods "..." a space and 'NoRepeat.' is one word not two. Each part of this sentence is required in exactly this form.

Basically "..." tells the engine that some time can pass before the next lines are used.

NoRepeat allows this quest step to be only done one time. This also applies to actions as seen in later steps. (in reality NoRepeat is a synonym for Require no completion of "this step")

== Require completion of Quest Name Step #. ==
This command is like a closed door. To open it and enter in the current step the player needs to complete the step number #. You can also refer to a future step (for example, you're on step 4 and add "Require completion of Quest Name Step 8.")

== Require no completion of Quest Name Step #. ==
This command is like an open door. The player is free to continue the quest and entering the current step, UNLESS he completed the step number #. Completing the step number # will close the door. Forever! You can also refer to a future step.

== Complete Quest Name Step #. ==
This command completes a step, # being the step number. You can complete one step in another one. But remember to insert one "..." line for every "Complete Quest Name Step #." line.

== Complete Quest Name. ==
This command will end the quest. After this the quest will be deleted from the uncompleted quest list and appear in the Completed quest list.

== P: ==
The trigger is actually a ghost from the previous scripting system, but it is still needed (for now). Before the player had to type the exact trigger stated after the "P:". Now they click the option from "Menu:". Triggers must be four words or less. Triggers must end with a period, no other punctuation is allowed (question marks especially are known to break aquest on the server).

If you want multiple phrases to activate the same trigger, you can just separate the phrases by a period; for example: "P: about guards. about hydlaa guards. about hydlaa militia." In this case the NPC's response will be fired on any of the three options. This technique can be used also when you have multiple choices: "P: one. two. P: more.". Both 'one' and 'two' will trigger the first response, while 'more' will trigger the second.

WARNING: Triggers cannot contain any of the following words: a, am, an, and, any, anything, are, do, I, is, isnâ€™t, please, that, the, this, to, too.

They also may not contain the name of the NPC you're talking to as that'll be stripped.

These words just take up space in a trigger as they are dropped by the engine when evaluating player response. To make the best use of your word counts ignore them when writing your triggers.

Example: If you wanted the player to say 'please help Levrus' the trigger would become 'help levrus' as please would be an ignored word.

WARNING: If a player needs to write "NPC needs this" syntax it as "NPC wants this".

== Menu: ==
That's easy. After this command you can add the sentence said by the player in game. This sentence will appear on the screen and could be selected when one talks to the NPC.

Remember that for every menu line you need to create a response from the NPC.

== Give ==
Give is a very useful command. It tells the engine to give the player items. Be it rewards or special items needed for the quest. When you reward a player, you can basically give items and/or experience. The syntax to award 1500 experience points would be: "Give 1500 Exp." Note that "Exp" is case-sensitive. You can also reward items AND experience, using this syntax: "Give Leather Gloves. Give 1500 Exp." Remember that you can only have two give commands on the same line, but you can have multiple lines, Remember to keep a clean style, it is prefered to only have one item per line.

'''Example: Give more than two items'''
Give 1 Leather Gloves.
Give 1500 Exp.
Give 1 Apple.

You can also add a number if you need to give more than one item (like you do for experience) example: "Give 5 Iron Ingot." It is not necessary in the case of one item to include the numeral, however it is good practice to do so as numerals tell the engine how many and should be written as a numeral, a word will NOT work as the engine cannot interpret it as such. Remember that all special items must be declared in the script header.

Another option you have is to give one item OR another. The following will pop up a window in which the player has to choose just one item:

'''Example: Give the player a choice between items'''
Give Cold or Arrow or Energy.
'''WARNING:''' At this time, don't use the following in an OR option: Tria, hexa, octa, circles, or items without a graphic. Also, for now, do NOT put quantities in front of items that are given using the "OR" parameter. An example of what NOT to do: "Give 1 Cold or 1 Arrow or 1 Energy." This will lock the server right up. An example of what SHOULD be done: "Give Cold or Arrow or Energy." (Check this statement if it is correct. --Katu)

== Player gives NPC Name 1 Item ==
This can be used as a trigger (instead of the "P:"). It tells the engine to trigger the NPC dialogue when one or any fixed amount of a special item.

When a player have to give multiple items just add them to the original line using a comma:

'''Example Player gives item'''
Player gives Harnquist Water Pouch, 1 Pie.

'''WARNING:''' Item name rules must be followed at all times.

Notice that the item name is "Iron Ingot", so "Iron Ingots" will not work, even if itâ€™s the correct plural form. Keep all names singular.

Also, do not use a number (3, 14, etc) in the name of an item. An item called 3 Circles Receipt will probably generate problems when we script "Give 3 Circles Receipt." It is better named "Three Circles Receipt."

Numbers should be spelled out everywhere unless you are referring to the quantity given or dealing with a trigger (give me 5 apples. give me five apples.) as both would be correct in a trigger.

Character limit for an item name is 60 characters.

Do not use an s' in an item name, like "Levrus' Left Shoe," use "Left Shoe of Levrus" or a similar substitute instead.

== Set variable Require variable ==
You can set a variable to be later used by the quest or other quests. Variables are set on the character and visible from all quests.
Smith: Here is your winch access
Setvariable Quest_Winch_Access 1

You can then require a variable to be set as prerequisite of a quest step.
Require variable Quest_Winch_Access.
P: access.
Menu: I have access
Bobaus: Ok, good.

== Require Compendium ==
You can require the player to have a certain knowledge in the Compendium.
Require compendium creature StoneHammer
P: comps
Menu: I know everything about the StoneHammers!
Fighter3: WOW
...
Require no compendium creature StoneHammer
P: nocomps
Menu: Sorry I dont know anything about StoneHammers!
Fighter3: Ah, study more!

The syntax is: compendium <creature/plant/mineral> <name>

== Rewards at the end of the quest ==
When completing a quest, the player usually gets experience and money, or some items. In particular for experience and money you should use the following scripts. This allows us to split the rewards on a scale from 1 to 10 and then to tweak the actual values in the engine. The values in brackets indicate the complexity of the quest. The more complex the more rewards the player will get.

Run script give_quest_money <<3>>.
Run script give_quest_exp <<2>>.
You can also award faction points by using "give_quest_faction" , the number given is multiplied by 5 so if you want +5 point, you need 1 on the second parameter:
Run script give_quest_faction <<'Essential Trail', 1>>.
We have script also to push the faction point up to a given value, if you are already higher, this script will do nothing.
Run script give_quest_faction_level <<'Essential Trail', 2>>.
value = 1-> max faction points = 10;

value = 2-> max faction points = 20;

value = 3-> max faction points = 35;

value = 4-> max faction points = 55;

value = 5-> max faction points = 75;

value = 6-> max faction points = 100;

value = 7-> max faction points = 125;

value = 8-> max faction points = 150;

value = 9-> max faction points = 200;

If you want to assign a faction title you can use this script. In the example it will assign the second title.
Run script give_quest_faction_title <<'Essential Trail', 2>>.

=== The header ===
The header should contain a lot of information. All the information is commented out by a "#". The example below is from one of the mount quests.

First section is information about the quest itself. Name of the quest, a short description and category. Categories will be discussed in detail later on.

The next sections are for unique items used in the quest, name of the item followed by the description.

The third section is for recording versions of the script and all naming authors. Also who last edited the quest should be noted.

The last section is for additional metadata which will be added to the quest in the database (not part of the db) and will be used by the engine to determine lockouts and prerequisites. Here it locks all players from doing the quest again and locks all other players to take the quest with 60 seconds.

Lastly we tell the engine that the player have to complete the Ring of Familiar quest before this one. Note that these comments aren't taken by the engine; it's the duty of who loads the quest to fill the correct entries with the data found in the header: so it's just a way to keep all data together on the script.

'''Example: Header'''
# Quest name: Drifting for a Drifter
# Quest Description: Taemian wants to sell you a mount
# Quest Category: General
# ----------------------
# Quest Items: Item name/Item description
# Taemian's Pouch: - Pouch with all sorts of coins
# Green Gem of the Drifter - A magical gem with a green glow
# Unsigned Drifter Permit - A permit that still needs to be signed by Datal
# Signed Drifter Permit - A permit that has been signed by Datal
# ----------------------
# Variables used in this quest
# ----------------------
# Quest specific variables used in this quest
# ----------------------
# Author(s): Ravna, Katu, weltall
# Current Version: 1.01
# Player lockout: -1
# Quest lockout: 60
# Prerequisites: <nowiki><pre><completed quest="Ring of Familiar"/></pre></nowiki>
# Variables used: Quest_Variable_Name used to do.....
# ----------------------
# Version history and change log
# Last edited by: weltall
# Version 1.00: Initial draft - 05/01/2010 - Katu.
# Version 1.01: Added extra steps - 1/22/2011 - Venalan.
# ----------------------

==== Quest Lockouts ====
Each quest has two different lockout types:

* Player lockout: When this parameter is set, the engine will wait the specified amount of seconds before allowing the same player to redo the same quest. If you want a quest to be available to each player only one time, then set the lockout to -1. Setting it to 600 will have the engine wait 10 minutes before unlocking the quest again.
* Quest lockout: When this parameter is set, the engine will wait the specified amount of seconds before reactivating the quest for ALL players. This means no one can start the same quest during this period, but the ones that had it already active can complete it.

Usually we want quests to be unique to players, so most have a player lockout -1, except the very simple ones. Try always to think if itâ€™s meaningful for that player to redo it. (For example, Harnquist can require iron ore more than once, but won't need to teach you how to make a sword more than once.)

=== Prerequisites ===
Another more complex version of the prerequisites is the: REQUIRE MIN <number>: this tells the engine that there are specific requirements to be fulfilled before the player is able to get the quest. This script indicated it requires a minimum number of quests to be completed in a given list.

Example: require min 2 of Quest1, Quest2, Quest3.

To match this prerequisite the player can complete Quest1 and Quest3 or 2 and 3, or all 3. The request is minimum 2 in the given list.

CATEGORY MIN <number>: quests have an attribute called "category", we use it to identify the difficulty of quests, but can be used of any other purpose, for example one can say that a group of quests is "Evil" or "Laanx related" or " Newbie". Just one category is allowed per quest. This prerequisite allows you to specify the category and the minimum number of quests completed in that category.

A sample of the coding used to set prerequisites for a quest (All on one line):

'''Example: Prerequisites'''
<nowiki><pre><and></nowiki>
<completed quest="Test Quest One"/>
<completed quest="Test Quest Two"/>
<completed quest="Test Quest Three"/>
<assigned quest="Test Quest Four"/>
<not><completed quest="Delivery for Aono Riskas"/></not>
<not><completed quest="Gorbiak Disease"/></not>
</and><nowiki></pre></nowiki>

This sample requires that the player have completed Test Quests 1 through 3, have Test Quest 4 assigned (not completed) and have NOT completed Fancy Dancing and High-Class Aspirations. To get these arranged correctly can take some practice if one is not familiar with working with booleans, so it is best to include a plain-English comments of what you wish your pre-requisites to be in addition to the one with the "pre" coding statements.

Checks if the player has a certain item equipped . To be documented better

else if (!strncasecmp(block,"equipped",8))

=== More Prerequisites ===
"time of day" // require time of day starthh-endhh (working)

"active magic" (working)

"race" (working)

Example: Require not race Klyros. Require race Kran.

"gender" (working)

Example: Require gender female.

"possessed" (working)

Example: Require possessed item Ruby Crystal.

Example: Require Possessed amount 3 200-300 item Steel Falchion.

"skill" //Require skill <buffed> name <skillmin>-<skillmax>. (working)

"variable" //Require variable name. (working)

=== Untested Prerequisites ===
Please contact engine in case you want to use any of these prerequisites, because those are untested.

"trait" //require trait name in place

"guild" //NOTE: the both argument is implicitly defined

"known spell"

"married"

= Notes on Creating Quest Files (Rules and Header Information) =

* The quest documents you submit should always be in notepad format: this is to avoid special characters added by Word or other text editors, most notably "smart quotes" which will appear as squares in game. Notepad++ is recommended, HIGHLY recommended.
* Use only ANSI encoding.
* The file name when saving the quest should begin with 'Quest' , then have the name of the quest. For example: Quest Hinoserri Cannot See.txt
* Titles of quests should follow some scheme of capitalization. There are many sets of rules, but a quick and easy format is to capitalize the first word and then all other words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor.
* Each quest script begins with the title and a one or two sentence description; this is what the player reads so keep that in mind. The proper way to do this is to "comment out" your description and quest title, this is done by beginning a line with the number sign or pound symbol (#). Also, any quest item created for your quest should have a description written into the quest. Notes on quest items should also be commented out. Lastly, there should also be a "Quest Category" line that must be commented out as well. Approved quest categories are: Alchemy, Black Flame, Chain (don't use this one unless told), Cooking, Death Realm, Easy, Gugrontid, Magic Ways, Medium, Metal Working, Newbie, Repeatable. This is a work in progress, so if you have any questions ask an associate dev or developer. No quest can have more than one category - pick one and ONLY one. New quest categories must be approved by the associate devs/devs before use.

Quest scripts syntax

2026-04-21T20:25:39Z

Talad: /* More Prerequisites */

= Structure of a quest script =
Quests are written out in chunks called steps. Each step covering the requirements of the previous one.

= Things to know before you start =
Quest scripts should written ideally in a text editor and now in MS Word or similar so that no illegal characters make it into the quest dialog which would result in errors when viewed in game.

Quotes are usually the ones which break the scripts and :

• Only ' " should be used

• ‘ ’ ” “ … These should not be present in the text at all.

Any line of text in the script which begins with a ‘#’ character is ignored by the server and only acts as a comment by the author so that they can leave explanations as to what is happening, or, give information about the step number.

The start of a ‘step’ is defined by a series of three dots ‘...’ Everything after this text up until the next ‘...’ is included in the step. The only unique case is the first step, this does not need ‘...’ and includes all the text before the first ‘...’

== Important rules concerning steps ==

* Every step in the quest should be explicitly completed or locked correctly. Example: "Complete Quest Name Step #" before the Quest is completed.
* A step can require the completion of another step by the command: "Requires completion of Quest Name Step #"
* Step 1 does not exist, step 1 is part of the start script (where you use the command "give me a quest") and cannot be used as a require completion of step number.
* You may have multiple Require Completes at the beginning of a step.
* A step may also require another step NOT to have been completed with the command: "Require no completion of Quest Name Step #".
* The Quest name must be exact! It is case sensitive. The same goes for NPC names.
* Each step should be commented like this: "# Step 2 - A description of actions of this step". # Marks it as a comment not processed by the engine.
* You can also check for statements with this syntax: "Require <no/not> operator1 | <no/not> operator2 | ...| <no/not> operatorN." Where operator is a prerequisite (see below the prerequisite chapter), from completion of to time of day etc. The | represents the OR. ''Example: "Require completion of Questname Step 3 | completion of Questname Step 7."''

Let's see an example before beginning the explanation. The following example is made of two steps.

'''Example: Structure 1'''
P: Short Trigger.

Menu: Do you have any work for me to do?

NPC Name: Yes I do. Just breathe one time.

Assign Quest.

...

P: Ok, I did it!

NPC Name: Great, your quest is completed.

== Syntax Basics ==

=== Comments ===
To create a comment line you must start the line with a "#". These lines are not evaluated by the engine as things that need to be done. These comment lines show what is going on and what are the intentions of the quest writer. This is important because more than one person are often working on a quest script, or eventually for laterbug fixing it will be easier to find the exact problem without reading the entire quest.

Each step in a quest should be started by a comment like this "#Step 2 - Description of step.". You can use comments to more that just noting the step number. Any where within the script you can add comments to help your fellow scripters understand the code. We will use comments to explain things within the scripts here.

=== Trigger and Menu ===
The trigger is for the engine, while the menu is what shows up in the player quest menu. The trigger is defined by a "P:".

P: use to be what the player typed to trigger the step, but with the menu system are now used as a description of what step the player is choosing, for example P:yeshelp. (slide 3). The only time you must use exact text is when a player types the answer to a question you pose them

Because you are talking to the engine it must be exact a colon after the "P:" and a period at the end of the sentence. This is also true of the Menu in every case in which the player (P) says something to the NPC in question "P: Short Trigger." comes first, then below comes the "Menu:" line, with exactly the same requirements.

"Menu": Text is what the player sees when they look at the quest menu.

Please remember that the engine does not think, it reacts to the written cues, so the syntax MUST be exact. The first player statement gives the engine the quest name. The Menu allows the player to ask for the quest from the NPC.

Having the two "P:" and two "Menu:" on the same line informs the engine that the player has two different options. It is standard that the "P:" line is above the "Menu:" line and the "No." answer comes first.

These lines trigger the NPC response. In more elaborate quests the "Menu:" line may have variations on the No. or Yes. response. However remember KISS (Keep It Simple Stupid) is generally a good thing to keep in mind when you are beginning. You can have many options, but remember each "P:" must have a matching "Menu:" and they must be put in the same order

In order to include a free textfield, you will have to include a quotation mark after the menu. The <?> has to be followed by <=> and a text. This will produce a printout of the text and the user will be able to enter a free text. E.g. "Menu: ?=What shall Jardet do?" This will result in the text "What shall Jardet do?" being printed, followed by free form input.

P: *. P: rock pick.
Menu: ?=Please tell me your answer.
Smith: No, you didn't get the right answer.
Smith: Yes, it's a rock pick!.

P: Nothirstyinterst. P: Yesthirstyintrest.
Menu: No, sounds like work. Menu: Sure, I can get it for you.
Serana Tuvi: Alright. I will see you around then, stranger.
Serana Tuvi: Ah, good good.

'''Note:''' Remember the : after the P and Menu are important, as is the . at the end of the line.

'''Note:''' For triggers used to start quests, never use NPC names into it, because this will confuse the engine, and the trigger will not be recognized.

'''Note:''' Every P: used in one step must be on the same line

'''Note:''' Every Menu: used in one step must be on the same line

'''Note:''' Every NPC: used in one step must be on different lines.

=== NPC Response ===
Aono Rikas: here you can add a response.

The line above is interpreted as an answer from the NPC and the engine will extract the name before the colon (:) + space as the NPC involved in this step of the quest. From now on, we will call this a response.

The full name of the NPC is required, just the first name will not work. If it is only one name e.g Harnquist use that, and if your NPC somehow ends up with three names use all of them.

In the first step of a quest the NPC statement will end in a question mark and is triggered by the first 2 lines. Responses are linked to each of the Triggers and Menus. So if you have two triggers you need two menu options and two NPC responses. All arranged in the same order.

=== Dialogues ===
The dialogues are the most important part of the quest for a player to get immersed. So let us talk about how to make the dialogue.

* Every punctuation, exclamation mark and question mark will create a short pause in the dialogue and create a new line.
* To create actions all you have to do is to use square brackets within the dialogue like this "Blablabla [NPC Name picks his nose] Bla bla blabla"

You may use also these commands:

$playerrace can be used in an impersonal and a personal manner in terms of context, consider its usage carefully.

$sir which gives you "Sir" or "Madam" or "Gemma" depending on the gender of the player's character. Again, this can be used to positive and negative effect. Be mindful of the NPCâ€™s tone. (Gemma is the honorific for Kran.)

$playername clearly not to be used in newbie quests, have NPC establish rapport use this in second quest or even the third time a player works with a given NPC.

Give me a quest..

= A sample quest script =

== The first step ==
As previously mentioned Step 1 does not exist, it is just the start of the quest, and can not be required by subsequent steps. The Start of the Quest will look something like the example at the beginning (Structure 1).

The same example can also be scripted like this:

'''Example: Structure 2'''
P: Short trigger.

Menu: Initial question, give me a quest.

NPC Name: Yes, I do have a quest for you. I need you to give Item of Importance to NPC2 Name.

P: Yes P: No.

Menu: Yes, I will do that. Menu: No way stupid.

NPC Name: This is the response from the NPC if answer is Yes.

Give 1 Item of Importance.

Assign Quest.

NPC Name: This is the response from the NPC if answer is No.

In Structure 2 the answers "No" and "Yes" are inverted, like the two "Menu:" commands, so it will give the same result as Structure 1. (Answer No: nothing happens. Answer Yes: the player will get 1Item of Importance and the Quest.)

Now, let us use a more detailed example. We will make a very simple quest: Aono wants to deliver a bottle of milk to Orchibaly. The player can choose the quest from Aono's quest menu. Orchibaly will then give the player 2 pies and a receipt to give back to Aono. The first step will be the step that assigns the quest. The P: tells the engine that this line represents something the player will say to the NPC, but what you must pay extra attention to is the "Menu:" This will be what the player will see as an option in the quest menu. If there are several options you will have to create one "P:" and a "Menu:" for each of them.

Here we firstly gives the player the option to ask for the quest. Then Aono describes the nature of the quest and the player can choose yes or no. Right after the "Menu:" line the NPC responsewill be put. In this example Aono will reply: "Well, I will get someone else to do it for me." if the player says no or "That's great. Here is the milk. Be sure not to spill it. TellOrchibaly I sent you.", give the player 1 Milk Bottle and assign the quest.

'''Example: Assign Quest'''
# Quest: Delivery for Aono Rikas

# Quest Description: Sample Quest.

# The rest of the header will not be covered here.

# Step 1 Aono Rikas in Hydlaa needs someone to deliver milk to Orchibally Gurpleferd in Ojaveda.

P: Delivery for Aono Rikas.

Menu: Are there any jobs you need done?

Aono Rikas: Well, yes. I need some milk delivered to Orchibaly in Ojaveda. Can you do this for me?

P: No. P: Yes.

Menu: No. Menu: Yes.

Aono Rikas: Well I will get someone else to do it for me.

Aono Rikas: That's great. Here is the milk. Be sure not to spill it. Tell Orchibaly I sent you.

Give 1 Milk Bottle.

Assign Quest.

A quest can be automatically assigned or there can be a step at the beginning of the quest to ask the player if he accepts it.

If you want to assign it automatically use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here.
Assign quest.

If you want to ask the player use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here, with the question if you want to help.
P: nohelp. P: yeshelp.
Menu: I don't want to. Menu: Yes I will help.
NPC: Fine... Go away.
NPC: Good great.
Assign quest.

'''Note:''' The “Assign quest.” command will only trigger after the second NPC: dialogue line is triggered, nothing happens if the first is triggered.

== The next step ==
To separate the step we use "..." and then a comment on what step it is and what the step is about. If you don't want this step to be repeatable you will also have to add "NoRepeat" after the "...". The second step does not need a completion of Step 1, because Step 1 does not exist so to speak. The structure will be more or less the same as for the initial step.

Let us continue our Delivery for Aono Quest. We have assigned the quest and the player has been given 1 Milk Bottle to give to Orchibaly. Now the player must give that milk to Orchibaly. Either by using the give GUI or by using the quest menu. The first thing we have to do here is to set up the give trigger. If the player gives Orchibaly the milk, he will answer "Oh, yes the milk. Please give it to me. Now i need you to deliver these two pies and this receipt back toAono.", Give the player 2 pies and a Receipt from Orchibaly. The step is then completed.

In this example although the player is given two pies no "s" is added to the line. This is important, especially because most writers tend to add a plural automatically to plural items. Remember the engine does not. An item is designated in the singular, the engine always interprets it in the singular regardless of the number included. The numbers are again not spelt out and Arabic numerals used. Remember that each "Player gives"-command must have menu option in the next line.

'''Example: Step 2'''
... NoRepeat

# Step 2 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this bottle of milk.

Orchibaly Gurpleferd: Thanks, please give it to me. Now deliver two pies and a receipt back to Aono.

Give 2 Pie. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 2.

Completing a step

At the end of a step remember to insert the line:

"Complete Delivery for Aono Rikas Step 2."

Note the use of Capitals, the use of the quest name, the use of the appropriate numeral and the period at the end of the sentence. The line marks the step as complete and allows the player and the quest to move forward.

== Last step ==
To make sure the player has completed the previous step we start with "Require completion of delivery for Aono step 2.". Then we move on to the trigger which is the player giving 2 pies and the receipt to Aono. Aono answers "Ah, pie. Thank you. Please accept this for your time.", gives the player a pie and 100Tria. The step is closed and so is the quest with "Complete Delivery for Aono Rikas."

'''Example: Last Step'''
...NoRepeat.

# Step 3 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of delivery for Aono step 2.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here are your pies and your receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

'''NOTE:''' If you use multiple options in the last step of a quest you have to explicitly complete the quest with a command for the first option.

'''Example: Last step with multiple options'''

P: No. P: Yes.

Merchant: Quest doesn't complete automatically so make sure you have added a complete line for this response.

Complete Harnquist Needs Gold Step 2. Complete Harnquist Needs Gold.

Merchant: Quest completes automatically because it is the last line in quest so no complete line is required.

Complete Harnquist Needs Gold Step 2.

If you omit the Complete Step and Complete Quest line, the quest will not end properly when choosing "no".

== Branches of a quest (Non exclusive) ==
Some times you want to have several different outcomes for a quest. Let us use the Delivery quest once again. If the first NPC says that you must NOT give the milk to some one else... specially NPC3. Then you should also add the option for the player to actually give the milk to NPC3 . This will complicate your script a bit, but is not as hard as it might seem. Most of the job is done by placing the right "Require completion of" and "Require no completion of" commands.

Let us take a look at that Delivery Quest again. Now we want to add an option for the player to give the milk to Reffitia instead. Reffitia will shake the milk until it becomes butter and this will make Orchibaly angry and demand a new bottle of milk. To do that we will have to add a few more steps and we will start from step 2 as step 1 will be the same as above.

The Third step will be our previous Step 2. And the last step will be the same. Though Aono should mention something like: "Make sure you don't give that milk toReffitia." in Step 1.

IMPORTANT NOTE: This is a non exclusive branching, meaning that the first branch is available also when executing the second one.

IMPORTANT NOTE: We will not add an additional step for the player to get milk again from Aono, but the player have to figure out another way to get hold of it (Buy from an NPC).

'''Example: Branching'''
... NoRepeat

# Step 2 - Alternative is to give the milk to refittia

Player gives 1 Milk Bottle to Reffitia

Menu: Here Reffitia, take this milk.

Reffitia Thamal: Ah! Orchibaly's milk. Here, now you can give the bottle to Orchibaly.

Give 1 Bottle of Butter.

Complete Delivery for Aono Rikas Step 2.

... NoRepeat

# Step 3 - Player gives bottle of butter to Orchy.
# The player then have to find another way of getting a bottle of milk (buy from NPC?)

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 4.

... NoRepeat

# Step 5 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Alternative outcome ==
If we wanted the quest to have a different outcome if the player gives the milk to Reffitia than to Orchibaly we would need to get creative with the require commands. Let us say that if the player gives butter to Orchibaly he will give "bad pies" so when Aono receives them and takes a taste he will be very angry and no reward is given. To do this we will have to add just one more step. Let us start with step 3. Here we will have to change only the NPC response a bit to something like "Milk? This is butter. Have you been shaking the bottle all the way over here? This is completely useless to me, butter I have more than enough of. Any way someMenki came with another bottle just before you. Here takes these pies to Aono . Oh, and don't forget this receipt.". Step 4 will be the step where the player gives the bad pies to Aono, this step will complete the quest. Step 5 and 6 are the outcome if the player gives the milk directly toOrchibaly. Notice that Step 5 require a NO completion of Step 4. This is actually not necessary for this script, because the previous the other branch of the quest, ending in step 4 closes the quest it self.

'''Example: Alternative Outcome'''
# Step 3 - Player gives bottle of butter to Orchy. And receives 2 pies and a receipt

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Give 2 Pie. Give 1 Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the "bad" pies and the receipt to Aono. Receives gunk as reward and Quest is completed.

Require completion of Delivery for Aono Rikas Step 3

Player gives Orchibaly Gurpleferd 2 Pie, 1 Receipt from Orchibaly.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. [Aono takes a bite at the pie] You have tricked me!

Give 1 Gunk.

Complete Delivery for Aono Rikas Step 4.

Complete Delivery for Aono Rikas.

...
# Step 5 - Player gives the milk directly to Orchibaly.

Require no completion of Delivery for Aono Step 4.

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 5.

... NoRepeat

# Step 6 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Quest Timeout (Passing of time) ==
If you want to allow a certain part of the quest to wait a certain amount of time before it can be a executed, you can use this script:<blockquote>Run script give_quest_timeout <<'Time until Harnquist is ready',6>></blockquote>this will create a temporary active magic with name 'Time until Harnquist is ready' which will last for 6 minutes.

Then in the prerequisite of the step have this:<blockquote># Step 12.

Require active magic Time until Harnquist is ready.

P: swordnotready.

Menu: Is Vresa's sword ready yet?

Harnquist: No, not yet.

...

# Step 13.

Require no active magic Time until Harnquist is ready.

P: about Vresa sword.

Menu: Is Vresa's sword ready?

Harnquist: Yes, Vresa's sword is done. </blockquote>

= Important commands and expressions used =

== Assign Quest. ==
This line tells the engine to assign the quest to the player and generally results in the "YOU GOT A QUEST". and placing the quest in the player's quest log, under "uncompleted". Again remember to be exact here, Capitalize the two words and put a "." at the end. It cannot be emphasized enough that the engine only interprets what it sees and the way it sees it. If you are not precise the quest will NOT happen or in the cases of the next steps move forward.

== ... ==
The three dots mark the beginning of a new step. Better, the three dots create a new step. So you need a "three dots" line before every "Complete Quest Name Step #"

== NoRepeat. ==
This line means that the quest step cannot be done over and over. Note that there are three periods "..." a space and 'NoRepeat.' is one word not two. Each part of this sentence is required in exactly this form.

Basically "..." tells the engine that some time can pass before the next lines are used.

NoRepeat allows this quest step to be only done one time. This also applies to actions as seen in later steps. (in reality NoRepeat is a synonym for Require no completion of "this step")

== Require completion of Quest Name Step #. ==
This command is like a closed door. To open it and enter in the current step the player needs to complete the step number #. You can also refer to a future step (for example, you're on step 4 and add "Require completion of Quest Name Step 8.")

== Require no completion of Quest Name Step #. ==
This command is like an open door. The player is free to continue the quest and entering the current step, UNLESS he completed the step number #. Completing the step number # will close the door. Forever! You can also refer to a future step.

== Complete Quest Name Step #. ==
This command completes a step, # being the step number. You can complete one step in another one. But remember to insert one "..." line for every "Complete Quest Name Step #." line.

== Complete Quest Name. ==
This command will end the quest. After this the quest will be deleted from the uncompleted quest list and appear in the Completed quest list.

== P: ==
The trigger is actually a ghost from the previous scripting system, but it is still needed (for now). Before the player had to type the exact trigger stated after the "P:". Now they click the option from "Menu:". Triggers must be four words or less. Triggers must end with a period, no other punctuation is allowed (question marks especially are known to break aquest on the server).

If you want multiple phrases to activate the same trigger, you can just separate the phrases by a period; for example: "P: about guards. about hydlaa guards. about hydlaa militia." In this case the NPC's response will be fired on any of the three options. This technique can be used also when you have multiple choices: "P: one. two. P: more.". Both 'one' and 'two' will trigger the first response, while 'more' will trigger the second.

WARNING: Triggers cannot contain any of the following words: a, am, an, and, any, anything, are, do, I, is, isnâ€™t, please, that, the, this, to, too.

They also may not contain the name of the NPC you're talking to as that'll be stripped.

These words just take up space in a trigger as they are dropped by the engine when evaluating player response. To make the best use of your word counts ignore them when writing your triggers.

Example: If you wanted the player to say 'please help Levrus' the trigger would become 'help levrus' as please would be an ignored word.

WARNING: If a player needs to write "NPC needs this" syntax it as "NPC wants this".

== Menu: ==
That's easy. After this command you can add the sentence said by the player in game. This sentence will appear on the screen and could be selected when one talks to the NPC.

Remember that for every menu line you need to create a response from the NPC.

== Give ==
Give is a very useful command. It tells the engine to give the player items. Be it rewards or special items needed for the quest. When you reward a player, you can basically give items and/or experience. The syntax to award 1500 experience points would be: "Give 1500 Exp." Note that "Exp" is case-sensitive. You can also reward items AND experience, using this syntax: "Give Leather Gloves. Give 1500 Exp." Remember that you can only have two give commands on the same line, but you can have multiple lines, Remember to keep a clean style, it is prefered to only have one item per line.

'''Example: Give more than two items'''
Give 1 Leather Gloves.
Give 1500 Exp.
Give 1 Apple.

You can also add a number if you need to give more than one item (like you do for experience) example: "Give 5 Iron Ingot." It is not necessary in the case of one item to include the numeral, however it is good practice to do so as numerals tell the engine how many and should be written as a numeral, a word will NOT work as the engine cannot interpret it as such. Remember that all special items must be declared in the script header.

Another option you have is to give one item OR another. The following will pop up a window in which the player has to choose just one item:

'''Example: Give the player a choice between items'''
Give Cold or Arrow or Energy.
'''WARNING:''' At this time, don't use the following in an OR option: Tria, hexa, octa, circles, or items without a graphic. Also, for now, do NOT put quantities in front of items that are given using the "OR" parameter. An example of what NOT to do: "Give 1 Cold or 1 Arrow or 1 Energy." This will lock the server right up. An example of what SHOULD be done: "Give Cold or Arrow or Energy." (Check this statement if it is correct. --Katu)

== Player gives NPC Name 1 Item ==
This can be used as a trigger (instead of the "P:"). It tells the engine to trigger the NPC dialogue when one or any fixed amount of a special item.

When a player have to give multiple items just add them to the original line using a comma:

'''Example Player gives item'''
Player gives Harnquist Water Pouch, 1 Pie.

'''WARNING:''' Item name rules must be followed at all times.

Notice that the item name is "Iron Ingot", so "Iron Ingots" will not work, even if itâ€™s the correct plural form. Keep all names singular.

Also, do not use a number (3, 14, etc) in the name of an item. An item called 3 Circles Receipt will probably generate problems when we script "Give 3 Circles Receipt." It is better named "Three Circles Receipt."

Numbers should be spelled out everywhere unless you are referring to the quantity given or dealing with a trigger (give me 5 apples. give me five apples.) as both would be correct in a trigger.

Character limit for an item name is 60 characters.

Do not use an s' in an item name, like "Levrus' Left Shoe," use "Left Shoe of Levrus" or a similar substitute instead.

== Set variable Require variable ==
You can set a variable to be later used by the quest or other quests. Variables are set on the character and visible from all quests.
Smith: Here is your winch access
Setvariable Quest_Winch_Access 1

You can then require a variable to be set as prerequisite of a quest step.
Require variable Quest_Winch_Access.
P: access.
Menu: I have access
Bobaus: Ok, good.

== Require Compendium ==
You can require the player to have a certain knowledge in the Compendium.
Require compendium creature StoneHammer
P: comps
Menu: I know everything about the StoneHammers!
Fighter3: WOW
...
Require no compendium creature StoneHammer
P: nocomps
Menu: Sorry I dont know anything about StoneHammers!
Fighter3: Ah, study more!

The syntax is: compendium <creature/plant/mineral> <name>

== Rewards at the end of the quest ==
When completing a quest, the player usually gets experience and money, or some items. In particular for experience and money you should use the following scripts. This allows us to split the rewards on a scale from 1 to 10 and then to tweak the actual values in the engine. The values in brackets indicate the complexity of the quest. The more complex the more rewards the player will get.

Run script give_quest_money <<3>>.
Run script give_quest_exp <<2>>.
You can also award faction points by using "give_quest_faction" , the number given is multiplied by 5 so if you want +5 point, you need 1 on the second parameter:
Run script give_quest_faction <<'Essential Trail', 1>>.
We have script also to push the faction point up to a given value, if you are already higher, this script will do nothing.
Run script give_quest_faction_level <<'Essential Trail', 2>>.
value = 1-> max faction points = 10;

value = 2-> max faction points = 20;

value = 3-> max faction points = 35;

value = 4-> max faction points = 55;

value = 5-> max faction points = 75;

value = 6-> max faction points = 100;

value = 7-> max faction points = 125;

value = 8-> max faction points = 150;

value = 9-> max faction points = 200;

If you want to assign a faction title you can use this script. In the example it will assign the second title.
Run script give_quest_faction_title <<'Essential Trail', 2>>.

=== The header ===
The header should contain a lot of information. All the information is commented out by a "#". The example below is from one of the mount quests.

First section is information about the quest itself. Name of the quest, a short description and category. Categories will be discussed in detail later on.

The next sections are for unique items used in the quest, name of the item followed by the description.

The third section is for recording versions of the script and all naming authors. Also who last edited the quest should be noted.

The last section is for additional metadata which will be added to the quest in the database (not part of the db) and will be used by the engine to determine lockouts and prerequisites. Here it locks all players from doing the quest again and locks all other players to take the quest with 60 seconds.

Lastly we tell the engine that the player have to complete the Ring of Familiar quest before this one. Note that these comments aren't taken by the engine; it's the duty of who loads the quest to fill the correct entries with the data found in the header: so it's just a way to keep all data together on the script.

'''Example: Header'''
# Quest name: Drifting for a Drifter
# Quest Description: Taemian wants to sell you a mount
# Quest Category: General
# ----------------------
# Quest Items: Item name/Item description
# Taemian's Pouch: - Pouch with all sorts of coins
# Green Gem of the Drifter - A magical gem with a green glow
# Unsigned Drifter Permit - A permit that still needs to be signed by Datal
# Signed Drifter Permit - A permit that has been signed by Datal
# ----------------------
# Variables used in this quest
# ----------------------
# Quest specific variables used in this quest
# ----------------------
# Author(s): Ravna, Katu, weltall
# Current Version: 1.01
# Player lockout: -1
# Quest lockout: 60
# Prerequisites: <nowiki><pre><completed quest="Ring of Familiar"/></pre></nowiki>
# Variables used: Quest_Variable_Name used to do.....
# ----------------------
# Version history and change log
# Last edited by: weltall
# Version 1.00: Initial draft - 05/01/2010 - Katu.
# Version 1.01: Added extra steps - 1/22/2011 - Venalan.
# ----------------------

==== Quest Lockouts ====
Each quest has two different lockout types:

* Player lockout: When this parameter is set, the engine will wait the specified amount of seconds before allowing the same player to redo the same quest. If you want a quest to be available to each player only one time, then set the lockout to -1. Setting it to 600 will have the engine wait 10 minutes before unlocking the quest again.
* Quest lockout: When this parameter is set, the engine will wait the specified amount of seconds before reactivating the quest for ALL players. This means no one can start the same quest during this period, but the ones that had it already active can complete it.

Usually we want quests to be unique to players, so most have a player lockout -1, except the very simple ones. Try always to think if itâ€™s meaningful for that player to redo it. (For example, Harnquist can require iron ore more than once, but won't need to teach you how to make a sword more than once.)

=== Prerequisites ===
Another more complex version of the prerequisites is the: REQUIRE MIN <number>: this tells the engine that there are specific requirements to be fulfilled before the player is able to get the quest. This script indicated it requires a minimum number of quests to be completed in a given list.

Example: require min 2 of Quest1, Quest2, Quest3.

To match this prerequisite the player can complete Quest1 and Quest3 or 2 and 3, or all 3. The request is minimum 2 in the given list.

CATEGORY MIN <number>: quests have an attribute called "category", we use it to identify the difficulty of quests, but can be used of any other purpose, for example one can say that a group of quests is "Evil" or "Laanx related" or " Newbie". Just one category is allowed per quest. This prerequisite allows you to specify the category and the minimum number of quests completed in that category.

A sample of the coding used to set prerequisites for a quest (All on one line):

'''Example: Prerequisites'''
<nowiki><pre><and></nowiki>
<completed quest="Test Quest One"/>
<completed quest="Test Quest Two"/>
<completed quest="Test Quest Three"/>
<assigned quest="Test Quest Four"/>
<not><completed quest="Delivery for Aono Riskas"/></not>
<not><completed quest="Gorbiak Disease"/></not>
</and><nowiki></pre></nowiki>

This sample requires that the player have completed Test Quests 1 through 3, have Test Quest 4 assigned (not completed) and have NOT completed Fancy Dancing and High-Class Aspirations. To get these arranged correctly can take some practice if one is not familiar with working with booleans, so it is best to include a plain-English comments of what you wish your pre-requisites to be in addition to the one with the "pre" coding statements.

Checks if the player has a certain item equipped . To be documented better

else if (!strncasecmp(block,"equipped",8))

=== More Prerequisites ===
"time of day" // require time of day starthh-endhh (working)

"active magic" (working)

"race" (working)

Example: Require not race Klyros. Require race Kran.

"gender" (working)

Example: Require gender female.

"possessed" (working)

Example: Require possessed item Ruby Crystal.

"skill" //Require skill <buffed> name <skillmin>-<skillmax>. (working)

"variable" //Require variable name. (working)

=== Untested Prerequisites ===
Please contact engine in case you want to use any of these prerequisites, because those are untested.

"trait" //require trait name in place

"guild" //NOTE: the both argument is implicitly defined

"known spell"

"married"

= Notes on Creating Quest Files (Rules and Header Information) =

* The quest documents you submit should always be in notepad format: this is to avoid special characters added by Word or other text editors, most notably "smart quotes" which will appear as squares in game. Notepad++ is recommended, HIGHLY recommended.
* Use only ANSI encoding.
* The file name when saving the quest should begin with 'Quest' , then have the name of the quest. For example: Quest Hinoserri Cannot See.txt
* Titles of quests should follow some scheme of capitalization. There are many sets of rules, but a quick and easy format is to capitalize the first word and then all other words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor.
* Each quest script begins with the title and a one or two sentence description; this is what the player reads so keep that in mind. The proper way to do this is to "comment out" your description and quest title, this is done by beginning a line with the number sign or pound symbol (#). Also, any quest item created for your quest should have a description written into the quest. Notes on quest items should also be commented out. Lastly, there should also be a "Quest Category" line that must be commented out as well. Approved quest categories are: Alchemy, Black Flame, Chain (don't use this one unless told), Cooking, Death Realm, Easy, Gugrontid, Magic Ways, Medium, Metal Working, Newbie, Repeatable. This is a work in progress, so if you have any questions ask an associate dev or developer. No quest can have more than one category - pick one and ONLY one. New quest categories must be approved by the associate devs/devs before use.

PSUnreal Art

2026-04-20T21:31:31Z

Talad: /* Import Assets into Unreal */

== Standards and Methods ==

[[Naming Conventions]]

[[Triangle count standards]]

[[Character rigging]] - setting up a character in blender to be used with the standard ue4 skeleton

[[Characters and Creatures sockets]]

[[Character sizes]]

[[Character Animations]]

[[City design workflow]]

[[Skybox and Lights setup]]

[[Unreal Materials and Textures]]

[[Optimization with Lightmaps, LOD, and Collisions]]

[[PSUnreal Foliage|Foliage]]

[[Maps editing workflow]]

== Import Assets into Unreal ==

[[Import items]]

[[Import Texture with Alpha from GIMP]]

[[Import a level]]

[[Import a char 3DSMAX]]

[[Import Mixamo Animation]]

[[Import a char Blender]]

[[Mirror an animation in Unreal]]

== Export Assets from Unreal ==
I had an issue where a texture coudn't be exported from Unreal. It doesn't have the "Asset Actions -> Export" menu entry at all.

Just copy the reference from unreal in the second line, and change the output line. Run this in Output Log, then select "Python" on the left dropdown.

import unreal

texture = unreal.EditorAssetLibrary.load_asset('/Game/Test/Character/Textures/Hair1.Hair1')

exporter = unreal.TextureExporterPNG()

task = unreal.AssetExportTask()

task.set_editor_property('object', texture)

task.set_editor_property('exporter', exporter)

task.set_editor_property('filename', 'C:/Output/Hair1.png')

task.set_editor_property('replace_identical', True)

task.set_editor_property('prompt', False)

task.set_editor_property('automated', True)

unreal.Exporter.run_asset_export_task(task)

== How things work in PSUnreal ==

[[Rain]]

== New Capabilities ==

[[Interactable Actors]]

== Gimp Tips ==
[[GIMP Custom brushes]]

[[Compendium Maps tokens]]

Quest scripts syntax for AI

2026-04-06T16:27:07Z

Talad:

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

We also have the possibility to have multiple questions and answers in the same step, this is done usually when the discussion is about the same topic and doesn't require a separate QuestNote. In this case the structure is P: , then Menu: , then the npc line. The P must be unique so here we append a letter to the end, example 15005a, 15005b, ... But please note the step number will still be 5. So all Require and Complete will refer to 5, not to 5a or 5b.

When we move to another NPC it's required to have a separate step.

If the dialogue branches and then we need to merge it again in one step later on, we can use the OR operator that's a pipe |. This example requires step 3 or step 4 to be completed:

Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.

A full example follows. In this example there are two parallel possible answers to the NPC question, and also a longer discussion in one last step:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001.
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: Yes I want to help, but I can do it tomorrow.
Harnquist: Ok, come back tomorrow then and please bring me 10 iron ore.
QuestNote I had to ask one more day, and Harnquist asked for 10 iron ore to be delivered tomorrow.
Complete Searching the blacksmith Step 4.

... NoRepeat
# Step 5
Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.
P: 15005.
Menu: I have the ore you requested.
Harnquist: Very good!
P: 15005a.
Menu: Can you evaluate its quality?
Harnquist: Sure I can, let me look. [Harnquist puts on a set of glasses to inspect the ore]
QuestNote I brought the ore to Harnquist.
Complete Searching the blacksmith Step 5.

Quest scripts syntax

2026-04-06T16:23:32Z

Talad: /* Untested Prerequisites */

= Structure of a quest script =
Quests are written out in chunks called steps. Each step covering the requirements of the previous one.

= Things to know before you start =
Quest scripts should written ideally in a text editor and now in MS Word or similar so that no illegal characters make it into the quest dialog which would result in errors when viewed in game.

Quotes are usually the ones which break the scripts and :

• Only ' " should be used

• ‘ ’ ” “ … These should not be present in the text at all.

Any line of text in the script which begins with a ‘#’ character is ignored by the server and only acts as a comment by the author so that they can leave explanations as to what is happening, or, give information about the step number.

The start of a ‘step’ is defined by a series of three dots ‘...’ Everything after this text up until the next ‘...’ is included in the step. The only unique case is the first step, this does not need ‘...’ and includes all the text before the first ‘...’

== Important rules concerning steps ==

* Every step in the quest should be explicitly completed or locked correctly. Example: "Complete Quest Name Step #" before the Quest is completed.
* A step can require the completion of another step by the command: "Requires completion of Quest Name Step #"
* Step 1 does not exist, step 1 is part of the start script (where you use the command "give me a quest") and cannot be used as a require completion of step number.
* You may have multiple Require Completes at the beginning of a step.
* A step may also require another step NOT to have been completed with the command: "Require no completion of Quest Name Step #".
* The Quest name must be exact! It is case sensitive. The same goes for NPC names.
* Each step should be commented like this: "# Step 2 - A description of actions of this step". # Marks it as a comment not processed by the engine.
* You can also check for statements with this syntax: "Require <no/not> operator1 | <no/not> operator2 | ...| <no/not> operatorN." Where operator is a prerequisite (see below the prerequisite chapter), from completion of to time of day etc. The | represents the OR. ''Example: "Require completion of Questname Step 3 | completion of Questname Step 7."''

Let's see an example before beginning the explanation. The following example is made of two steps.

'''Example: Structure 1'''
P: Short Trigger.

Menu: Do you have any work for me to do?

NPC Name: Yes I do. Just breathe one time.

Assign Quest.

...

P: Ok, I did it!

NPC Name: Great, your quest is completed.

== Syntax Basics ==

=== Comments ===
To create a comment line you must start the line with a "#". These lines are not evaluated by the engine as things that need to be done. These comment lines show what is going on and what are the intentions of the quest writer. This is important because more than one person are often working on a quest script, or eventually for laterbug fixing it will be easier to find the exact problem without reading the entire quest.

Each step in a quest should be started by a comment like this "#Step 2 - Description of step.". You can use comments to more that just noting the step number. Any where within the script you can add comments to help your fellow scripters understand the code. We will use comments to explain things within the scripts here.

=== Trigger and Menu ===
The trigger is for the engine, while the menu is what shows up in the player quest menu. The trigger is defined by a "P:".

P: use to be what the player typed to trigger the step, but with the menu system are now used as a description of what step the player is choosing, for example P:yeshelp. (slide 3). The only time you must use exact text is when a player types the answer to a question you pose them

Because you are talking to the engine it must be exact a colon after the "P:" and a period at the end of the sentence. This is also true of the Menu in every case in which the player (P) says something to the NPC in question "P: Short Trigger." comes first, then below comes the "Menu:" line, with exactly the same requirements.

"Menu": Text is what the player sees when they look at the quest menu.

Please remember that the engine does not think, it reacts to the written cues, so the syntax MUST be exact. The first player statement gives the engine the quest name. The Menu allows the player to ask for the quest from the NPC.

Having the two "P:" and two "Menu:" on the same line informs the engine that the player has two different options. It is standard that the "P:" line is above the "Menu:" line and the "No." answer comes first.

These lines trigger the NPC response. In more elaborate quests the "Menu:" line may have variations on the No. or Yes. response. However remember KISS (Keep It Simple Stupid) is generally a good thing to keep in mind when you are beginning. You can have many options, but remember each "P:" must have a matching "Menu:" and they must be put in the same order

In order to include a free textfield, you will have to include a quotation mark after the menu. The <?> has to be followed by <=> and a text. This will produce a printout of the text and the user will be able to enter a free text. E.g. "Menu: ?=What shall Jardet do?" This will result in the text "What shall Jardet do?" being printed, followed by free form input.

P: *. P: rock pick.
Menu: ?=Please tell me your answer.
Smith: No, you didn't get the right answer.
Smith: Yes, it's a rock pick!.

P: Nothirstyinterst. P: Yesthirstyintrest.
Menu: No, sounds like work. Menu: Sure, I can get it for you.
Serana Tuvi: Alright. I will see you around then, stranger.
Serana Tuvi: Ah, good good.

'''Note:''' Remember the : after the P and Menu are important, as is the . at the end of the line.

'''Note:''' For triggers used to start quests, never use NPC names into it, because this will confuse the engine, and the trigger will not be recognized.

'''Note:''' Every P: used in one step must be on the same line

'''Note:''' Every Menu: used in one step must be on the same line

'''Note:''' Every NPC: used in one step must be on different lines.

=== NPC Response ===
Aono Rikas: here you can add a response.

The line above is interpreted as an answer from the NPC and the engine will extract the name before the colon (:) + space as the NPC involved in this step of the quest. From now on, we will call this a response.

The full name of the NPC is required, just the first name will not work. If it is only one name e.g Harnquist use that, and if your NPC somehow ends up with three names use all of them.

In the first step of a quest the NPC statement will end in a question mark and is triggered by the first 2 lines. Responses are linked to each of the Triggers and Menus. So if you have two triggers you need two menu options and two NPC responses. All arranged in the same order.

=== Dialogues ===
The dialogues are the most important part of the quest for a player to get immersed. So let us talk about how to make the dialogue.

* Every punctuation, exclamation mark and question mark will create a short pause in the dialogue and create a new line.
* To create actions all you have to do is to use square brackets within the dialogue like this "Blablabla [NPC Name picks his nose] Bla bla blabla"

You may use also these commands:

$playerrace can be used in an impersonal and a personal manner in terms of context, consider its usage carefully.

$sir which gives you "Sir" or "Madam" or "Gemma" depending on the gender of the player's character. Again, this can be used to positive and negative effect. Be mindful of the NPCâ€™s tone. (Gemma is the honorific for Kran.)

$playername clearly not to be used in newbie quests, have NPC establish rapport use this in second quest or even the third time a player works with a given NPC.

Give me a quest..

= A sample quest script =

== The first step ==
As previously mentioned Step 1 does not exist, it is just the start of the quest, and can not be required by subsequent steps. The Start of the Quest will look something like the example at the beginning (Structure 1).

The same example can also be scripted like this:

'''Example: Structure 2'''
P: Short trigger.

Menu: Initial question, give me a quest.

NPC Name: Yes, I do have a quest for you. I need you to give Item of Importance to NPC2 Name.

P: Yes P: No.

Menu: Yes, I will do that. Menu: No way stupid.

NPC Name: This is the response from the NPC if answer is Yes.

Give 1 Item of Importance.

Assign Quest.

NPC Name: This is the response from the NPC if answer is No.

In Structure 2 the answers "No" and "Yes" are inverted, like the two "Menu:" commands, so it will give the same result as Structure 1. (Answer No: nothing happens. Answer Yes: the player will get 1Item of Importance and the Quest.)

Now, let us use a more detailed example. We will make a very simple quest: Aono wants to deliver a bottle of milk to Orchibaly. The player can choose the quest from Aono's quest menu. Orchibaly will then give the player 2 pies and a receipt to give back to Aono. The first step will be the step that assigns the quest. The P: tells the engine that this line represents something the player will say to the NPC, but what you must pay extra attention to is the "Menu:" This will be what the player will see as an option in the quest menu. If there are several options you will have to create one "P:" and a "Menu:" for each of them.

Here we firstly gives the player the option to ask for the quest. Then Aono describes the nature of the quest and the player can choose yes or no. Right after the "Menu:" line the NPC responsewill be put. In this example Aono will reply: "Well, I will get someone else to do it for me." if the player says no or "That's great. Here is the milk. Be sure not to spill it. TellOrchibaly I sent you.", give the player 1 Milk Bottle and assign the quest.

'''Example: Assign Quest'''
# Quest: Delivery for Aono Rikas

# Quest Description: Sample Quest.

# The rest of the header will not be covered here.

# Step 1 Aono Rikas in Hydlaa needs someone to deliver milk to Orchibally Gurpleferd in Ojaveda.

P: Delivery for Aono Rikas.

Menu: Are there any jobs you need done?

Aono Rikas: Well, yes. I need some milk delivered to Orchibaly in Ojaveda. Can you do this for me?

P: No. P: Yes.

Menu: No. Menu: Yes.

Aono Rikas: Well I will get someone else to do it for me.

Aono Rikas: That's great. Here is the milk. Be sure not to spill it. Tell Orchibaly I sent you.

Give 1 Milk Bottle.

Assign Quest.

A quest can be automatically assigned or there can be a step at the beginning of the quest to ask the player if he accepts it.

If you want to assign it automatically use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here.
Assign quest.

If you want to ask the player use this format:

P: give me a quest. Or any quest trigger.
Menu: what the play sees go here.
NPC: What the NPC says goes here, with the question if you want to help.
P: nohelp. P: yeshelp.
Menu: I don't want to. Menu: Yes I will help.
NPC: Fine... Go away.
NPC: Good great.
Assign quest.

'''Note:''' The “Assign quest.” command will only trigger after the second NPC: dialogue line is triggered, nothing happens if the first is triggered.

== The next step ==
To separate the step we use "..." and then a comment on what step it is and what the step is about. If you don't want this step to be repeatable you will also have to add "NoRepeat" after the "...". The second step does not need a completion of Step 1, because Step 1 does not exist so to speak. The structure will be more or less the same as for the initial step.

Let us continue our Delivery for Aono Quest. We have assigned the quest and the player has been given 1 Milk Bottle to give to Orchibaly. Now the player must give that milk to Orchibaly. Either by using the give GUI or by using the quest menu. The first thing we have to do here is to set up the give trigger. If the player gives Orchibaly the milk, he will answer "Oh, yes the milk. Please give it to me. Now i need you to deliver these two pies and this receipt back toAono.", Give the player 2 pies and a Receipt from Orchibaly. The step is then completed.

In this example although the player is given two pies no "s" is added to the line. This is important, especially because most writers tend to add a plural automatically to plural items. Remember the engine does not. An item is designated in the singular, the engine always interprets it in the singular regardless of the number included. The numbers are again not spelt out and Arabic numerals used. Remember that each "Player gives"-command must have menu option in the next line.

'''Example: Step 2'''
... NoRepeat

# Step 2 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this bottle of milk.

Orchibaly Gurpleferd: Thanks, please give it to me. Now deliver two pies and a receipt back to Aono.

Give 2 Pie. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 2.

Completing a step

At the end of a step remember to insert the line:

"Complete Delivery for Aono Rikas Step 2."

Note the use of Capitals, the use of the quest name, the use of the appropriate numeral and the period at the end of the sentence. The line marks the step as complete and allows the player and the quest to move forward.

== Last step ==
To make sure the player has completed the previous step we start with "Require completion of delivery for Aono step 2.". Then we move on to the trigger which is the player giving 2 pies and the receipt to Aono. Aono answers "Ah, pie. Thank you. Please accept this for your time.", gives the player a pie and 100Tria. The step is closed and so is the quest with "Complete Delivery for Aono Rikas."

'''Example: Last Step'''
...NoRepeat.

# Step 3 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of delivery for Aono step 2.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here are your pies and your receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

'''NOTE:''' If you use multiple options in the last step of a quest you have to explicitly complete the quest with a command for the first option.

'''Example: Last step with multiple options'''

P: No. P: Yes.

Merchant: Quest doesn't complete automatically so make sure you have added a complete line for this response.

Complete Harnquist Needs Gold Step 2. Complete Harnquist Needs Gold.

Merchant: Quest completes automatically because it is the last line in quest so no complete line is required.

Complete Harnquist Needs Gold Step 2.

If you omit the Complete Step and Complete Quest line, the quest will not end properly when choosing "no".

== Branches of a quest (Non exclusive) ==
Some times you want to have several different outcomes for a quest. Let us use the Delivery quest once again. If the first NPC says that you must NOT give the milk to some one else... specially NPC3. Then you should also add the option for the player to actually give the milk to NPC3 . This will complicate your script a bit, but is not as hard as it might seem. Most of the job is done by placing the right "Require completion of" and "Require no completion of" commands.

Let us take a look at that Delivery Quest again. Now we want to add an option for the player to give the milk to Reffitia instead. Reffitia will shake the milk until it becomes butter and this will make Orchibaly angry and demand a new bottle of milk. To do that we will have to add a few more steps and we will start from step 2 as step 1 will be the same as above.

The Third step will be our previous Step 2. And the last step will be the same. Though Aono should mention something like: "Make sure you don't give that milk toReffitia." in Step 1.

IMPORTANT NOTE: This is a non exclusive branching, meaning that the first branch is available also when executing the second one.

IMPORTANT NOTE: We will not add an additional step for the player to get milk again from Aono, but the player have to figure out another way to get hold of it (Buy from an NPC).

'''Example: Branching'''
... NoRepeat

# Step 2 - Alternative is to give the milk to refittia

Player gives 1 Milk Bottle to Reffitia

Menu: Here Reffitia, take this milk.

Reffitia Thamal: Ah! Orchibaly's milk. Here, now you can give the bottle to Orchibaly.

Give 1 Bottle of Butter.

Complete Delivery for Aono Rikas Step 2.

... NoRepeat

# Step 3 - Player gives bottle of butter to Orchy.
# The player then have to find another way of getting a bottle of milk (buy from NPC?)

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the milk to Orchibaly

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 4.

... NoRepeat

# Step 5 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Alternative outcome ==
If we wanted the quest to have a different outcome if the player gives the milk to Reffitia than to Orchibaly we would need to get creative with the require commands. Let us say that if the player gives butter to Orchibaly he will give "bad pies" so when Aono receives them and takes a taste he will be very angry and no reward is given. To do this we will have to add just one more step. Let us start with step 3. Here we will have to change only the NPC response a bit to something like "Milk? This is butter. Have you been shaking the bottle all the way over here? This is completely useless to me, butter I have more than enough of. Any way someMenki came with another bottle just before you. Here takes these pies to Aono . Oh, and don't forget this receipt.". Step 4 will be the step where the player gives the bad pies to Aono, this step will complete the quest. Step 5 and 6 are the outcome if the player gives the milk directly toOrchibaly. Notice that Step 5 require a NO completion of Step 4. This is actually not necessary for this script, because the previous the other branch of the quest, ending in step 4 closes the quest it self.

'''Example: Alternative Outcome'''
# Step 3 - Player gives bottle of butter to Orchy. And receives 2 pies and a receipt

Require completion of Delivery for Aono Rikas Step 2.

Player gives Orchibaly Gurpleferd 1 Bottle of Butter.

Menu: Um, here is the milk from Aono.

Orchibaly Gurpleferd: Milk? This is butter. You better get me another bottle of milk, fast!

Give 2 Pie. Give 1 Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 3.

... NoRepeat

# Step 4 - Player gives the "bad" pies and the receipt to Aono. Receives gunk as reward and Quest is completed.

Require completion of Delivery for Aono Rikas Step 3

Player gives Orchibaly Gurpleferd 2 Pie, 1 Receipt from Orchibaly.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. [Aono takes a bite at the pie] You have tricked me!

Give 1 Gunk.

Complete Delivery for Aono Rikas Step 4.

Complete Delivery for Aono Rikas.

...
# Step 5 - Player gives the milk directly to Orchibaly.

Require no completion of Delivery for Aono Step 4.

Player gives Orchibaly Gurpleferd 1 Milk Bottle.

Menu: Aono asked me to give you this milk.

Orchibaly Gurpleferd: Oh, yes the milk. Now i need you to deliver these two pies and this receipt back to Aono.

Give 2 Pies. Give Receipt from Orchibaly.

Complete Delivery for Aono Rikas Step 5.

... NoRepeat

# Step 6 - Player has now returned to Aono in Hydlaa. Player must now give Aono the 2 Pies and 1 Receipt.

Require completion of Delivery for Aono Rikas Step 4.

Player gives Aono Rikas 2 Pie, 1 Receipt.

Menu: Here take these pies and the receipt.

Aono Rikas: Ah, pie. Thank you. Please accept this for your time.

Give 100 Tria. Give 1 Pie.

Complete Delivery for Aono Rikas.

== Quest Timeout (Passing of time) ==
If you want to allow a certain part of the quest to wait a certain amount of time before it can be a executed, you can use this script:<blockquote>Run script give_quest_timeout <<'Time until Harnquist is ready',6>></blockquote>this will create a temporary active magic with name 'Time until Harnquist is ready' which will last for 6 minutes.

Then in the prerequisite of the step have this:<blockquote># Step 12.

Require active magic Time until Harnquist is ready.

P: swordnotready.

Menu: Is Vresa's sword ready yet?

Harnquist: No, not yet.

...

# Step 13.

Require no active magic Time until Harnquist is ready.

P: about Vresa sword.

Menu: Is Vresa's sword ready?

Harnquist: Yes, Vresa's sword is done. </blockquote>

= Important commands and expressions used =

== Assign Quest. ==
This line tells the engine to assign the quest to the player and generally results in the "YOU GOT A QUEST". and placing the quest in the player's quest log, under "uncompleted". Again remember to be exact here, Capitalize the two words and put a "." at the end. It cannot be emphasized enough that the engine only interprets what it sees and the way it sees it. If you are not precise the quest will NOT happen or in the cases of the next steps move forward.

== ... ==
The three dots mark the beginning of a new step. Better, the three dots create a new step. So you need a "three dots" line before every "Complete Quest Name Step #"

== NoRepeat. ==
This line means that the quest step cannot be done over and over. Note that there are three periods "..." a space and 'NoRepeat.' is one word not two. Each part of this sentence is required in exactly this form.

Basically "..." tells the engine that some time can pass before the next lines are used.

NoRepeat allows this quest step to be only done one time. This also applies to actions as seen in later steps. (in reality NoRepeat is a synonym for Require no completion of "this step")

== Require completion of Quest Name Step #. ==
This command is like a closed door. To open it and enter in the current step the player needs to complete the step number #. You can also refer to a future step (for example, you're on step 4 and add "Require completion of Quest Name Step 8.")

== Require no completion of Quest Name Step #. ==
This command is like an open door. The player is free to continue the quest and entering the current step, UNLESS he completed the step number #. Completing the step number # will close the door. Forever! You can also refer to a future step.

== Complete Quest Name Step #. ==
This command completes a step, # being the step number. You can complete one step in another one. But remember to insert one "..." line for every "Complete Quest Name Step #." line.

== Complete Quest Name. ==
This command will end the quest. After this the quest will be deleted from the uncompleted quest list and appear in the Completed quest list.

== P: ==
The trigger is actually a ghost from the previous scripting system, but it is still needed (for now). Before the player had to type the exact trigger stated after the "P:". Now they click the option from "Menu:". Triggers must be four words or less. Triggers must end with a period, no other punctuation is allowed (question marks especially are known to break aquest on the server).

If you want multiple phrases to activate the same trigger, you can just separate the phrases by a period; for example: "P: about guards. about hydlaa guards. about hydlaa militia." In this case the NPC's response will be fired on any of the three options. This technique can be used also when you have multiple choices: "P: one. two. P: more.". Both 'one' and 'two' will trigger the first response, while 'more' will trigger the second.

WARNING: Triggers cannot contain any of the following words: a, am, an, and, any, anything, are, do, I, is, isnâ€™t, please, that, the, this, to, too.

They also may not contain the name of the NPC you're talking to as that'll be stripped.

These words just take up space in a trigger as they are dropped by the engine when evaluating player response. To make the best use of your word counts ignore them when writing your triggers.

Example: If you wanted the player to say 'please help Levrus' the trigger would become 'help levrus' as please would be an ignored word.

WARNING: If a player needs to write "NPC needs this" syntax it as "NPC wants this".

== Menu: ==
That's easy. After this command you can add the sentence said by the player in game. This sentence will appear on the screen and could be selected when one talks to the NPC.

Remember that for every menu line you need to create a response from the NPC.

== Give ==
Give is a very useful command. It tells the engine to give the player items. Be it rewards or special items needed for the quest. When you reward a player, you can basically give items and/or experience. The syntax to award 1500 experience points would be: "Give 1500 Exp." Note that "Exp" is case-sensitive. You can also reward items AND experience, using this syntax: "Give Leather Gloves. Give 1500 Exp." Remember that you can only have two give commands on the same line, but you can have multiple lines, Remember to keep a clean style, it is prefered to only have one item per line.

'''Example: Give more than two items'''
Give 1 Leather Gloves.
Give 1500 Exp.
Give 1 Apple.

You can also add a number if you need to give more than one item (like you do for experience) example: "Give 5 Iron Ingot." It is not necessary in the case of one item to include the numeral, however it is good practice to do so as numerals tell the engine how many and should be written as a numeral, a word will NOT work as the engine cannot interpret it as such. Remember that all special items must be declared in the script header.

Another option you have is to give one item OR another. The following will pop up a window in which the player has to choose just one item:

'''Example: Give the player a choice between items'''
Give Cold or Arrow or Energy.
'''WARNING:''' At this time, don't use the following in an OR option: Tria, hexa, octa, circles, or items without a graphic. Also, for now, do NOT put quantities in front of items that are given using the "OR" parameter. An example of what NOT to do: "Give 1 Cold or 1 Arrow or 1 Energy." This will lock the server right up. An example of what SHOULD be done: "Give Cold or Arrow or Energy." (Check this statement if it is correct. --Katu)

== Player gives NPC Name 1 Item ==
This can be used as a trigger (instead of the "P:"). It tells the engine to trigger the NPC dialogue when one or any fixed amount of a special item.

When a player have to give multiple items just add them to the original line using a comma:

'''Example Player gives item'''
Player gives Harnquist Water Pouch, 1 Pie.

'''WARNING:''' Item name rules must be followed at all times.

Notice that the item name is "Iron Ingot", so "Iron Ingots" will not work, even if itâ€™s the correct plural form. Keep all names singular.

Also, do not use a number (3, 14, etc) in the name of an item. An item called 3 Circles Receipt will probably generate problems when we script "Give 3 Circles Receipt." It is better named "Three Circles Receipt."

Numbers should be spelled out everywhere unless you are referring to the quantity given or dealing with a trigger (give me 5 apples. give me five apples.) as both would be correct in a trigger.

Character limit for an item name is 60 characters.

Do not use an s' in an item name, like "Levrus' Left Shoe," use "Left Shoe of Levrus" or a similar substitute instead.

== Set variable Require variable ==
You can set a variable to be later used by the quest or other quests. Variables are set on the character and visible from all quests.
Smith: Here is your winch access
Setvariable Quest_Winch_Access 1

You can then require a variable to be set as prerequisite of a quest step.
Require variable Quest_Winch_Access.
P: access.
Menu: I have access
Bobaus: Ok, good.

== Require Compendium ==
You can require the player to have a certain knowledge in the Compendium.
Require compendium creature StoneHammer
P: comps
Menu: I know everything about the StoneHammers!
Fighter3: WOW
...
Require no compendium creature StoneHammer
P: nocomps
Menu: Sorry I dont know anything about StoneHammers!
Fighter3: Ah, study more!

The syntax is: compendium <creature/plant/mineral> <name>

== Rewards at the end of the quest ==
When completing a quest, the player usually gets experience and money, or some items. In particular for experience and money you should use the following scripts. This allows us to split the rewards on a scale from 1 to 10 and then to tweak the actual values in the engine. The values in brackets indicate the complexity of the quest. The more complex the more rewards the player will get.

Run script give_quest_money <<3>>.
Run script give_quest_exp <<2>>.
You can also award faction points by using "give_quest_faction" , the number given is multiplied by 5 so if you want +5 point, you need 1 on the second parameter:
Run script give_quest_faction <<'Essential Trail', 1>>.
We have script also to push the faction point up to a given value, if you are already higher, this script will do nothing.
Run script give_quest_faction_level <<'Essential Trail', 2>>.
value = 1-> max faction points = 10;

value = 2-> max faction points = 20;

value = 3-> max faction points = 35;

value = 4-> max faction points = 55;

value = 5-> max faction points = 75;

value = 6-> max faction points = 100;

value = 7-> max faction points = 125;

value = 8-> max faction points = 150;

value = 9-> max faction points = 200;

If you want to assign a faction title you can use this script. In the example it will assign the second title.
Run script give_quest_faction_title <<'Essential Trail', 2>>.

=== The header ===
The header should contain a lot of information. All the information is commented out by a "#". The example below is from one of the mount quests.

First section is information about the quest itself. Name of the quest, a short description and category. Categories will be discussed in detail later on.

The next sections are for unique items used in the quest, name of the item followed by the description.

The third section is for recording versions of the script and all naming authors. Also who last edited the quest should be noted.

The last section is for additional metadata which will be added to the quest in the database (not part of the db) and will be used by the engine to determine lockouts and prerequisites. Here it locks all players from doing the quest again and locks all other players to take the quest with 60 seconds.

Lastly we tell the engine that the player have to complete the Ring of Familiar quest before this one. Note that these comments aren't taken by the engine; it's the duty of who loads the quest to fill the correct entries with the data found in the header: so it's just a way to keep all data together on the script.

'''Example: Header'''
# Quest name: Drifting for a Drifter
# Quest Description: Taemian wants to sell you a mount
# Quest Category: General
# ----------------------
# Quest Items: Item name/Item description
# Taemian's Pouch: - Pouch with all sorts of coins
# Green Gem of the Drifter - A magical gem with a green glow
# Unsigned Drifter Permit - A permit that still needs to be signed by Datal
# Signed Drifter Permit - A permit that has been signed by Datal
# ----------------------
# Variables used in this quest
# ----------------------
# Quest specific variables used in this quest
# ----------------------
# Author(s): Ravna, Katu, weltall
# Current Version: 1.01
# Player lockout: -1
# Quest lockout: 60
# Prerequisites: <nowiki><pre><completed quest="Ring of Familiar"/></pre></nowiki>
# Variables used: Quest_Variable_Name used to do.....
# ----------------------
# Version history and change log
# Last edited by: weltall
# Version 1.00: Initial draft - 05/01/2010 - Katu.
# Version 1.01: Added extra steps - 1/22/2011 - Venalan.
# ----------------------

==== Quest Lockouts ====
Each quest has two different lockout types:

* Player lockout: When this parameter is set, the engine will wait the specified amount of seconds before allowing the same player to redo the same quest. If you want a quest to be available to each player only one time, then set the lockout to -1. Setting it to 600 will have the engine wait 10 minutes before unlocking the quest again.
* Quest lockout: When this parameter is set, the engine will wait the specified amount of seconds before reactivating the quest for ALL players. This means no one can start the same quest during this period, but the ones that had it already active can complete it.

Usually we want quests to be unique to players, so most have a player lockout -1, except the very simple ones. Try always to think if itâ€™s meaningful for that player to redo it. (For example, Harnquist can require iron ore more than once, but won't need to teach you how to make a sword more than once.)

=== Prerequisites ===
Another more complex version of the prerequisites is the: REQUIRE MIN <number>: this tells the engine that there are specific requirements to be fulfilled before the player is able to get the quest. This script indicated it requires a minimum number of quests to be completed in a given list.

Example: require min 2 of Quest1, Quest2, Quest3.

To match this prerequisite the player can complete Quest1 and Quest3 or 2 and 3, or all 3. The request is minimum 2 in the given list.

CATEGORY MIN <number>: quests have an attribute called "category", we use it to identify the difficulty of quests, but can be used of any other purpose, for example one can say that a group of quests is "Evil" or "Laanx related" or " Newbie". Just one category is allowed per quest. This prerequisite allows you to specify the category and the minimum number of quests completed in that category.

A sample of the coding used to set prerequisites for a quest (All on one line):

'''Example: Prerequisites'''
<nowiki><pre><and></nowiki>
<completed quest="Test Quest One"/>
<completed quest="Test Quest Two"/>
<completed quest="Test Quest Three"/>
<assigned quest="Test Quest Four"/>
<not><completed quest="Delivery for Aono Riskas"/></not>
<not><completed quest="Gorbiak Disease"/></not>
</and><nowiki></pre></nowiki>

This sample requires that the player have completed Test Quests 1 through 3, have Test Quest 4 assigned (not completed) and have NOT completed Fancy Dancing and High-Class Aspirations. To get these arranged correctly can take some practice if one is not familiar with working with booleans, so it is best to include a plain-English comments of what you wish your pre-requisites to be in addition to the one with the "pre" coding statements.

Checks if the player has a certain item equipped . To be documented better

else if (!strncasecmp(block,"equipped",8))

=== More Prerequisites ===
"time of day" // require time of day starthh-endhh (working)

"active magic" (working)

"race" (working)

Example: Require not race Klyros. Require race Kran.

"gender" (working)

Example: Require gender female.

"possessed" (working)

"skill" //Require skill <buffed> name <skillmin>-<skillmax>. (working)

"variable" //Require variable name. (working)

=== Untested Prerequisites ===
Please contact engine in case you want to use any of these prerequisites, because those are untested.

"trait" //require trait name in place

"guild" //NOTE: the both argument is implicitly defined

"known spell"

"married"

= Notes on Creating Quest Files (Rules and Header Information) =

* The quest documents you submit should always be in notepad format: this is to avoid special characters added by Word or other text editors, most notably "smart quotes" which will appear as squares in game. Notepad++ is recommended, HIGHLY recommended.
* Use only ANSI encoding.
* The file name when saving the quest should begin with 'Quest' , then have the name of the quest. For example: Quest Hinoserri Cannot See.txt
* Titles of quests should follow some scheme of capitalization. There are many sets of rules, but a quick and easy format is to capitalize the first word and then all other words, except a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor.
* Each quest script begins with the title and a one or two sentence description; this is what the player reads so keep that in mind. The proper way to do this is to "comment out" your description and quest title, this is done by beginning a line with the number sign or pound symbol (#). Also, any quest item created for your quest should have a description written into the quest. Notes on quest items should also be commented out. Lastly, there should also be a "Quest Category" line that must be commented out as well. Approved quest categories are: Alchemy, Black Flame, Chain (don't use this one unless told), Cooking, Death Realm, Easy, Gugrontid, Magic Ways, Medium, Metal Working, Newbie, Repeatable. This is a work in progress, so if you have any questions ask an associate dev or developer. No quest can have more than one category - pick one and ONLY one. New quest categories must be approved by the associate devs/devs before use.

Quest scripts syntax for AI

2026-04-06T16:17:00Z

Talad:

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

We also have the possibility to have multiple questions and answers in the same step, this is done usually when the discussion is about the same topic and doesn't require a separate QuestNote. In this case the structure is P: , then Menu: , then the npc line. The P must be unique so here we append a letter to the end, example 15005a, 15005b, ...

When we move to another NPC it's required to have a separate step.

If the dialogue branches and then we need to merge it again in one step later on, we can use the OR operator that's a pipe |. This example requires step 3 or step 4 to be completed:

Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.

A full example follows. In this example there are two parallel possible answers to the NPC question, and also a longer discussion in one last step:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001.
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: Yes I want to help, but I can do it tomorrow.
Harnquist: Ok, come back tomorrow then and please bring me 10 iron ore.
QuestNote I had to ask one more day, and Harnquist asked for 10 iron ore to be delivered tomorrow.
Complete Searching the blacksmith Step 4.

... NoRepeat
# Step 5
Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.
P: 15005.
Menu: I have the ore you requested.
Harnquist: Very good!
P: 15005a.
Menu: Can you evaluate its quality?
Harnquist: Sure I can, let me look. [Harnquist puts on a set of glasses to inspect the ore]
QuestNote I brought the ore to Harnquist.
Complete Searching the blacksmith Step 5.

Quest scripts syntax for AI

2026-04-06T15:59:02Z

Talad:

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

We also have the possibility to have multiple questions and answers in the same step, this is done usually when the discussion is about the same topic and doesn't require a separate QuestNote. In this case the structure is P: , then Menu: , then the npc line. The P must be unique so here we append a letter to the end, example 15005a, 15005b, ...

When we move to another NPC it's required to have a separate step.

If the dialogue branches and then we need to merge it again in one step later on, we can use the OR operator that's a pipe |. This example requires step 3 or step 4 to be completed:

Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.

A full example follows. In this example there are two parallel possible answers to the NPC question, and also a longer discussion in one last step:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: Yes I want to help, but I can do it tomorrow.
Harnquist: Ok, come back tomorrow then and please bring me 10 iron ore.
QuestNote I had to ask one more day, and Harnquist asked for 10 iron ore to be delivered tomorrow.
Complete Searching the blacksmith Step 4.

... NoRepeat
# Step 5
Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.
P: 15005.
Menu: I have the ore you requested.
Harnquist: Very good!
P: 15005a.
Menu: Can you evaluate its quality?
Harnquist: Sure I can, let me look. [Harnquist puts on a set of glasses to inspect the ore]
QuestNote I brought the ore to Harnquist.
Complete Searching the blacksmith Step 5.

Quest scripts syntax for AI

2026-04-06T15:32:36Z

Talad:

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

We also have the possibility to have multiple questions and answers in the same step, this is done usually when the discussion is about the same topic and doesn't require a separate QuestNote.

When we move to another NPC it's required to have a separate step.

If the dialogue branches and then we need to merge it again in one step later on, we can use the OR operator that's a pipe |. This example requires step 3 or step 4 to be completed:

Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.

A full example follows. In this example there are two parallel possible answers to the NPC question, and also a longer discussion in one last step:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: Yes I want to help, but I can do it tomorrow.
Harnquist: Ok, come back tomorrow then and please bring me 10 iron ore.
QuestNote I had to ask one more day, and Harnquist asked for 10 iron ore to be delivered tomorrow.
Complete Searching the blacksmith Step 4.

... NoRepeat
# Step 5
Require completion of Searching the blacksmith step 3 | completion of Searching the blacksmith step 4.
P: 15005.
Menu: I have the ore you requested.
Harnquist: Very good!
QuestNote I brought the ore to Harnquist.
Complete Searching the blacksmith Step 5.

Quest scripts syntax for AI

2026-04-06T15:25:54Z

Talad:

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

Example:

# Quest: Searching the blacksmith
# ID: 1500

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002.

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

Every step must finish with a line that completes the step, example:

Complete Searching the blacksmith Step 2.

The first step is a different than the others in this way:
1) it doesn't have a Require completion of
2) instead of the "Complete" step line, it has "Assign Quest." line, which basically stores the quest in the player log as started.

The second step differs just for the fact it doesn't have a "Require completion of" line.

We also use brackets [] to indicate some visual action from the NPC, example:

Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword.

All lines except comments should always end with a period or a question/exclamation mark. This is how the engine knows that directive is completed.

A full example follows. In this example there are two parallel possible answers to the NPC question:

# Quest: Searching the blacksmith
# ID: 1500

P: 15001
Menu: Hello, who are you?
Harnquist: I'm the local blacksmith!
QuestNote You met Harnquist the local blacksmith.
Assign Quest.

... NoRepeat
# Step 2
P: 15002.
Menu: Do you need any help?
Harnquist: [He seems pleased by your question] Yes I need to forge a new longsword. Are you interested in it?
QuestNote Harnquist asked if we want to help forging a new longsword.
Complete Searching the blacksmith Step 2.

... NoRepeat
# Step 3
Require completion of Searching the blacksmith step 2.
P: 15003.
Menu: Yes, sure I would like help.
Harnquist: Great, then please bring me 10 iron ore.
QuestNote I agreed to help, and Harnquist asked for 10 iron ore.
Complete Searching the blacksmith Step 3.

... NoRepeat
# Step 4
Require completion of Searching the blacksmith step 2.
P: 15004.
Menu: No sorry, I cannot do it right now.
Harnquist: Ok, come back later then.
QuestNote I had to refuse Harnquist offer for now.
Complete Searching the blacksmith Step 4.

Quest scripts syntax for AI

2026-04-06T14:54:43Z

Talad: Created page with "This is the syntax to create a quest script. Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments. The quest script is divided in steps. Each one being separated with this line: ... NoRepeat This line tells the engine to create a new step. Only the first step does not have the ... line Every step starting from the second one, start with a comment stating the step number, this is important for readability. Exam..."

This is the syntax to create a quest script.

Any line starting with # is a comment. We add at the start of the file the name and prerequisites as comments.

The quest script is divided in steps. Each one being separated with this line:

... NoRepeat

This line tells the engine to create a new step. Only the first step does not have the ... line

Every step starting from the second one, start with a comment stating the step number, this is important for readability. Example:

# Step 2

Each step can have a prerequisite step to be executed, example step 3 will require step 2 to be executed. If you have parallel steps, then the requirement for step 3 and step 4 can all point to step 2.

Requiments are expressed like this, where we substitute <quest name> with the name of the quest:

Require completion of <quest name> step 2.

Every step must have a P: line with the questid plus a progressive number, which corresponds to the step. Example, assuming our quest number is 1500, and step is 2:

P: 15002

Every step must have a Menu: line . This is what the player will select from the possible speak options. Example:

Menu: Hello, who are you?

Every step must have a line with the answer from the NPC, which starts with the name of the NPC, example:

Harnquist: I'm the local blacksmith!

Every step must have a quest note that goes into the player journal summarizing what he accomplished or learned in that step. Example:

QuestNote You met Harnquist the local blacksmith.

# Quest name

Instances

2026-03-07T22:22:29Z

Talad: Created page with "== I'''nstance 0''' == This is the default instance where player are placed when created, and where all our NPCs and visible items are. Loaded by the server always. == '''Instance 1''' == Is reserved to: * guildhouse locks, which are real item placed on the ground, that connect the door with the actual guildhouse instance * Action location containers, example a forge connected to a 3d mesh in the level, maybe have a container representing the forge in instance 1. The..."

== I'''nstance 0''' ==
This is the default instance where player are placed when created, and where all our NPCs and visible items are.

Loaded by the server always.

== '''Instance 1''' ==
Is reserved to:

* guildhouse locks, which are real item placed on the ground, that connect the door with the actual guildhouse instance
* Action location containers, example a forge connected to a 3d mesh in the level, maybe have a container representing the forge in instance 1. The container will not be visible by the player directly, but will be accessed when he click on the action location

Loaded by the server always.

== '''Instances >1 and <first guildhouse''' ==
This at the moment is no man's lands because it's not loaded by the server at startup, and is not a guildhouse and so not loaded dynamically.

== '''Guildhouse Instances''' ==
Based on the lock item_instances id we determine the instance where the guildhouse is located. Anyway guildhouses have unique coordinates and are neven overlapping.

At the moment the lowest one is '''1000'''.

Loaded by the server on demand when the first player enters the guildhouse.

PSUnreal Config

2026-03-07T22:13:36Z

Talad: /* Dynamic elements */

== Static elements ==

* [[Config Races]]

* [[Config Character Creation]]

* [[How to define Sectors]]

* [[Music and Ambience Sounds]]
*[[Creatures and Attack sounds]]
*[[Creatures, Attack Types and Attacks]]

* Lights

* [[HowtoAddASpellToTheDatabase|Howto add a spell to the database.]]
*[[Combat and chase acceptance range]]
*[[Factions and Organizations]]
*[[Weapon Trails]]
*[[Voiceovers (audio files)]]

== Dynamic elements ==

* [[PSUnreal Proximity Triggers]]

* [[Random Generated events]]

* [[Hunt Locations and Natural Resources]]

* [[Levers and Interactable Objects]]

* [[Traps]]
* [[Instances]]
*[[Loot]]
*[[PSUnreal Guildhouses|Guildhouses (action locations)]]
*[[Setting Items]]
*[[Add new NPC]]
*[[Add Waypoints and paths]]
*[[Minigames]]
*[[Procedural Dungeon Generation]]
*[[Reload - Reloading at runtime]]
*[[PSUnreal Fishing Setup|Fishing Setup]]

== Npcs ==

* Behaviours: Nearly all we have is documented in [[NpcClient Design|this page]] and its sub pages
* [[KAs (Knowledge Areas) list and structure|Knowledge Areas]] (for dialogues)

== Quests ==

* [[Quest scripts syntax]]

== Mechanisms ==
TODO

Tribe Design

2026-02-17T21:35:42Z

Talad: Undo revision 25740 by Talad (talk)

= Tribe Design =

The tribe design is done using [[Behaviors_and_Reactions|NPC Behaviors]] and [[Tribe_Scripting|Recipes]]. Tribe members are assigned tasks based on what the recipes dictates the tribe to achieve. This system uses a Recipe Manager which takes care of parsing recipes, breaking the initial recipe into subtasks and telling the npcs which action to take.

== Classes ==
<uml>
scale 0.8
Tribe "1" *-- "0..N" NPC : members
Tribe "1" *-- "0..N" NPC : deadMembers
Tribe "1" *-- "0..N" Resource : resources
Tribe "1" *-- "0..N" Memory : memories
Tribe "1" *-- "0..N" Asset : assets
Tribe "1" *-- "0..N" Knowledge : knowledge
Tribe "1" *-- "1..1" RecipeTreeNode : recipes
RecipeTreeNode *-- Recipe
RecipeManager "1" *-- "N..1" Recipe : all recipes
</uml>

''' Members '''

Tribe members (both dead & alive) are kept in an array in the Tribe Class. They are all represented by the NPC class. The tribal class only has methods to attach a tribe member. For spawning new members the server (gemSupervisor & entityManager classes) and the npcclient class are responsable.

Tribe members can have different types. (Discussion needed about tribe types)

Tribe members are being kept in the 'tribe_members' mysql table.

''' Resources '''

A resource is kept in a data structure (''Tribe::Resource'') containing it's name, nick and quantity. The tribe class has methods for adding, modifying, storing and completely deleting resources.

Resources are being kept in the 'sc_tribe_resources' mysql table.

''' Memories '''

A memory is a location of some importance to the tribe. (E.g. a mine, a field, an enemy, etc)

A memory is kept in a data structure (''Tribe::Memory'') containing it's location (sector & coords), it's name and a link to an NPC (which is NULL if the memory is public to all tribe members, or != NULL if it's private to a tribe member). The tribe object has methods to add, store, modify and search memories.

Tribe members also have a memory slot for keeping it's current task location. (see bufferMemory attribute of NPC class).

Tribe memories are being kept in the 'sc_tribe_memories' mysql table.

''' Assets '''

Assets are belongings of the tribe. They can represent buildings, items or spots to be built in the future.

An asset is represented by a data structure (''Tribe::Asset'') containing it's location (sector & coords), it's name, it's quantity (relevant just for items) and it's type (Building Spot, Building or Item). The tribe class has methods for adding, editing and deleting assets. It also has methods for managing buildings. (e.g. Replace a building spot with the actual building after the workers built it)

Tribe assets are being kept in the 'sc_tribe_assets' mysql table.

''' Knowledge '''

Knowledge represents the information the tribe has gathered and the technologies they can use. (E.g. Ironworks, pottery, horseback riding, alphabet, math, etc)

Technically, they are just strings used as tokens to prove the tribe has acquired knowledge or not.

Knowledge is kept in an array of strings.

Tribe knowledge is being kept in the 'sc_tribe_knowledge' mysql table.

''' Recipe Tree Node '''

This class represents a node of the recipe tree describing the tribe current tasks. Each recipe tree node contains a link to it's recipe, waiting times, current requirement, current algorithm step and relationship information regarding other recipes. (just as a standard Tree, it may have parents and descendants).

RecipeTreeNodes are not being stored in any database. They are just used during runtime as an AI for tribes.

''' Recipe '''

A recipe is a set of requirements and algorithm steps regarding a task that needs to be done. Recipes can vary from simple (Gather a resource) to very complex (Build an entire civilization).

Recipes are being stored in the 'tribe_recipes' mysql table.

== Sequences ==

=== Advance Sequence ===

Advance sequence is the heart of the Tribe system. The NPCClient will advance the brain 4 times a second. On each loop, this sequence takes care of special cases (e.g.: 0 npcs alive in tribe) and assigns tasks to idle members.

<uml>
-> NPCClient : Advance
activate NPCClient
loop For each tribe
NPCClient -> Tribe : Advance
activate Tribe
Tribe -> Tribe : AdvanceResources
Tribe -> Tribe : AddCyclicRecipes
loop For each member
alt For NPC's that have the tribe's idle behavior
Tribe -> Tribe : Get highest priority recipe
Tribe -> RecipeManager : Apply Recipe
activate RecipeManager
Tribe <- RecipeManager
deactivate RecipeManager
end
end
NPCClient <-- Tribe
deactivate Tribe
end
<-- NPCClient
deactivate NPCClient
</uml>

== Setting up tribes ==
There are 3 main database tables that need to be populated.

* [[TribesTable|tribes]]
** Each row represents one tribe, which must have a home position/sector and a radius in which to resurrect dead members.
** max_size sets the maximum number of members.
** wealth_resource sets the different types of resource that a tribe can mine in order to grow and/or sustain itself. This needs more work however the most important one is wealth_resource_growth which is the default rate at which a resource will grow without any work per second.
** reproduction_cost is the amount of resources required to reproduce.
** tribal_recipe loads the initial recipe that sets tribe traits and loads tribe goals (recipes)

* tribe_members
** Each row is an association between a PID (on the server side) and a tribe.

* tribe_recipes
** Each row represents a recipe (name,requirements,algorithm). This table needs to be loaded in order to order tribe members what to do. Not having recipes, or requesting a recipe that does not exist will result in a termination of the npcclient.

Additionally, tables for extra tribe info need to be created:
*sc_tribe_assets
*sc_tribe_knowledge
*sc_tribe_memories
*sc_tribe_resources

== Tribe day-to-day life ==

Tribe members are normal NPCs. They all expand a base NPCType called 'AbstractTribesman', on which each tribe adds it's own particularities (e.g. when to go to sleep, what to do when they meet a stranger, etc). Read more on [[NPC Scripting]]. The 'AbstractTribesman' contains behaviors that describe generic actions: breeding, gathering, mining, fighting, exploring and working. (trading to be added soon). These generic behaviors use some data buffers to read data from during runtime in order to execute the same behavior on different data. (different mines, different fields, different building places, etc)

Upon parsing recipes, different perceptions are fired on the tribesmen. This process simulates a working society on which a superior entity assigns tasks to the population.

== Tribe death ==
When all the members die, then a member will be resurrected if there are 10*reproduction_cost resources available.

= Runtime =

==Step #1 (Loading)==

(executed only once, on NPCClient's startup. No further interrogation on the database should be done)

On NPCClient's startup everything is loaded into the classes.

1) The Recipe Manager loads all available recipes from mysql:'tribe_recipes' and add those in a flat array "recipes", one entry per recipe.

2) psNPCManager::LoadTribes() loads from the database all the tribes from mysql:'tribes'

3) For each tribe psNPCManager::LoadTribes() loads all the information regarding the tribe:
*resources from mysql:'sc_tribe_resources'
*memories from mysql:'sc_tribe_memories'
*knowledge from mysql:'sc_tribe_knowledge'
*assets from mysql:'sc_tribe_assets'
*basic tribe information from mysql:'tribes' (including the ID of the tribal recipe, more details below)
*npc's are loaded by the psNPCClient and assigned to the tribe

4) For each tribe it calls RecipeManager::AddTribe() , which parses the requirements and keeps them in the Recipe Class. (Recipe::requirements<Recipe::Requirement>)

5) Further on, each Tribal Object is linked to the Recipe Manager. (a pointer is sent and loaded into a csArray)
For each tribe loaded, the Recipe Manager does the following:
* assembles a data structure named 'TribeData'
* links the tribal recipe belonging to this tribe to 'TribeData'
* parses the information in the tribal recipe and assign the stats to csStrings in 'TribeData'
* computes a tribal npctype having as parent the 'AbstractTribesman' npctype. The difference is done by adding reactions to whatever the tribe reacts to. (attacking any player nearby or simply greeting them, sleeping at day or at night, etc)

==Step #2 (RunTime)==

(executed once on startup and each time a recipe is completed)

1) NPCManager is ticking all the tribes with frequency TRIBE_TICK (tribe.h) and calling Advance() on each tribe

2) Each tribe searches for idle members, to assign tasks in Tribe::Advance()

3) updates the waiting time of all the TOP level recipe (the ones listed in mysql:'tribes_recipe.algorithm' as loadRecipe())

4) select the best recipe based on lowest wait time and high priority (where priority is defined level in the recipe tree, the lowest the better)

The Tribal Object selects the top-priority recipe which needs execution and sends it to the Recipe Manager.

The Recipe Manager parses the contents of the recipe:
It checks for requirements. If requirements are met it proceeds with parsing the algorithm (see step #3). If requirements are not met, it pushes the Recipes which achieves the requirement on top of the tribe's recipe list.
Requirement parsing can be done two ways:
* Distributed Parsing : The parser takes the first requirement and checks it + tries to achieve it. When the same recipe gets parsed again, the parser takes the second requirement (even if the first is still not met) and tries to achieve it. This way, the parser loops through requirements and tries to achieve all in parallel.
* Concentrated Parsing : The parser tries to achieve the first requirement on each recipe parse until it is met. After that it picks the second requirement and applies the same principle.

5) A new child of the RecipeTree is added as soon as the tribe decides that something can be executed (all requirements met). This is added to 'tribalRecipe' variable. Then the algorithm of this recipe is executed (for example percect NPC to go work), and the child is immediately removed from the tree. This mean that while the NPC is working, the tree does not contain that child anymore, so if another NPC becomes available, it will pick the NEXT requirement in line.

Example of Distributed vs Concentracted Parsing:

E.G.: We want our tribe to gain 150 of Coal, Silver, Gold and Platinum.

Using Distributed Parsing:
*Step 1: Assign miner to Coal.
*Step 2: Assign miner to Silver.
*Step 3: Assign miner to Gold.
*Step 4: Assign miner to Platinum.
*Step 5: Assign miner to Coal.
...

Using Concentrated Parsing: (in this example we consider each step gets the tribe 1 quantity of resource)
*Step 1: Assign miner to Coal.
...
*Step 150: Assign miner to Coal.
*Step 151: Assign miner to Silver.
...

==Step #3 (Recipe's Algorithm)==

(executed for each step the algorithm has, each time a recipe needs execution)

The Recipe has an algorithm stored as a csArray<csString>. When an algorithm needs an execution, the Recipe Manager takes each string and parses it. Depending on the rules we set, the Recipe Manager will tell the tribal object which perceptions to fire on their npcs. A complete set of algorithm and requirements functions can be found [[Tribe_Scripting|here]].

(E.g.: If the recipe's algorithm require us to send 10 workers to build a town hall, the tribal object will be told to fire a "go to work" perception on 10 worker tribesman)

== Mining tribe ==

The mining tribe is defined in tribes table with:
* a tribal_recipe value pointing to tribe_recipe table which is defining the brain, aggressivity, growth, ...
* a set of members inside tribe_members table, each member is flagged with a tag, example "Miner" which then be used in the selection of workers for a specific task

The Brain definition above will point to sc_npctypes table, which will most likely derive from AbstractTribesman

AbstractTribesman will define the reactions/behaviors for example

<react event="tribe:explore" behavior="Explore" />
<react event="tribe:mine" behavior="MineResource" />

During the 'Explore' behavior, tribe members will move around the map. psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range. This perception will make the NPC find the mine.

After mining from an unknown deposit, the npcclient will receive a psWorkDoneMessage telling it what his npc just mined. This function renames the former 'mine' Memory with it's real deposit name.

Two things need to happen:

1) The tribe sends a member to explore for mining locations, this happens with

<react event="tribe:explore" behavior="Explore" />

2) The tribe sends a members to mine for a KNOWN resource location, this happens with

<react event="tribe:mine" behavior="MineResource" />

Important methods:
* psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range
* NPCType::FirePerception() is checking if this NPC should automemorize the new locations sensed
* Tribe::Memorize() where we add the location found to the NPC memory

The mining tribe will send his members to explore in search of resources. This is done with the Behavior "Explore" in the AbstractTribsmen NPC Type stored in sc_npctypes.

== Tribe reaction to attacks ==

In RecipeManager::CreateGlobalNPCType() we check the Unity Trait of the tribe: cowards / normal / united

Anything but cowards gets
reaction = "<react event=\"attack\" behavior=\"united_attacked\" delta=\"100\" />";

When a player attacks a member of a tribe , the line above triggers a behavior on the attack.

In AbstractTribesman this happens:
<behavior name="united_attacked" decay="10">
<talk text="The tribe is under attack!" target="false" />
<locate obj="tribe:target" range="100" />
<percept event="tribesman attacked" target="tribe" range="30" />
<percept event="fight" />
</behavior>

the important piece is target ="tribe" because this trigger a perception in the tribe in Tribe::SendPerception() that scans all the NPCs and sends the given perception = "tribesman attacked"

This is defined again in AbstractTribesman
<react event="tribesman attacked" behavior="normal_attacked" delta="100" do_not_interrupt="Chase"/>
and this points to a normal attack! Which just asks the npc to fight.
[[Category:Engine documents]] [[Category:NPCClient Design]]

Tribe Design

2026-02-16T22:53:35Z

Talad: /* Tribe reaction to attacks */

= Tribe Design =

The tribe design is done using [[Behaviors_and_Reactions|NPC Behaviors]] and [[Tribe_Scripting|Recipes]]. Tribe members are assigned tasks based on what the recipes dictates the tribe to achieve. This system uses a Recipe Manager which takes care of parsing recipes, breaking the initial recipe into subtasks and telling the npcs which action to take.

== Classes ==
<uml>
scale 0.8
Tribe "1" *-- "0..N" NPC : members
Tribe "1" *-- "0..N" NPC : deadMembers
Tribe "1" *-- "0..N" Resource : resources
Tribe "1" *-- "0..N" Memory : memories
Tribe "1" *-- "0..N" Asset : assets
Tribe "1" *-- "0..N" Knowledge : knowledge
Tribe "1" *-- "1..1" RecipeTreeNode : recipes
RecipeTreeNode *-- Recipe
RecipeManager "1" *-- "N..1" Recipe : all recipes
</uml>

''' Members '''

Tribe members (both dead & alive) are kept in an array in the Tribe Class. They are all represented by the NPC class. The tribal class only has methods to attach a tribe member. For spawning new members the server (gemSupervisor & entityManager classes) and the npcclient class are responsable.

Tribe members can have different types. (Discussion needed about tribe types)

Tribe members are being kept in the 'tribe_members' mysql table.

''' Resources '''

A resource is kept in a data structure (''Tribe::Resource'') containing it's name, nick and quantity. The tribe class has methods for adding, modifying, storing and completely deleting resources.

Resources are being kept in the 'sc_tribe_resources' mysql table.

''' Memories '''

A memory is a location of some importance to the tribe. (E.g. a mine, a field, an enemy, etc)

A memory is kept in a data structure (''Tribe::Memory'') containing it's location (sector & coords), it's name and a link to an NPC (which is NULL if the memory is public to all tribe members, or != NULL if it's private to a tribe member). The tribe object has methods to add, store, modify and search memories.

Tribe members also have a memory slot for keeping it's current task location. (see bufferMemory attribute of NPC class).

Tribe memories are being kept in the 'sc_tribe_memories' mysql table.

''' Assets '''

Assets are belongings of the tribe. They can represent buildings, items or spots to be built in the future.

An asset is represented by a data structure (''Tribe::Asset'') containing it's location (sector & coords), it's name, it's quantity (relevant just for items) and it's type (Building Spot, Building or Item). The tribe class has methods for adding, editing and deleting assets. It also has methods for managing buildings. (e.g. Replace a building spot with the actual building after the workers built it)

Tribe assets are being kept in the 'sc_tribe_assets' mysql table.

''' Knowledge '''

Knowledge represents the information the tribe has gathered and the technologies they can use. (E.g. Ironworks, pottery, horseback riding, alphabet, math, etc)

Technically, they are just strings used as tokens to prove the tribe has acquired knowledge or not.

Knowledge is kept in an array of strings.

Tribe knowledge is being kept in the 'sc_tribe_knowledge' mysql table.

''' Recipe Tree Node '''

This class represents a node of the recipe tree describing the tribe current tasks. Each recipe tree node contains a link to it's recipe, waiting times, current requirement, current algorithm step and relationship information regarding other recipes. (just as a standard Tree, it may have parents and descendants).

RecipeTreeNodes are not being stored in any database. They are just used during runtime as an AI for tribes.

''' Recipe '''

A recipe is a set of requirements and algorithm steps regarding a task that needs to be done. Recipes can vary from simple (Gather a resource) to very complex (Build an entire civilization).

Recipes are being stored in the 'tribe_recipes' mysql table.

== Sequences ==

=== Advance Sequence ===

Advance sequence is the heart of the Tribe system. The NPCClient will advance the brain 4 times a second. On each loop, this sequence takes care of special cases (e.g.: 0 npcs alive in tribe) and assigns tasks to idle members.

<uml>
-> NPCClient : Advance
activate NPCClient
loop For each tribe
NPCClient -> Tribe : Advance
activate Tribe
Tribe -> Tribe : AdvanceResources
Tribe -> Tribe : AddCyclicRecipes
loop For each member
alt For NPC's that have the tribe's idle behavior
Tribe -> Tribe : Get highest priority recipe
Tribe -> RecipeManager : Apply Recipe
activate RecipeManager
Tribe <- RecipeManager
deactivate RecipeManager
end
end
NPCClient <-- Tribe
deactivate Tribe
end
<-- NPCClient
deactivate NPCClient
</uml>

== Setting up tribes ==
There are 3 main database tables that need to be populated.

* [[TribesTable|tribes]]
** Each row represents one tribe, which must have a home position/sector and a radius in which to resurrect dead members.
** max_size sets the maximum number of members.
** wealth_resource sets the different types of resource that a tribe can mine in order to grow and/or sustain itself. This needs more work however the most important one is wealth_resource_growth which is the default rate at which a resource will grow without any work per second.
** reproduction_cost is the amount of resources required to reproduce.
** tribal_recipe loads the initial recipe that sets tribe traits and loads tribe goals (recipes)

* tribe_members
** Each row is an association between a PID (on the server side) and a tribe.

* tribe_recipes
** Each row represents a recipe (name,requirements,algorithm). This table needs to be loaded in order to order tribe members what to do. Not having recipes, or requesting a recipe that does not exist will result in a termination of the npcclient.

Additionally, tables for extra tribe info need to be created:
*sc_tribe_assets
*sc_tribe_knowledge
*sc_tribe_memories
*sc_tribe_resources

== Tribe day-to-day life ==

Tribe members are normal NPCs. They all expand a base NPCType called 'AbstractTribesman', on which each tribe adds it's own particularities (e.g. when to go to sleep, what to do when they meet a stranger, etc). Read more on [[NPC Scripting]]. The 'AbstractTribesman' contains behaviors that describe generic actions: breeding, gathering, mining, fighting, exploring and working. (trading to be added soon). These generic behaviors use some data buffers to read data from during runtime in order to execute the same behavior on different data. (different mines, different fields, different building places, etc)

Upon parsing recipes, different perceptions are fired on the tribesmen. This process simulates a working society on which a superior entity assigns tasks to the population.

== Tribe death ==
When all the members die, then a member will be resurrected if there are 10*reproduction_cost resources available.

= Runtime =

==Step #1 (Loading)==

(executed only once, on NPCClient's startup. No further interrogation on the database should be done)

On NPCClient's startup everything is loaded into the classes.

1) The Recipe Manager loads all available recipes from mysql:'tribe_recipes' and add those in a flat array "recipes", one entry per recipe.

2) psNPCManager::LoadTribes() loads from the database all the tribes from mysql:'tribes'

3) For each tribe psNPCManager::LoadTribes() loads all the information regarding the tribe:
*resources from mysql:'sc_tribe_resources'
*memories from mysql:'sc_tribe_memories'
*knowledge from mysql:'sc_tribe_knowledge'
*assets from mysql:'sc_tribe_assets'
*basic tribe information from mysql:'tribes' (including the ID of the tribal recipe, more details below)
*npc's are loaded by the psNPCClient and assigned to the tribe

4) For each tribe it calls RecipeManager::AddTribe() , which parses the requirements and keeps them in the Recipe Class. (Recipe::requirements<Recipe::Requirement>)

5) Further on, each Tribal Object is linked to the Recipe Manager. (a pointer is sent and loaded into a csArray)
For each tribe loaded, the Recipe Manager does the following:
* assembles a data structure named 'TribeData'
* links the tribal recipe belonging to this tribe to 'TribeData'
* parses the information in the tribal recipe and assign the stats to csStrings in 'TribeData'
* computes a tribal npctype having as parent the 'AbstractTribesman' npctype. The difference is done by adding reactions to whatever the tribe reacts to. (attacking any player nearby or simply greeting them, sleeping at day or at night, etc)

==Step #2 (RunTime)==

(executed once on startup and each time a recipe is completed)

1) NPCManager is ticking all the tribes with frequency TRIBE_TICK (tribe.h) and calling Advance() on each tribe

2) Each tribe searches for idle members, to assign tasks in Tribe::Advance()

3) updates the waiting time of all the TOP level recipe (the ones listed in mysql:'tribes_recipe.algorithm' as loadRecipe())

4) select the best recipe based on lowest wait time and high priority (where priority is defined level in the recipe tree, the lowest the better)

The Tribal Object selects the top-priority recipe which needs execution and sends it to the Recipe Manager.

The Recipe Manager parses the contents of the recipe:
It checks for requirements. If requirements are met it proceeds with parsing the algorithm (see step #3). If requirements are not met, it pushes the Recipes which achieves the requirement on top of the tribe's recipe list.
Requirement parsing can be done two ways:
* Distributed Parsing : The parser takes the first requirement and checks it + tries to achieve it. When the same recipe gets parsed again, the parser takes the second requirement (even if the first is still not met) and tries to achieve it. This way, the parser loops through requirements and tries to achieve all in parallel.
* Concentrated Parsing : The parser tries to achieve the first requirement on each recipe parse until it is met. After that it picks the second requirement and applies the same principle.

5) A new child of the RecipeTree is added as soon as the tribe decides that something can be executed (all requirements met). This is added to 'tribalRecipe' variable. Then the algorithm of this recipe is executed (for example percect NPC to go work), and the child is immediately removed from the tree. This mean that while the NPC is working, the tree does not contain that child anymore, so if another NPC becomes available, it will pick the NEXT requirement in line.

Example of Distributed vs Concentracted Parsing:

E.G.: We want our tribe to gain 150 of Coal, Silver, Gold and Platinum.

Using Distributed Parsing:
*Step 1: Assign miner to Coal.
*Step 2: Assign miner to Silver.
*Step 3: Assign miner to Gold.
*Step 4: Assign miner to Platinum.
*Step 5: Assign miner to Coal.
...

Using Concentrated Parsing: (in this example we consider each step gets the tribe 1 quantity of resource)
*Step 1: Assign miner to Coal.
...
*Step 150: Assign miner to Coal.
*Step 151: Assign miner to Silver.
...

==Step #3 (Recipe's Algorithm)==

(executed for each step the algorithm has, each time a recipe needs execution)

The Recipe has an algorithm stored as a csArray<csString>. When an algorithm needs an execution, the Recipe Manager takes each string and parses it. Depending on the rules we set, the Recipe Manager will tell the tribal object which perceptions to fire on their npcs. A complete set of algorithm and requirements functions can be found [[Tribe_Scripting|here]].

(E.g.: If the recipe's algorithm require us to send 10 workers to build a town hall, the tribal object will be told to fire a "go to work" perception on 10 worker tribesman)

== Mining tribe ==

The mining tribe is defined in tribes table with:
* a tribal_recipe value pointing to tribe_recipe table which is defining the brain, aggressivity, growth, ...
* a set of members inside tribe_members table, each member is flagged with a tag, example "Miner" which then be used in the selection of workers for a specific task

The Brain definition above will point to sc_npctypes table, which will most likely derive from AbstractTribesman

AbstractTribesman will define the reactions/behaviors for example

<react event="tribe:explore" behavior="Explore" />
<react event="tribe:mine" behavior="MineResource" />

During the 'Explore' behavior, tribe members will move around the map. psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range. This perception will make the NPC find the mine.

After mining from an unknown deposit, the npcclient will receive a psWorkDoneMessage telling it what his npc just mined. This function renames the former 'mine' Memory with it's real deposit name.

Two things need to happen:

1) The tribe sends a member to explore for mining locations, this happens with

<react event="tribe:explore" behavior="Explore" />

2) The tribe sends a members to mine for a KNOWN resource location, this happens with

<react event="tribe:mine" behavior="MineResource" />

Important methods:
* psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range
* NPCType::FirePerception() is checking if this NPC should automemorize the new locations sensed
* Tribe::Memorize() where we add the location found to the NPC memory

The mining tribe will send his members to explore in search of resources. This is done with the Behavior "Explore" in the AbstractTribsmen NPC Type stored in sc_npctypes.

== Tribe reaction to attacks ==

In RecipeManager::CreateGlobalNPCType() we check the Unity Trait of the tribe: cowards / normal / united

Anything but cowards gets
reaction = "<react event=\"attack\" behavior=\"united_attacked\" delta=\"100\" />";

When a player attacks a member of a tribe , the line above triggers a behavior on the attack.

In AbstractTribesman this happens:
<behavior name="united_attacked" decay="10">
<talk text="The tribe is under attack!" target="false" />
<locate obj="tribe:target" range="100" />
<percept event="tribesman attacked" target="tribe" range="30" />
<percept event="fight" />
</behavior>
[[Category:Engine documents]] [[Category:NPCClient Design]]

Tribe Design

2026-02-16T22:53:30Z

Talad: /* Tribe reaction to attacks */

Tribe Design

2026-02-10T23:23:55Z

Talad:

= Tribe Design =

The tribe design is done using [[Behaviors_and_Reactions|NPC Behaviors]] and [[Tribe_Scripting|Recipes]]. Tribe members are assigned tasks based on what the recipes dictates the tribe to achieve. This system uses a Recipe Manager which takes care of parsing recipes, breaking the initial recipe into subtasks and telling the npcs which action to take.

== Classes ==
<uml>
scale 0.8
Tribe "1" *-- "0..N" NPC : members
Tribe "1" *-- "0..N" NPC : deadMembers
Tribe "1" *-- "0..N" Resource : resources
Tribe "1" *-- "0..N" Memory : memories
Tribe "1" *-- "0..N" Asset : assets
Tribe "1" *-- "0..N" Knowledge : knowledge
Tribe "1" *-- "1..1" RecipeTreeNode : recipes
RecipeTreeNode *-- Recipe
RecipeManager "1" *-- "N..1" Recipe : all recipes
</uml>

''' Members '''

Tribe members (both dead & alive) are kept in an array in the Tribe Class. They are all represented by the NPC class. The tribal class only has methods to attach a tribe member. For spawning new members the server (gemSupervisor & entityManager classes) and the npcclient class are responsable.

Tribe members can have different types. (Discussion needed about tribe types)

Tribe members are being kept in the 'tribe_members' mysql table.

''' Resources '''

A resource is kept in a data structure (''Tribe::Resource'') containing it's name, nick and quantity. The tribe class has methods for adding, modifying, storing and completely deleting resources.

Resources are being kept in the 'sc_tribe_resources' mysql table.

''' Memories '''

A memory is a location of some importance to the tribe. (E.g. a mine, a field, an enemy, etc)

A memory is kept in a data structure (''Tribe::Memory'') containing it's location (sector & coords), it's name and a link to an NPC (which is NULL if the memory is public to all tribe members, or != NULL if it's private to a tribe member). The tribe object has methods to add, store, modify and search memories.

Tribe members also have a memory slot for keeping it's current task location. (see bufferMemory attribute of NPC class).

Tribe memories are being kept in the 'sc_tribe_memories' mysql table.

''' Assets '''

Assets are belongings of the tribe. They can represent buildings, items or spots to be built in the future.

An asset is represented by a data structure (''Tribe::Asset'') containing it's location (sector & coords), it's name, it's quantity (relevant just for items) and it's type (Building Spot, Building or Item). The tribe class has methods for adding, editing and deleting assets. It also has methods for managing buildings. (e.g. Replace a building spot with the actual building after the workers built it)

Tribe assets are being kept in the 'sc_tribe_assets' mysql table.

''' Knowledge '''

Knowledge represents the information the tribe has gathered and the technologies they can use. (E.g. Ironworks, pottery, horseback riding, alphabet, math, etc)

Technically, they are just strings used as tokens to prove the tribe has acquired knowledge or not.

Knowledge is kept in an array of strings.

Tribe knowledge is being kept in the 'sc_tribe_knowledge' mysql table.

''' Recipe Tree Node '''

This class represents a node of the recipe tree describing the tribe current tasks. Each recipe tree node contains a link to it's recipe, waiting times, current requirement, current algorithm step and relationship information regarding other recipes. (just as a standard Tree, it may have parents and descendants).

RecipeTreeNodes are not being stored in any database. They are just used during runtime as an AI for tribes.

''' Recipe '''

A recipe is a set of requirements and algorithm steps regarding a task that needs to be done. Recipes can vary from simple (Gather a resource) to very complex (Build an entire civilization).

Recipes are being stored in the 'tribe_recipes' mysql table.

== Sequences ==

=== Advance Sequence ===

Advance sequence is the heart of the Tribe system. The NPCClient will advance the brain 4 times a second. On each loop, this sequence takes care of special cases (e.g.: 0 npcs alive in tribe) and assigns tasks to idle members.

<uml>
-> NPCClient : Advance
activate NPCClient
loop For each tribe
NPCClient -> Tribe : Advance
activate Tribe
Tribe -> Tribe : AdvanceResources
Tribe -> Tribe : AddCyclicRecipes
loop For each member
alt For NPC's that have the tribe's idle behavior
Tribe -> Tribe : Get highest priority recipe
Tribe -> RecipeManager : Apply Recipe
activate RecipeManager
Tribe <- RecipeManager
deactivate RecipeManager
end
end
NPCClient <-- Tribe
deactivate Tribe
end
<-- NPCClient
deactivate NPCClient
</uml>

== Setting up tribes ==
There are 3 main database tables that need to be populated.

* [[TribesTable|tribes]]
** Each row represents one tribe, which must have a home position/sector and a radius in which to resurrect dead members.
** max_size sets the maximum number of members.
** wealth_resource sets the different types of resource that a tribe can mine in order to grow and/or sustain itself. This needs more work however the most important one is wealth_resource_growth which is the default rate at which a resource will grow without any work per second.
** reproduction_cost is the amount of resources required to reproduce.
** tribal_recipe loads the initial recipe that sets tribe traits and loads tribe goals (recipes)

* tribe_members
** Each row is an association between a PID (on the server side) and a tribe.

* tribe_recipes
** Each row represents a recipe (name,requirements,algorithm). This table needs to be loaded in order to order tribe members what to do. Not having recipes, or requesting a recipe that does not exist will result in a termination of the npcclient.

Additionally, tables for extra tribe info need to be created:
*sc_tribe_assets
*sc_tribe_knowledge
*sc_tribe_memories
*sc_tribe_resources

== Tribe day-to-day life ==

Tribe members are normal NPCs. They all expand a base NPCType called 'AbstractTribesman', on which each tribe adds it's own particularities (e.g. when to go to sleep, what to do when they meet a stranger, etc). Read more on [[NPC Scripting]]. The 'AbstractTribesman' contains behaviors that describe generic actions: breeding, gathering, mining, fighting, exploring and working. (trading to be added soon). These generic behaviors use some data buffers to read data from during runtime in order to execute the same behavior on different data. (different mines, different fields, different building places, etc)

Upon parsing recipes, different perceptions are fired on the tribesmen. This process simulates a working society on which a superior entity assigns tasks to the population.

== Tribe death ==
When all the members die, then a member will be resurrected if there are 10*reproduction_cost resources available.

= Runtime =

==Step #1 (Loading)==

(executed only once, on NPCClient's startup. No further interrogation on the database should be done)

On NPCClient's startup everything is loaded into the classes.

1) The Recipe Manager loads all available recipes from mysql:'tribe_recipes' and add those in a flat array "recipes", one entry per recipe.

2) psNPCManager::LoadTribes() loads from the database all the tribes from mysql:'tribes'

3) For each tribe psNPCManager::LoadTribes() loads all the information regarding the tribe:
*resources from mysql:'sc_tribe_resources'
*memories from mysql:'sc_tribe_memories'
*knowledge from mysql:'sc_tribe_knowledge'
*assets from mysql:'sc_tribe_assets'
*basic tribe information from mysql:'tribes' (including the ID of the tribal recipe, more details below)
*npc's are loaded by the psNPCClient and assigned to the tribe

4) For each tribe it calls RecipeManager::AddTribe() , which parses the requirements and keeps them in the Recipe Class. (Recipe::requirements<Recipe::Requirement>)

5) Further on, each Tribal Object is linked to the Recipe Manager. (a pointer is sent and loaded into a csArray)
For each tribe loaded, the Recipe Manager does the following:
* assembles a data structure named 'TribeData'
* links the tribal recipe belonging to this tribe to 'TribeData'
* parses the information in the tribal recipe and assign the stats to csStrings in 'TribeData'
* computes a tribal npctype having as parent the 'AbstractTribesman' npctype. The difference is done by adding reactions to whatever the tribe reacts to. (attacking any player nearby or simply greeting them, sleeping at day or at night, etc)

==Step #2 (RunTime)==

(executed once on startup and each time a recipe is completed)

1) NPCManager is ticking all the tribes with frequency TRIBE_TICK (tribe.h) and calling Advance() on each tribe

2) Each tribe searches for idle members, to assign tasks in Tribe::Advance()

3) updates the waiting time of all the TOP level recipe (the ones listed in mysql:'tribes_recipe.algorithm' as loadRecipe())

4) select the best recipe based on lowest wait time and high priority (where priority is defined level in the recipe tree, the lowest the better)

The Tribal Object selects the top-priority recipe which needs execution and sends it to the Recipe Manager.

The Recipe Manager parses the contents of the recipe:
It checks for requirements. If requirements are met it proceeds with parsing the algorithm (see step #3). If requirements are not met, it pushes the Recipes which achieves the requirement on top of the tribe's recipe list.
Requirement parsing can be done two ways:
* Distributed Parsing : The parser takes the first requirement and checks it + tries to achieve it. When the same recipe gets parsed again, the parser takes the second requirement (even if the first is still not met) and tries to achieve it. This way, the parser loops through requirements and tries to achieve all in parallel.
* Concentrated Parsing : The parser tries to achieve the first requirement on each recipe parse until it is met. After that it picks the second requirement and applies the same principle.

5) A new child of the RecipeTree is added as soon as the tribe decides that something can be executed (all requirements met). This is added to 'tribalRecipe' variable. Then the algorithm of this recipe is executed (for example percect NPC to go work), and the child is immediately removed from the tree. This mean that while the NPC is working, the tree does not contain that child anymore, so if another NPC becomes available, it will pick the NEXT requirement in line.

Example of Distributed vs Concentracted Parsing:

E.G.: We want our tribe to gain 150 of Coal, Silver, Gold and Platinum.

Using Distributed Parsing:
*Step 1: Assign miner to Coal.
*Step 2: Assign miner to Silver.
*Step 3: Assign miner to Gold.
*Step 4: Assign miner to Platinum.
*Step 5: Assign miner to Coal.
...

Using Concentrated Parsing: (in this example we consider each step gets the tribe 1 quantity of resource)
*Step 1: Assign miner to Coal.
...
*Step 150: Assign miner to Coal.
*Step 151: Assign miner to Silver.
...

==Step #3 (Recipe's Algorithm)==

(executed for each step the algorithm has, each time a recipe needs execution)

The Recipe has an algorithm stored as a csArray<csString>. When an algorithm needs an execution, the Recipe Manager takes each string and parses it. Depending on the rules we set, the Recipe Manager will tell the tribal object which perceptions to fire on their npcs. A complete set of algorithm and requirements functions can be found [[Tribe_Scripting|here]].

(E.g.: If the recipe's algorithm require us to send 10 workers to build a town hall, the tribal object will be told to fire a "go to work" perception on 10 worker tribesman)

== Mining tribe ==

The mining tribe is defined in tribes table with:
* a tribal_recipe value pointing to tribe_recipe table which is defining the brain, aggressivity, growth, ...
* a set of members inside tribe_members table, each member is flagged with a tag, example "Miner" which then be used in the selection of workers for a specific task

The Brain definition above will point to sc_npctypes table, which will most likely derive from AbstractTribesman

AbstractTribesman will define the reactions/behaviors for example

<react event="tribe:explore" behavior="Explore" />
<react event="tribe:mine" behavior="MineResource" />

During the 'Explore' behavior, tribe members will move around the map. psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range. This perception will make the NPC find the mine.

After mining from an unknown deposit, the npcclient will receive a psWorkDoneMessage telling it what his npc just mined. This function renames the former 'mine' Memory with it's real deposit name.

Two things need to happen:

1) The tribe sends a member to explore for mining locations, this happens with

<react event="tribe:explore" behavior="Explore" />

2) The tribe sends a members to mine for a KNOWN resource location, this happens with

<react event="tribe:mine" behavior="MineResource" />

Important methods:
* psNPCManager::PerceptProximityLocations() is called every second, triggering a LocationPerception with "location sensed" to all NPC in range
* NPCType::FirePerception() is checking if this NPC should automemorize the new locations sensed
* Tribe::Memorize() where we add the location found to the NPC memory

The mining tribe will send his members to explore in search of resources. This is done with the Behavior "Explore" in the AbstractTribsmen NPC Type stored in sc_npctypes.

== Tribe reaction to attacks ==

In RecipeManager::CreateGlobalNPCType() we check the Unity Trait of the tribe: cowards / normal / united

Anything but cowards gets

reaction = "<react event=\"attack\" behavior=\"united_attacked\" delta=\"100\" />";

[[Category:Engine documents]] [[Category:NPCClient Design]]

Creatures and Attack sounds

2026-01-28T23:35:27Z

Talad:

== Attack Sound ==
For humanoid and creatures we consider that they can use melee or use weapons. In the Combat_Montage of our player character, we have the attack animation. In the attack animation segment we have one events (Notify) at the start of type PSAnimNotifyAttackSound

[[File:PSAnimNotify.png]]

If you need to enable the attack sound on a creature, you need to add the PSAnimNotifyAttackSound in the attack Montage (not in the attack sequence).
In psAttack::Attack() we create a soundID with this rule:<blockquote>
if the weapon is melee then use the race: <race>-4 (because 4 is the melee skill ID)

otherwise use the weapon skill id: "w-" + <weapon skill>

Example: Stonehammer hitting with a Fist = 0-4

Example: Stonehammer hitting with a sword = w-0</blockquote>this soundID is then sent to all clients this way: we call BroadcastAttackAnimation() to send it to all players in range, and then we call ReceiveAttackAnimation() on clients BP, this is then calling PlayPSAnimMontage()

Inside PlayPSAnimMontage() we use the soundid

The class used is UPSAnimNotifyAttackSound

== Hit sound ==
When someone is hit.

in psAttack::AffectTarget() we create a soundID <Weapon Type> + "-" + <Material> + <hit:1 or block:0>

Material is defined in [[Race infoTable]].skin_type (0-flesh, 1-wood, 2-metal, 3-carapace, 4-fur, 5-slime)

Example: fist hitting carapare of a trepor: 4-3-1

Example: sword getting blocked by flesh: 0-0-0

this soundID is then sent to all clients this way: we call BroacastCombatResultSound() to send it to all players in range

The hit sounds are decoupled from the hit animation because they need to play regardless.

== Death Sound ==
If we want to have a sound when the creature dies, we have it in the Death Montage, on the death animation

[[File:Death Sound.png]]

Creatures and Attack sounds

2026-01-28T21:38:08Z

Talad: /* Attack Sound */

== Attack Sound ==
For humanoid and creatures we consider that they can use melee or use weapons. In the Combat_Montage of our player character, we have the attack animation. In the attack animation segment we have one events (Notify) at the start of type PSAnimNotifyAttackSound

[[File:PSAnimNotify.png]]

In psAttack::Attack() we create a soundID with this rule:<blockquote>
if the weapon is melee then use the race: <race>-4 (because 4 is the melee skill ID)

otherwise use the weapon skill id: "w-" + <weapon skill>

Example: Stonehammer hitting with a Fist = 0-4

Example: Stonehammer hitting with a sword = w-0</blockquote>this soundID is then sent to all clients this way: we call BroadcastAttackAnimation() to send it to all players in range, and then we call ReceiveAttackAnimation() on clients BP, this is then calling PlayPSAnimMontage()

Inside PlayPSAnimMontage() we use the soundid

The class used is UPSAnimNotifyAttackSound

== Hit sound ==
When someone is hit.

in psAttack::AffectTarget() we create a soundID <Weapon Type> + "-" + <Material> + <hit:1 or block:0>

Material is defined in [[Race infoTable]].skin_type (0-flesh, 1-wood, 2-metal, 3-carapace, 4-fur, 5-slime)

Example: fist hitting carapare of a trepor: 4-3-1

Example: sword getting blocked by flesh: 0-0-0

this soundID is then sent to all clients this way: we call BroacastCombatResultSound() to send it to all players in range

The hit sounds are decoupled from the hit animation because they need to play regardless.

== Death Sound ==
If we want to have a sound when the creature dies, we have it in the Death Montage, on the death animation

[[File:Death Sound.png]]

Tribe Scripting

2026-01-05T17:09:02Z

Talad: /* SpawnMember */

= Recipe Logic =

== Recipes ==
'''A recipe database entry'''
{| border="1"
!id
!name
!requirements
!algorithm
!persistent
|-
|used for db storing
|Name of the recipe
|requirement string containing all requirements
|algorithm string containing all algorithm steps
|If this flag is on, the recipe won't ever be deleted from the recipe tree. After parsing it, if no other recipe has a higher priority... it will be reparsed.
|}

== Usage of Recipes ==

Recipes is used to describe how [[tribes]] react. See [[Tribe Design]] for details.

On initialization, a tribal recipe is first loaded in respect of the information indicated by the 'tribal_recipe' field. (see [[TribesTable|tribes.sql]]). The tribal recipe is formed from 'Tribe Info' functions. (see below)

Based on those functions the npctype for each tribe is created and initial recipes are loaded.

Further on, each Recipe has two important sections: requirements and algorithm. Each of those two is represented by a long string (the maximum is set in the database to 1000 characters) of functions separated by a semi-colon ';'. Upon parsing the long string is split in respect of the semicolons (;) and the recipe manager analyzes each resulting function.

== Recipe-Tree Nodes ==

Inside a tribe object, recipes are stored as Recipe Tree Nodes. This class was created to facilitate the management of recipes and the way recipes are selected to be parsed.

All recipes are stored as leaves in a tree. This way we can always know their hierarchy and precedence.

Besides the obvious usage as a tree, recipe tree nodes also hold vital data for recipe parsing: last requirement parsed, last algorithm step parsed, remaining waiting time.

Let's consider an example of a tribe which has some building spots available and the task to build on those spots.

Having the tree above, it's easy to select the actions required to complete the task. We first get some more food. After that we get the required members, search for wood and stone, and finally build the buildings.

= Tribe Info =

== Brain ==

Syntax: brain(x);

Arguments:
* x brain eg. behaviour to use for the tribe.

Effect: Override the AbstractTribesman as the brain for the tribe.

For each tribe the server create an tribe_<tribe_id> behavior that inherit from the brain given i the brain command. If no brain entry is given the tribe behaviour will use the AbstractTribesman behaviour. This can be used to create tribes with special behaviours.

== Aggressivity ==

Syntax: aggressivity(x);

Arguments:
* x in { warlike, neutral, peaceful }

Effect: Decides the way the tribe reacts to other entities around it's members:
* Warlike -- Attack anything on sight.
* Neutral -- Attack only if members are attacked.
* Peaceful -- If tribe members are attack they flee, trying to escape.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype in respect of this function's argument.

== Growth ==
Syntax: growth(x)

Arguments:

* x in ?

Not implemented , at the moment all tribes have "conservatory" as value

== Unity ==
Syntax: unity(x)

Arguments:

* x in {*, cowards}

At the moment anything but "cowards" will trigger one member of the tribe to help another member when attacked.

== SleepPeriod ==

Syntax: sleepPeriod(x);

Arguments: x in { diurnal, nocturnal, nosleep }

{|
|-
|diurnal
|22:00 - 06:00
|Sleep during night
|-
|nocturnal
|08:00 - 18:00
|Sleep during day
|}

Effect: Makes the tribe members sleep at the given period of day.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype. The reaction should react to timeofday perceptions.

== LoadRecipe ==

Syntax: loadRecipe(x); loadRecipe(x,distributed);

Arguments:
* 'x' is a Recipe Name

Effect: Loads a recipe into the recipe tree. The new recipe's priority will be the current recipe's priority + 1.

== LoadCyclicRecipe ==

Syntax: loadCyclicRecipe(x,t);

Arguments:
* 'x' is a Recipe Name
* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.

= Requirements =

== Building ==

Syntax: building(x,y,r);

Arguments:
* 'x' is a building name.
* 'y' is an int defining the quantity of buildings needed.
* 'r' is the recipe needed to get the building if not available

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the building 'x' of quantity 'y'.

== Tribesman ==

Syntax: tribesman(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' regardless if they are busy or doing something else. If 'y' members are found, the requirement is considered met.

== TribesmanIdle ==

Syntax: tribesmanidle(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.

== Resource ==

Syntax: resource(x,y,r);

Arguments:
* x is the resource name
* y is the resource quantity required
* r is the recipe needed to get the resource if not available

Effect & Mechanics: The tribal object checks for a 'y' quantity of 'x' resource. If this quantity is found then the resource is considered complete. $RESOURCE_AREA, $REPRODUCTION_RESOURCE and $REPRODUCTION_COST are valid variables.

Judging by the way natural resources are defined, any string declared in natural_resources.sql as a resource can be parsed and mined by the tribe. By default, any new mine found by the tribesmen is stored as a memory named 'mine'. Upon it's first mining action done on the 'mine' memory, a reward is granted to the npc. When the NPC gets home and gives that to the tribal object, the memory 'mine' is renamed after the reward. In conclusion, having a resource named 'Space Shuttle' is valid and works.

Note: The resource requirement just checks if enough resources are available. Use 'alterResource' function in your recipes in order to actually substract resource from the tribe bank.

== Knowledge ==

Syntax: knowledge(x);

Arguments: 'x' can be any string.

Effect & Mechanics: As described in the [[Tribe Design]] document, knowledge are tokens that keep track on technologies developed by the tribe. It's valid to request any string as long as it would be possible for the tribe to develop the knowledge. Otherwise the requirement will never be met.

== Item ==

Syntax: item(x,y);

Arguments:
* 'x' is an item/building name.
* 'y' is an int defining the quantity of items needed.

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the item 'x' of quantity 'y'.

== Recipe ==

Syntax: recipe(x,y);

Arguments:
* 'x' is a recipe name.
* 'y' is an int defining the quantity of recipes needed.

Effect & Mechanics: Upon parsing this requirement, the parser just adds an 'y' number of 'x' recipes to the recipe tree.

This requirement isn't quite practical and should be avoided.

== Trader (Not available) ==

Syntax: trader(x);

Arguments:
* 'x' is an item name

Effect: This requirement should check the traders array for a nearby trader giving item 'x'.

== Memory ==

Syntax: memory(m,p,r);

Arguments:
* 'm' is a memory name
* 'p' is a probability between 0-100. Setting this to 10 make it 10% probably that the r will be run even if m is found.
* 'r' is a recipe that will be run if the memory isn't found.

Effect & Mechanics: Upon parsing this requirement, the parser checks the memory array for a memory called 'm'. If it is found, requirement is considered met. If it isn't found or the probability for failure has hit it will run the recipe 'r'.

= Algorithm Steps =

== AddKnowledge ==

Syntax: addKnowledge(x);

Arguments:
* 'x' can be any string.

Effect & Mechanics: Adds the 'x' token as a piece of knowledge in the knowledge array.

== AlterResource ==

Syntax: alterResource(x,y);

Arguments:
* 'x' is a resource name
* 'y' is an int describing quantity

Effect & Mechanics: Upon parsing this function, the parser modifies the quantity of resources available in the tribe.

Note: The 'y' value will be added to the current value in the tribe's bank. Use negative value to represent costs. (e.g. alterResource(gold,-20); in order to pay for a building)

== Attack ==

Syntax: attack();

Arguments: None.

Effect & Mechanics: It sends to previously selected members the 'tribe:attack' perception to attack a previously selected location. If the selected location is not an attackable entity they will simply move there and attack whatever is near.

== Gather ==

Syntax: gather();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected field and fires their 'tribe:gather' behavior.

== GoWork ==

Syntax: goWork(x);

Arguments:
* 'x' is an int defining the number of seconds the npcs should work for.

Effect & Mechanics: The 'goWork' function sends previously selected npcs to a previously selected location, set the npc buffer [Work_Duration] to 'x' and send 'tribe:work' behavior.

== Guard (Not available) ==

Note:
guard() function not implemented yet, use percept(selection, tribe:guard) instead.

Syntax: guard();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to guard the selected location. Members will just patrol the area and attack whatever poses a threat.

== LoadLocation ==

Syntax: loadLocation(x,y,z,r);

Arguments:
* 'x', 'y' and 'z' are a set of coordinates.
* 'r' is the location name.

Effect & Mechanics: add a new memory in the Database, adding a new location named "work" in the coordinates x,y,z.

== LocateMemory ==

Syntax: locateMemory(x,r);

Arguments:
* 'x' is a memory name.
* 'r' is a recipe to load if the memory 'x' isn't found.

Effect & Mechanics: It looks in the tribe's memory array for the memory called 'x' and loads it into the previous selected npc's buffers. It is vital to use it before basic functions like mine,gather,guard,attack that use the npc buffers to execute.

== LocateResource ==

Syntax: locateResource(x,r);

Arguments:
* 'x' is a resource name.
* 'r' the recipe to load if no resource 'x' is found

Effect & Mechanics: This function works like the above-mentioned 'locateMemory' function. The sole difference is that this function tries to locate resource 'x', and it case it fails it tries to locate memories 'mine' or 'field'. (which are the standard names of unprospected/undiscovered resource zones). In case nor 'mine' or 'field' are found, it sends the previous selected npcs to explore for them.

== LocateBuilding ==

Syntax: locateBuilding(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot on which there is an already constructed building. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

Example Tribe Script:

select(Worker,1);locateBuilding(Campfire);goWork(60);

== LocateBuildingSpot ==

Syntax: locateBuildingSpot(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot previously reserved via 'reserveBuildingSpot' function. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

This function also sets the building spot to INCONSTRUCTION. So a build command should be executed next.

The NPC can use the [[Behavior_Operations#Build Operation|Build Operation]] to build a building at the selected spot.

Example Tribe Script:

select(Worker,1);locateBuildingSpot(Campfire);percept(selection,tribe:build)

Example NPC Script:

<behavior name="DoBuild">
<locate obj="building_spot" />
<navigate />
<wait duration="$NBUFFER[Work_Duration]" />
<build />
<talk text="Nice work building this $NBUFFER[Building]" />
</behavior>
<react event="tribe:build" behavior="DoBuild" />

== Mate ==

Syntax: mate();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to their home and fires their 'tribe:breed' behavior.

Note: By default, the 'mate' functions requires no resources and has no checks. Use it in a recipe that checks that enough resources for breeding are available.

Examples:
select(any,1);
setBuffer(selection,Reproduce_Type,$member_type);
mate();
alterResource($REPRODUCTION_RESOURCE, -$REPRODUCTION_COST);

== Mine ==

Syntax: mine();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected mine and fires their 'tribe:mine' behavior.

== Percept ==

Syntax: percept(t,p);

Arguments:
* 't' is either selection or tribe
* 'p' is the perception to send

Effect & Mechanics: It sends a perception to previously selected members or to the tribe.

Examples:
select(any,1);
percept(selection,tribe:gather)
percept(tribe,tribe:flee)

== ReserveSpot ==

Syntax: reserveSpot(x,y,z,bname);

Arguments:
* 'x', 'y' and 'z' are coordinates in the same sector as the tribe
* 'bname' is the building name we want to reserve the spot for

Effect & Mechanics: This function is used so the scripter (you) can arrange the future village of the tribe. When creating a tribe, a recipe containing building spots should be wrote in order to pinpoint where building should be constructed in the future.

== Select ==

Syntax: select(x,y);

Arguments:
* 'x' is a tribe member type. Types can be crated using the [[Behavior_Operations#Reproduce_Operation|Reproduce Operation]]
* 'y' is an int defining the number of members to be selected.

Effect & Mechanics: The 'select' function is probably the most important algorithm step. It selects the members passed as arguments and keeps them in a temporary npc array so they can accept orders from the next algorithm steps. It actually works like selecting units and commanding them in a strategy game. After a 'select' function, all next algorithm steps apply to selected members only, until another 'select' command is issued or the recipe is completed.

Example:
// Will send 3 miners to mine for gold.
select(miner,3);
locateResource(gold,Explore);
mine();

== SetBuffer ==

Syntax: setBuffer(target,name,value);

Arguments:
* 'target' is either selection or tribe.
* 'name' is the name of the buffer to set.
* 'value' is the new value to set for Buffer.

For selection this resolve to NBUFFER[name] in recipes and $NBUFFER[name] in behaviors.
For tribes this resolve to TBUFFER[name] in recipes and $TBUFFER[name] in behaviors.

This set the buffers used by [[NPC Variables]] to replace buffers.

Example:

In an algorithm:
select(Worker,2);
setBuffer(selection,Work_Time,10);
percept(tribe:work);

In a NPC behavior:
<wait duration="$NBUFFER[Work_Time]" />

== SpawnMember ==
Syntax: spawnMember(x,y);

Arguments:
* 'x' is an integer and the ID of the master NPC to clone and spawn
* 'y' is a string identifying the type of member (example Warrior, Miner, Hunter, ...)

Effect & Mechanics: This function spawns a new member of the tribe, without requiring anything else, in contrast with mate() that requires an existing member to spawn another member. This function can be used to create the first member of the tribe.

Example:

"Consumer Evolve Tribe" recipe with requirements: tribesman(Warrior,1,Consumer Ancestor Spawn);

"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(42, Warrior);

IMPORTANT: The master NPC ID, should be created in characters table + there must be an entry for this NPC in sc_npc_definitions table, with the AbstractTribesman. This will properly initialize the member of the tribe.

== Wait ==

Syntax: wait(x);

Arguments:
* 'x' is an float defining number seconds to halt recipe for.

Effect & Mechanics: This function sets the wait time for a recipe. By default, no recipes with a wait time bigger than 0 are reparsed. As a consequence, applying wait time to a recipe will make the parser halt the current recipe at the current algorithm step and parse other recipes that wait in line. The function will also fire the 'tribe:wait' reaction.

[[Category:Server Design]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]

Tribe Scripting

2026-01-04T18:38:18Z

Talad: /* SpawnMember */

= Recipe Logic =

== Recipes ==
'''A recipe database entry'''
{| border="1"
!id
!name
!requirements
!algorithm
!persistent
|-
|used for db storing
|Name of the recipe
|requirement string containing all requirements
|algorithm string containing all algorithm steps
|If this flag is on, the recipe won't ever be deleted from the recipe tree. After parsing it, if no other recipe has a higher priority... it will be reparsed.
|}

== Usage of Recipes ==

Recipes is used to describe how [[tribes]] react. See [[Tribe Design]] for details.

On initialization, a tribal recipe is first loaded in respect of the information indicated by the 'tribal_recipe' field. (see [[TribesTable|tribes.sql]]). The tribal recipe is formed from 'Tribe Info' functions. (see below)

Based on those functions the npctype for each tribe is created and initial recipes are loaded.

Further on, each Recipe has two important sections: requirements and algorithm. Each of those two is represented by a long string (the maximum is set in the database to 1000 characters) of functions separated by a semi-colon ';'. Upon parsing the long string is split in respect of the semicolons (;) and the recipe manager analyzes each resulting function.

== Recipe-Tree Nodes ==

Inside a tribe object, recipes are stored as Recipe Tree Nodes. This class was created to facilitate the management of recipes and the way recipes are selected to be parsed.

All recipes are stored as leaves in a tree. This way we can always know their hierarchy and precedence.

Besides the obvious usage as a tree, recipe tree nodes also hold vital data for recipe parsing: last requirement parsed, last algorithm step parsed, remaining waiting time.

Let's consider an example of a tribe which has some building spots available and the task to build on those spots.

Having the tree above, it's easy to select the actions required to complete the task. We first get some more food. After that we get the required members, search for wood and stone, and finally build the buildings.

= Tribe Info =

== Brain ==

Syntax: brain(x);

Arguments:
* x brain eg. behaviour to use for the tribe.

Effect: Override the AbstractTribesman as the brain for the tribe.

For each tribe the server create an tribe_<tribe_id> behavior that inherit from the brain given i the brain command. If no brain entry is given the tribe behaviour will use the AbstractTribesman behaviour. This can be used to create tribes with special behaviours.

== Aggressivity ==

Syntax: aggressivity(x);

Arguments:
* x in { warlike, neutral, peaceful }

Effect: Decides the way the tribe reacts to other entities around it's members:
* Warlike -- Attack anything on sight.
* Neutral -- Attack only if members are attacked.
* Peaceful -- If tribe members are attack they flee, trying to escape.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype in respect of this function's argument.

== Growth ==
Syntax: growth(x)

Arguments:

* x in ?

Not implemented , at the moment all tribes have "conservatory" as value

== Unity ==
Syntax: unity(x)

Arguments:

* x in {*, cowards}

At the moment anything but "cowards" will trigger one member of the tribe to help another member when attacked.

== SleepPeriod ==

Syntax: sleepPeriod(x);

Arguments: x in { diurnal, nocturnal, nosleep }

{|
|-
|diurnal
|22:00 - 06:00
|Sleep during night
|-
|nocturnal
|08:00 - 18:00
|Sleep during day
|}

Effect: Makes the tribe members sleep at the given period of day.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype. The reaction should react to timeofday perceptions.

== LoadRecipe ==

Syntax: loadRecipe(x); loadRecipe(x,distributed);

Arguments:
* 'x' is a Recipe Name

Effect: Loads a recipe into the recipe tree. The new recipe's priority will be the current recipe's priority + 1.

== LoadCyclicRecipe ==

Syntax: loadCyclicRecipe(x,t);

Arguments:
* 'x' is a Recipe Name
* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.

= Requirements =

== Building ==

Syntax: building(x,y,r);

Arguments:
* 'x' is a building name.
* 'y' is an int defining the quantity of buildings needed.
* 'r' is the recipe needed to get the building if not available

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the building 'x' of quantity 'y'.

== Tribesman ==

Syntax: tribesman(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' regardless if they are busy or doing something else. If 'y' members are found, the requirement is considered met.

== TribesmanIdle ==

Syntax: tribesmanidle(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.

== Resource ==

Syntax: resource(x,y,r);

Arguments:
* x is the resource name
* y is the resource quantity required
* r is the recipe needed to get the resource if not available

Effect & Mechanics: The tribal object checks for a 'y' quantity of 'x' resource. If this quantity is found then the resource is considered complete. $RESOURCE_AREA, $REPRODUCTION_RESOURCE and $REPRODUCTION_COST are valid variables.

Judging by the way natural resources are defined, any string declared in natural_resources.sql as a resource can be parsed and mined by the tribe. By default, any new mine found by the tribesmen is stored as a memory named 'mine'. Upon it's first mining action done on the 'mine' memory, a reward is granted to the npc. When the NPC gets home and gives that to the tribal object, the memory 'mine' is renamed after the reward. In conclusion, having a resource named 'Space Shuttle' is valid and works.

Note: The resource requirement just checks if enough resources are available. Use 'alterResource' function in your recipes in order to actually substract resource from the tribe bank.

== Knowledge ==

Syntax: knowledge(x);

Arguments: 'x' can be any string.

Effect & Mechanics: As described in the [[Tribe Design]] document, knowledge are tokens that keep track on technologies developed by the tribe. It's valid to request any string as long as it would be possible for the tribe to develop the knowledge. Otherwise the requirement will never be met.

== Item ==

Syntax: item(x,y);

Arguments:
* 'x' is an item/building name.
* 'y' is an int defining the quantity of items needed.

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the item 'x' of quantity 'y'.

== Recipe ==

Syntax: recipe(x,y);

Arguments:
* 'x' is a recipe name.
* 'y' is an int defining the quantity of recipes needed.

Effect & Mechanics: Upon parsing this requirement, the parser just adds an 'y' number of 'x' recipes to the recipe tree.

This requirement isn't quite practical and should be avoided.

== Trader (Not available) ==

Syntax: trader(x);

Arguments:
* 'x' is an item name

Effect: This requirement should check the traders array for a nearby trader giving item 'x'.

== Memory ==

Syntax: memory(m,p,r);

Arguments:
* 'm' is a memory name
* 'p' is a probability between 0-100. Setting this to 10 make it 10% probably that the r will be run even if m is found.
* 'r' is a recipe that will be run if the memory isn't found.

Effect & Mechanics: Upon parsing this requirement, the parser checks the memory array for a memory called 'm'. If it is found, requirement is considered met. If it isn't found or the probability for failure has hit it will run the recipe 'r'.

= Algorithm Steps =

== AddKnowledge ==

Syntax: addKnowledge(x);

Arguments:
* 'x' can be any string.

Effect & Mechanics: Adds the 'x' token as a piece of knowledge in the knowledge array.

== AlterResource ==

Syntax: alterResource(x,y);

Arguments:
* 'x' is a resource name
* 'y' is an int describing quantity

Effect & Mechanics: Upon parsing this function, the parser modifies the quantity of resources available in the tribe.

Note: The 'y' value will be added to the current value in the tribe's bank. Use negative value to represent costs. (e.g. alterResource(gold,-20); in order to pay for a building)

== Attack ==

Syntax: attack();

Arguments: None.

Effect & Mechanics: It sends to previously selected members the 'tribe:attack' perception to attack a previously selected location. If the selected location is not an attackable entity they will simply move there and attack whatever is near.

== Gather ==

Syntax: gather();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected field and fires their 'tribe:gather' behavior.

== GoWork ==

Syntax: goWork(x);

Arguments:
* 'x' is an int defining the number of seconds the npcs should work for.

Effect & Mechanics: The 'goWork' function sends previously selected npcs to a previously selected location, set the npc buffer [Work_Duration] to 'x' and send 'tribe:work' behavior.

== Guard (Not available) ==

Note:
guard() function not implemented yet, use percept(selection, tribe:guard) instead.

Syntax: guard();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to guard the selected location. Members will just patrol the area and attack whatever poses a threat.

== LoadLocation ==

Syntax: loadLocation(x,y,z,r);

Arguments:
* 'x', 'y' and 'z' are a set of coordinates.
* 'r' is the location name.

Effect & Mechanics: add a new memory in the Database, adding a new location named "work" in the coordinates x,y,z.

== LocateMemory ==

Syntax: locateMemory(x,r);

Arguments:
* 'x' is a memory name.
* 'r' is a recipe to load if the memory 'x' isn't found.

Effect & Mechanics: It looks in the tribe's memory array for the memory called 'x' and loads it into the previous selected npc's buffers. It is vital to use it before basic functions like mine,gather,guard,attack that use the npc buffers to execute.

== LocateResource ==

Syntax: locateResource(x,r);

Arguments:
* 'x' is a resource name.
* 'r' the recipe to load if no resource 'x' is found

Effect & Mechanics: This function works like the above-mentioned 'locateMemory' function. The sole difference is that this function tries to locate resource 'x', and it case it fails it tries to locate memories 'mine' or 'field'. (which are the standard names of unprospected/undiscovered resource zones). In case nor 'mine' or 'field' are found, it sends the previous selected npcs to explore for them.

== LocateBuilding ==

Syntax: locateBuilding(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot on which there is an already constructed building. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

Example Tribe Script:

select(Worker,1);locateBuilding(Campfire);goWork(60);

== LocateBuildingSpot ==

Syntax: locateBuildingSpot(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot previously reserved via 'reserveBuildingSpot' function. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

This function also sets the building spot to INCONSTRUCTION. So a build command should be executed next.

The NPC can use the [[Behavior_Operations#Build Operation|Build Operation]] to build a building at the selected spot.

Example Tribe Script:

select(Worker,1);locateBuildingSpot(Campfire);percept(selection,tribe:build)

Example NPC Script:

<behavior name="DoBuild">
<locate obj="building_spot" />
<navigate />
<wait duration="$NBUFFER[Work_Duration]" />
<build />
<talk text="Nice work building this $NBUFFER[Building]" />
</behavior>
<react event="tribe:build" behavior="DoBuild" />

== Mate ==

Syntax: mate();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to their home and fires their 'tribe:breed' behavior.

Note: By default, the 'mate' functions requires no resources and has no checks. Use it in a recipe that checks that enough resources for breeding are available.

Examples:
select(any,1);
setBuffer(selection,Reproduce_Type,$member_type);
mate();
alterResource($REPRODUCTION_RESOURCE, -$REPRODUCTION_COST);

== Mine ==

Syntax: mine();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected mine and fires their 'tribe:mine' behavior.

== Percept ==

Syntax: percept(t,p);

Arguments:
* 't' is either selection or tribe
* 'p' is the perception to send

Effect & Mechanics: It sends a perception to previously selected members or to the tribe.

Examples:
select(any,1);
percept(selection,tribe:gather)
percept(tribe,tribe:flee)

== ReserveSpot ==

Syntax: reserveSpot(x,y,z,bname);

Arguments:
* 'x', 'y' and 'z' are coordinates in the same sector as the tribe
* 'bname' is the building name we want to reserve the spot for

Effect & Mechanics: This function is used so the scripter (you) can arrange the future village of the tribe. When creating a tribe, a recipe containing building spots should be wrote in order to pinpoint where building should be constructed in the future.

== Select ==

Syntax: select(x,y);

Arguments:
* 'x' is a tribe member type. Types can be crated using the [[Behavior_Operations#Reproduce_Operation|Reproduce Operation]]
* 'y' is an int defining the number of members to be selected.

Effect & Mechanics: The 'select' function is probably the most important algorithm step. It selects the members passed as arguments and keeps them in a temporary npc array so they can accept orders from the next algorithm steps. It actually works like selecting units and commanding them in a strategy game. After a 'select' function, all next algorithm steps apply to selected members only, until another 'select' command is issued or the recipe is completed.

Example:
// Will send 3 miners to mine for gold.
select(miner,3);
locateResource(gold,Explore);
mine();

== SetBuffer ==

Syntax: setBuffer(target,name,value);

Arguments:
* 'target' is either selection or tribe.
* 'name' is the name of the buffer to set.
* 'value' is the new value to set for Buffer.

For selection this resolve to NBUFFER[name] in recipes and $NBUFFER[name] in behaviors.
For tribes this resolve to TBUFFER[name] in recipes and $TBUFFER[name] in behaviors.

This set the buffers used by [[NPC Variables]] to replace buffers.

Example:

In an algorithm:
select(Worker,2);
setBuffer(selection,Work_Time,10);
percept(tribe:work);

In a NPC behavior:
<wait duration="$NBUFFER[Work_Time]" />

== SpawnMember ==
Syntax: spawnMember(x);

Arguments:
* 'x' is an integer and the ID of the master NPC to clone and spawn

Effect & Mechanics: This function spawns a new member of the tribe, without requiring anything else, in contrast with mate() that requires an existing member to spawn another member. This function can be used to create the first member of the tribe.

Example:

"Consumer Evolve Tribe" recipe with requirements: tribesman(number,1,Consumer Ancestor Spawn);

"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(42);

IMPORTANT: The master NPC ID, should be created in characters table + there must be an entry for this NPC in sc_npc_definitions table, with the AbstractTribesman. This will properly initialize the member of the tribe.

== Wait ==

Syntax: wait(x);

Arguments:
* 'x' is an float defining number seconds to halt recipe for.

Effect & Mechanics: This function sets the wait time for a recipe. By default, no recipes with a wait time bigger than 0 are reparsed. As a consequence, applying wait time to a recipe will make the parser halt the current recipe at the current algorithm step and parse other recipes that wait in line. The function will also fire the 'tribe:wait' reaction.

[[Category:Server Design]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]

Tribe Scripting

2026-01-03T23:16:08Z

Talad: /* Algorithm Steps */

= Recipe Logic =

== Recipes ==
'''A recipe database entry'''
{| border="1"
!id
!name
!requirements
!algorithm
!persistent
|-
|used for db storing
|Name of the recipe
|requirement string containing all requirements
|algorithm string containing all algorithm steps
|If this flag is on, the recipe won't ever be deleted from the recipe tree. After parsing it, if no other recipe has a higher priority... it will be reparsed.
|}

== Usage of Recipes ==

Recipes is used to describe how [[tribes]] react. See [[Tribe Design]] for details.

On initialization, a tribal recipe is first loaded in respect of the information indicated by the 'tribal_recipe' field. (see [[TribesTable|tribes.sql]]). The tribal recipe is formed from 'Tribe Info' functions. (see below)

Based on those functions the npctype for each tribe is created and initial recipes are loaded.

Further on, each Recipe has two important sections: requirements and algorithm. Each of those two is represented by a long string (the maximum is set in the database to 1000 characters) of functions separated by a semi-colon ';'. Upon parsing the long string is split in respect of the semicolons (;) and the recipe manager analyzes each resulting function.

== Recipe-Tree Nodes ==

Inside a tribe object, recipes are stored as Recipe Tree Nodes. This class was created to facilitate the management of recipes and the way recipes are selected to be parsed.

All recipes are stored as leaves in a tree. This way we can always know their hierarchy and precedence.

Besides the obvious usage as a tree, recipe tree nodes also hold vital data for recipe parsing: last requirement parsed, last algorithm step parsed, remaining waiting time.

Let's consider an example of a tribe which has some building spots available and the task to build on those spots.

Having the tree above, it's easy to select the actions required to complete the task. We first get some more food. After that we get the required members, search for wood and stone, and finally build the buildings.

= Tribe Info =

== Brain ==

Syntax: brain(x);

Arguments:
* x brain eg. behaviour to use for the tribe.

Effect: Override the AbstractTribesman as the brain for the tribe.

For each tribe the server create an tribe_<tribe_id> behavior that inherit from the brain given i the brain command. If no brain entry is given the tribe behaviour will use the AbstractTribesman behaviour. This can be used to create tribes with special behaviours.

== Aggressivity ==

Syntax: aggressivity(x);

Arguments:
* x in { warlike, neutral, peaceful }

Effect: Decides the way the tribe reacts to other entities around it's members:
* Warlike -- Attack anything on sight.
* Neutral -- Attack only if members are attacked.
* Peaceful -- If tribe members are attack they flee, trying to escape.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype in respect of this function's argument.

== Growth ==
Syntax: growth(x)

Arguments:

* x in ?

Not implemented , at the moment all tribes have "conservatory" as value

== Unity ==
Syntax: unity(x)

Arguments:

* x in {*, cowards}

At the moment anything but "cowards" will trigger one member of the tribe to help another member when attacked.

== SleepPeriod ==

Syntax: sleepPeriod(x);

Arguments: x in { diurnal, nocturnal, nosleep }

{|
|-
|diurnal
|22:00 - 06:00
|Sleep during night
|-
|nocturnal
|08:00 - 18:00
|Sleep during day
|}

Effect: Makes the tribe members sleep at the given period of day.

Mechanics: Upon parsing this function, an extra reaction is added to the tribal npctype. The reaction should react to timeofday perceptions.

== LoadRecipe ==

Syntax: loadRecipe(x); loadRecipe(x,distributed);

Arguments:
* 'x' is a Recipe Name

Effect: Loads a recipe into the recipe tree. The new recipe's priority will be the current recipe's priority + 1.

== LoadCyclicRecipe ==

Syntax: loadCyclicRecipe(x,t);

Arguments:
* 'x' is a Recipe Name
* 't' is an int, representing the number of ticks (milliseconds) between recipe executions

Effect: Loads a recipe into the recipe tree once every 't' ticks, with highest priority.

= Requirements =

== Building ==

Syntax: building(x,y,r);

Arguments:
* 'x' is a building name.
* 'y' is an int defining the quantity of buildings needed.
* 'r' is the recipe needed to get the building if not available

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the building 'x' of quantity 'y'.

== Tribesman ==

Syntax: tribesman(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' regardless if they are busy or doing something else. If 'y' members are found, the requirement is considered met.

== TribesmanIdle ==

Syntax: tribesmanidle(x,y,r);

Arguments:
* x is a tribesman type (types are not well-defined at the moment). Keyword 'any' is accepted too in order to define any member.
* y is an int defining the number of tribesmen needed
*r is the recipe needed to spawn a new member if not enough members are found

Effect & Mechanics: The tribal object checks for a number 'y' of tribesman typed 'x' with the current behavior equal to the tribe's idle behavior. (e.g. "do nothing" behavior) If 'y' members are found idle, the requirement is considered met.

== Resource ==

Syntax: resource(x,y,r);

Arguments:
* x is the resource name
* y is the resource quantity required
* r is the recipe needed to get the resource if not available

Effect & Mechanics: The tribal object checks for a 'y' quantity of 'x' resource. If this quantity is found then the resource is considered complete. $RESOURCE_AREA, $REPRODUCTION_RESOURCE and $REPRODUCTION_COST are valid variables.

Judging by the way natural resources are defined, any string declared in natural_resources.sql as a resource can be parsed and mined by the tribe. By default, any new mine found by the tribesmen is stored as a memory named 'mine'. Upon it's first mining action done on the 'mine' memory, a reward is granted to the npc. When the NPC gets home and gives that to the tribal object, the memory 'mine' is renamed after the reward. In conclusion, having a resource named 'Space Shuttle' is valid and works.

Note: The resource requirement just checks if enough resources are available. Use 'alterResource' function in your recipes in order to actually substract resource from the tribe bank.

== Knowledge ==

Syntax: knowledge(x);

Arguments: 'x' can be any string.

Effect & Mechanics: As described in the [[Tribe Design]] document, knowledge are tokens that keep track on technologies developed by the tribe. It's valid to request any string as long as it would be possible for the tribe to develop the knowledge. Otherwise the requirement will never be met.

== Item ==

Syntax: item(x,y);

Arguments:
* 'x' is an item/building name.
* 'y' is an int defining the quantity of items needed.

Effect & Mechanics: At the moment, items are 'magically' stored inside the tribal object. This object keeps track on items and buildings with the 'Asset' structure. 'x' can be any string with the condition that the tribe can actually gain the requested asset. Otherwise the requirement will never be met. Upon parsing this requirement, the tribal object checks it's asset arrays for the item 'x' of quantity 'y'.

== Recipe ==

Syntax: recipe(x,y);

Arguments:
* 'x' is a recipe name.
* 'y' is an int defining the quantity of recipes needed.

Effect & Mechanics: Upon parsing this requirement, the parser just adds an 'y' number of 'x' recipes to the recipe tree.

This requirement isn't quite practical and should be avoided.

== Trader (Not available) ==

Syntax: trader(x);

Arguments:
* 'x' is an item name

Effect: This requirement should check the traders array for a nearby trader giving item 'x'.

== Memory ==

Syntax: memory(m,p,r);

Arguments:
* 'm' is a memory name
* 'p' is a probability between 0-100. Setting this to 10 make it 10% probably that the r will be run even if m is found.
* 'r' is a recipe that will be run if the memory isn't found.

Effect & Mechanics: Upon parsing this requirement, the parser checks the memory array for a memory called 'm'. If it is found, requirement is considered met. If it isn't found or the probability for failure has hit it will run the recipe 'r'.

= Algorithm Steps =

== AddKnowledge ==

Syntax: addKnowledge(x);

Arguments:
* 'x' can be any string.

Effect & Mechanics: Adds the 'x' token as a piece of knowledge in the knowledge array.

== AlterResource ==

Syntax: alterResource(x,y);

Arguments:
* 'x' is a resource name
* 'y' is an int describing quantity

Effect & Mechanics: Upon parsing this function, the parser modifies the quantity of resources available in the tribe.

Note: The 'y' value will be added to the current value in the tribe's bank. Use negative value to represent costs. (e.g. alterResource(gold,-20); in order to pay for a building)

== Attack ==

Syntax: attack();

Arguments: None.

Effect & Mechanics: It sends to previously selected members the 'tribe:attack' perception to attack a previously selected location. If the selected location is not an attackable entity they will simply move there and attack whatever is near.

== Gather ==

Syntax: gather();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected field and fires their 'tribe:gather' behavior.

== GoWork ==

Syntax: goWork(x);

Arguments:
* 'x' is an int defining the number of seconds the npcs should work for.

Effect & Mechanics: The 'goWork' function sends previously selected npcs to a previously selected location, set the npc buffer [Work_Duration] to 'x' and send 'tribe:work' behavior.

== Guard (Not available) ==

Note:
guard() function not implemented yet, use percept(selection, tribe:guard) instead.

Syntax: guard();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to guard the selected location. Members will just patrol the area and attack whatever poses a threat.

== LoadLocation ==

Syntax: loadLocation(x,y,z,r);

Arguments:
* 'x', 'y' and 'z' are a set of coordinates.
* 'r' is the location name.

Effect & Mechanics: add a new memory in the Database, adding a new location named "work" in the coordinates x,y,z.

== LocateMemory ==

Syntax: locateMemory(x,r);

Arguments:
* 'x' is a memory name.
* 'r' is a recipe to load if the memory 'x' isn't found.

Effect & Mechanics: It looks in the tribe's memory array for the memory called 'x' and loads it into the previous selected npc's buffers. It is vital to use it before basic functions like mine,gather,guard,attack that use the npc buffers to execute.

== LocateResource ==

Syntax: locateResource(x,r);

Arguments:
* 'x' is a resource name.
* 'r' the recipe to load if no resource 'x' is found

Effect & Mechanics: This function works like the above-mentioned 'locateMemory' function. The sole difference is that this function tries to locate resource 'x', and it case it fails it tries to locate memories 'mine' or 'field'. (which are the standard names of unprospected/undiscovered resource zones). In case nor 'mine' or 'field' are found, it sends the previous selected npcs to explore for them.

== LocateBuilding ==

Syntax: locateBuilding(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot on which there is an already constructed building. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

Example Tribe Script:

select(Worker,1);locateBuilding(Campfire);goWork(60);

== LocateBuildingSpot ==

Syntax: locateBuildingSpot(x);

Arguments:
* 'x' is a building name.

Effect & Mechanics: This functions locates a building spot previously reserved via 'reserveBuildingSpot' function. It searches for building spots in the asset array and set the selected assess in the npc "building_spot" variable.

NBUFFER[Building] is set to x, and NBUFFER[Work_Duration] is set to the building time of the building.

This function also sets the building spot to INCONSTRUCTION. So a build command should be executed next.

The NPC can use the [[Behavior_Operations#Build Operation|Build Operation]] to build a building at the selected spot.

Example Tribe Script:

select(Worker,1);locateBuildingSpot(Campfire);percept(selection,tribe:build)

Example NPC Script:

<behavior name="DoBuild">
<locate obj="building_spot" />
<navigate />
<wait duration="$NBUFFER[Work_Duration]" />
<build />
<talk text="Nice work building this $NBUFFER[Building]" />
</behavior>
<react event="tribe:build" behavior="DoBuild" />

== Mate ==

Syntax: mate();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to their home and fires their 'tribe:breed' behavior.

Note: By default, the 'mate' functions requires no resources and has no checks. Use it in a recipe that checks that enough resources for breeding are available.

Examples:
select(any,1);
setBuffer(selection,Reproduce_Type,$member_type);
mate();
alterResource($REPRODUCTION_RESOURCE, -$REPRODUCTION_COST);

== Mine ==

Syntax: mine();

Arguments:
* None.

Effect & Mechanics: It sends previously selected members to a previously selected mine and fires their 'tribe:mine' behavior.

== Percept ==

Syntax: percept(t,p);

Arguments:
* 't' is either selection or tribe
* 'p' is the perception to send

Effect & Mechanics: It sends a perception to previously selected members or to the tribe.

Examples:
select(any,1);
percept(selection,tribe:gather)
percept(tribe,tribe:flee)

== ReserveSpot ==

Syntax: reserveSpot(x,y,z,bname);

Arguments:
* 'x', 'y' and 'z' are coordinates in the same sector as the tribe
* 'bname' is the building name we want to reserve the spot for

Effect & Mechanics: This function is used so the scripter (you) can arrange the future village of the tribe. When creating a tribe, a recipe containing building spots should be wrote in order to pinpoint where building should be constructed in the future.

== Select ==

Syntax: select(x,y);

Arguments:
* 'x' is a tribe member type. Types can be crated using the [[Behavior_Operations#Reproduce_Operation|Reproduce Operation]]
* 'y' is an int defining the number of members to be selected.

Effect & Mechanics: The 'select' function is probably the most important algorithm step. It selects the members passed as arguments and keeps them in a temporary npc array so they can accept orders from the next algorithm steps. It actually works like selecting units and commanding them in a strategy game. After a 'select' function, all next algorithm steps apply to selected members only, until another 'select' command is issued or the recipe is completed.

Example:
// Will send 3 miners to mine for gold.
select(miner,3);
locateResource(gold,Explore);
mine();

== SetBuffer ==

Syntax: setBuffer(target,name,value);

Arguments:
* 'target' is either selection or tribe.
* 'name' is the name of the buffer to set.
* 'value' is the new value to set for Buffer.

For selection this resolve to NBUFFER[name] in recipes and $NBUFFER[name] in behaviors.
For tribes this resolve to TBUFFER[name] in recipes and $TBUFFER[name] in behaviors.

This set the buffers used by [[NPC Variables]] to replace buffers.

Example:

In an algorithm:
select(Worker,2);
setBuffer(selection,Work_Time,10);
percept(tribe:work);

In a NPC behavior:
<wait duration="$NBUFFER[Work_Time]" />

== SpawnMember ==
Syntax: spawnMember(x);

Arguments:
* 'x' is an integer and the ID of the master NPC to clone and spawn

Effect & Mechanics: This function spawns a new member of the tribe, without requiring anything else, in contrast with mate() that requires an existing member to spawn another member. This function can be used to create the first member of the tribe.

Example:

"Consumer Evolve Tribe" recipe with requirements: tribesman(number,1,Consumer Ancestor Spawn);

"Consumer Ancestor Spawn" recipe with no requirements and script: spawnMember(156);

== Wait ==

Syntax: wait(x);

Arguments:
* 'x' is an float defining number seconds to halt recipe for.

Effect & Mechanics: This function sets the wait time for a recipe. By default, no recipes with a wait time bigger than 0 are reparsed. As a consequence, applying wait time to a recipe will make the parser halt the current recipe at the current algorithm step and parse other recipes that wait in line. The function will also fire the 'tribe:wait' reaction.

[[Category:Server Design]] [[Category:NPCClient Design]] [[Category:NPCClient Scripting]]

PSUnreal GDB Debug Hints

2026-01-01T22:37:26Z

Talad:

=== psItem ===
print (TCHAR*)item->current_stats->name

=== psCharacter ===
print (TCHAR*)client->name

== Jetbrains Rider debug ==
To have a conditional breakpoint for an FString use this: name==L"Trepor"

Players Guide/Magic

2025-12-29T22:37:05Z

Talad: /* Enchanted items */

The magical energy in [[Yliakum]] is divided into six ways of arcane: [[Players Guide/Magic#Crystal Way | Crystal Way]], [[Players Guide/Magic#Azure Way | Azure Way]], [[Players Guide/Magic#Red Way | Red Way]], [[Players Guide/Magic#Dark Way | Dark Way]], [[Players Guide/Magic#Brown Way | Brown Way]] and [[Players Guide/Magic#Blue Way | Blue Way]].
[[Image:Magecasting.jpeg|thumb|300px]]

==The Ways of Magic==
[[Image:Ways.png|left|150px]]
Each Way has a particular color and a [[Ingame Help#Stats and Skills | mental stat]] associated. The three mental stats linked to magic are: [[Players Guide#Stats and Skills|Charisma]], [[Players Guide#Stats and Skills|Intelligence]] and [[Players Guide#Stats and Skills|Willpower]]. They give bonuses to the casting of spells that pertain to that way.

Each way is composed of a set of spells and each spell can be casted by a wizard thanks to the combination of a set of runes, called [[Players Guide/Magic#The Glyphs | "glyphs"]]. The spells of a particular Way are related to the same energy and the same concepts (Water, Air or Healing, Drain). They produce either a direct damage or a damage over time on the opponent.

The ways are all somewhat linked by relationship of opposition or attraction. A specific way opposes another and is "friendly" with two others (ie. Crystal Way opposes Dark Way and is friendly with Blue and Azure Way).
Therefor, each spell giving a buff for a given time will provide at least a small way resistance (ie. Casting a Red Way "Strength" spell on yourself will also protect you slightly againt Blue Way).

----

===Crystal Way (CW)===
Users of this Way, get the pure energy of the [[Azure Sun|Crystal]], more directly than all other Ways. Famous for the ability to heal, and cure the most terrible wounds, people have said that if you reach a great knowledge, you can even bring back a person from death. Nonetheless there are many powerful offensive spells, particularly effective against evil and dark creatures. While warriors and farmers with injured animals are more then happy to see these practitioners around; around most towns people feel the appearance of these practitioners is a bad omen of bad times to come.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:CrystalWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| White || Energy, Life and Light || Buff Self & Allies, Direct Damage, Direct Healing || Charisma || Opposed to: Dark Way
Friendly with: Blue & Azure Way
|}

===Dark Way (DW)===
This Way is one that conquers more myth then any of the others. Its practitioners have a history of being the most innovative of any practitioners of the Ways of Magic, but with all innovation there is both good and bad. It's well known that many disasters and epidemics were caused by the adepts of this ancient Way. Holding some spells with terrifying effects, things can become even worse if you lose the control of its power. Some spells enable the control of horrific creatures, such as undead, demons and spirits, whilst some enable the caster to control objects and people in a subtle manner at distance.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:DarkWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Black || Entropy, Death and Darkness || Fear & Debuff, Drain, Direct Damage and Damage Over Time || Charisma || Opposed to: Crystal Way
Friendly with: Brown & Red Way
|}

===Azure Way (AW)===
Basically a sneaky and insidious energy, the Azure Way can control the will, the perceptions and the intentions of any intelligent being. It's power comes from the deep knowledge of the mind and the way to influence it, but it relies also on the mind's potential to influence the surrounding areas and objects, particularly all that is related to the air element.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:AzureWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Light Blue || Mind, Illusion and Air element ||Charm & Buff NPCs, Paralyzation, Minor Direct Damage and Damage Over Time || Will || Opposed to: Brown Way
Friendly with: Crystal & Red Way
|}

===Red Way (RW)===
The spellcaster is able to invoke the power of Chaos, and to bend to his/her/kra's will the devastating fury of fire, summoning it for its both damaging and purifying qualities. Spells of the Red Way can also instil courage and strength into companions or other creatures. Most spells in this Way are fire related, and the majority of metal workers have knowledge of it.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:RedWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Red || Strength, Chaos & Fire element||Major Direct Damage, Combat Buffs|| Will || Opposed to: Blue Way
Friendly with: Azure & Dark Way
|}

===Blue Way (BlW)===
Many diseases and poisons would be incurable without the help of the spells of this Way. The offensive and defensive potential of this art reside mainly on the control of the water element, but also of cold and ice that are strictly related to it. Equally inestimable are the divination spells that can provide very useful information on the past, present and future.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BlueWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Blue || Divination, Purification and Water element ||Immobilize, Major Damage Over Time, Healing Over Time, Polymorph|| Intelligence ||Opposed to: Red Way
Friendly with: Brown & Crystal Way
|}

===Brown Way (BrW)===
The glyphs of this Way give to the wizard the ability to cast different protective spells, to summon natural creatures and some monsters and to influence their will. This Way is really close to the element of Earth and can control all that's related to it. Users can call nature spirits for assistance or mark themselves and allies as friends of nature.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BrownWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Brown || Nature, Protective magic and Earth element ||Defensive Buff, Summon Monster, Direct Damage, Immobilization, Minor Polymorph|| Intelligence ||Opposed to: Azure Way
Friendly with: Blue & Dark Way
|}

==Casting a Spell==
===The Glyphs===
At the beginning of [[Players Guide/Yliakum History | Yliakum History]], the [[God|god]] [[Talad]], forged pure magical energy into shapes called "Glyphs". They form the base of Yliakum magic.

* No spell can be casted without a glyph.

They are found in nature with no real explanation, no one knows exactly why they form but when some type of energy is strongly present in one place a glyph can form. Glyphs patterns appear on very different materials from a leaf to the fur of an animal and usually on any type of rock.

During the centuries many glyphs have been found and studied by the wizards. They discovered that each glyph can create a spell effect and that several glyphs can be combined to obtain greater effects. To simplify casting of spells, the glyphs are associated with a concept (ie. "Weight") and wizards combine those concepts to form new spells (ie. "Weight" and "Negate" to become very light).

Nowadays, glyphs can be found rendering services to the people of Yliakum or can be bought to mages like [[Levrus Dahrenn]] in the [[Magic Shop | magic shop]] for the more basic of them. The more rare and powerfull glyphs can be obtained by joining a Way Circle (school of magic) and follow its path to the Mastery of a particular Way.

* The glyphs purchased or rewarded will appear in your [[Ingame Help#Inventory Window | Inventory]] and be visible in the Glyphs Window in your [[Ingame Help#Spell Book Window | Spell Book]].

[[File:Glyphs.jpg|500px]]

===Purification===
To use a glyph, the wizard must apply a process of Purification, which take some time. The Purification establish a strong link in between the wizard and his glyph. If he dies, the glyphs will be taken to the [[Death|Death Realm]] with him. A wizard can trade a glyph, but the recipient will need to purify the glyph as well to create a new magic link and be able to use it.

* To purify a glyph, open the Glyph window from your Spell Book.
* Drag the glyph and drop it on the button called: '''Purify'''.
* When the Purification is done, you will see a message in your Chat Window > System Tab and your glyph will be surrounded of a white aura.

===Researching a Spell===
[[Image:SpellbookVen.jpg|300px|thumb|left]]
Once you have one or more glyphs, you can start to research spells. To be discovred, a spell can ask one glyph or a combinaison of up to 3 glyphs.

Shown on this pic is the glyph window of your Spell Book. The six main boxes will content the glyphs of the six ways of magic. The small row of boxes at the bottom of the window is where you put glyphs in order to combine or purify them.
* To discover a spell, drag one or several glyphs in the small row of boxes at the bottom of the window and hit the button called: '''Research'''.
* When you effectivly discovred a spell, its name and description will appear.
* Once discovred, the spell will automatically be added in your Spell Book. You wont have to research it again to cast it.

In this example, the Blue Way glyph "Cold" has been placed in the box and the wizard has discovred the spell called "Freeze".
* If you fail to discover a spell it might be for several raison : the combinaison of glyphs isn't right; you have not trained that way of magic high enough; or the glyph isn't purified.
Researching a spell is dangerous for the wizard. In effect, it ask a lot of mental focus and the strong magical energy at work may wound an unwary magician.

===Casting===
There are two great categories of spells available to the wizards: the enhancing spells that we call "buffs" and the attack spells.

The enhancing spells like "Rock Armor" (Brown Way) are made to be cast on the wizard. They enhance one health or stamina or increase one defensive ability. Some of those spells can be cast on friends, like "Life Infusion" (CW).

The attack spells like "Flame Burst" (RW) are made to defeat enemies. Some are efficient in close range, some in very long range. Those spells can be cast on players too in case of [[General FAQ#Will there be Player vs. Player combat in PlaneShift?|PvP]] (player versus player).

The process to cast a spell is as follow:
* Select your character or an enemy [[Non-Player Character|NPC]]
* Open your spell book, select the spell you wish to cast and click '''Cast Spell'''.
There is many ways to make this operation less long. The quickest one is to create a [[Ingame Help#Shortcuts Window|shortcut]] of the spell you plan to use a lot.
* Once you clicked on the chosen spell, a count down window will appear. When it is finished, the spell will be cast.

[[Image:magepower.jpeg|left|thumb|400px]] [[Image:Magered.jpg|center|thumb|350px]]

==Magic Mechanism==

===Type of Damage===

Spells and Magical effects can have different type of effects:

'''Direct Damage''' (DD): direct damage is applied as soon as the spell has been cast. Red Way offensive spells usually deal direct damage.

'''Damage over Time''' (DoT): this damage is applied over a period of time. Starting from when the spells has been successfully cast and until the spell duration runs out, the target HPs are constantly reduced. Blue Way offensive spells usually deal damage over time. This type of damage usually deal more damage than an equivalent realm spell, on the other side the duration can allow the target to try to heal itself or dispel the offensive spell.

===Damage and Saving Throws===
When a spell deals damage may allow the opponent to roll a ''saving throw'' to reduce the amount of damage sustained; this ''saving throw'' is made by the server confronting the caster and the target knowledge of the spell's magic way (e.g. Crystal Magic) plus a random factor: the higher is the target's knowledge of the way the higher is the chance to succeed the roll. When a target successfully roll the save the spell damage is usually halved.
If a spell which deals damage does not allow for a ''saving throw'' roll, that spell will usually deal about 70% less damage than an equivalent spell (same realm and same magic way).

<div style="background: #efe; padding: 4px 4px; width: 1000px">
[[Image:Fountain.png|40px]] '''Tip: The higher is your knowledge in a way the higher is your chance to counter or avoid damage and effects of the same way.'''
</div>

===Magic Resistance===
...

===Spell Power (KFactor)===
''(under construction)''
The spell caster can decide to channel more mana into casting by setting the additional spell power, allowing the caster to cast a more powerful spell.

The additional spell power factor is expressed as a percentage value, from 0% to 100%. If you set an additional spell power factor of 50% then you will channel an additional 50% of the base mana requirement for a spell into the spell.

The more you push the additional spell power, the more you must have affinity with the ways and its associated Mental Stat to control the effects. The power level of the spell is raised by the additional spell power, so the spell will be more powerful.

The use of additional spell power has the side-effect that the spell can fizzle or even produce damages to the caster, depending on how much the spell goes out of control.

To set your additional spell power, use the slider in your Status Window.

===Spellcasting Time===
...

=Enchanted items=
Glyphs can be used in combination with special Enchanters to imbue crystals (ruby, sapphire, emerald and diamond) with magical powers. These crystals held or set on items during their particular crafting stage. Once set the enchanted gem bestow its magical power on the enchanted item.
Each gem can be enchanted with only one glyph at time, therefore a single item cannot be enchanted with more than a single way.

Please note that the modifiers found in randomly looted weapons are different from the ones you may obtain by crafting with glyphs.

The process is:

1) Get a ruby, sapphire, emerald or diamond crystal

2) Get a glyph you want to use for the enchantment. The glyphs is NOT destroyed in the proces.

3) You need to have one of these two books: "Enchanting Gems of Spirit" or "Enchanting Gems of Power"

4) You need access to a special equipment: "Enchanter of Power" (used with glyphs of Crystal, Brown, Blue Ways) or "Enchanter of Spirit" (used with glyphs of Dark, Red, Azure Ways).

5) Certain glyphs can be put only in certain gems

6) You put the glyph you want to use in your right hand, and the gem into the Enchanter container. Then you "Use" the Enchanter.

7) The result is an enchanted gem, for example Meteor Glyph + Sapphire Crystal with Enchanter of Spirit creates "Flaming Major Sapphire Crystal". So the item got a Prefix and an Adjective which provide magical properties. The gem has to be identified with a spell to read its properties.

8) You have to craft a weapon where you will set the socket with the gem. For example you arrive up to the "Battle Hammer Assembly", before making the final hammer. This is true for all crafted weapons, shields, armors and jewelry, as all have the "Assembly" or "Kit" stage before the final item is created.

9) You have to craft a Gem Socket. This can be of three types, of increasing quality and complexity to make: Standard, Superior and Perfect. This will determine the gems you can use with that socket. Standard -> Ruby, Superior -> Emerald and Sapphire, Perfect -> Diamond

10) You can put together the pieces, the gem socket and the kit to create the final enchanted item. This item will take the modifiers (magical properties) of the gem.

===Weapons & Shields===
Weapons usually '''empower''' the weapon's '''damage type''' and add a special ability. The following list associate the damage type with the related magic way:
* ''Blue Way & Red Way'': slash damage
* ''Crystal Way & Dark Way'': pierce damage
* ''Azure Way & Brown Way'': blunt damage

More powerful enchantments can also bestow the weapon the following effects:
* ''Blue Way'': deals extra frost damage (Red Way Magic Resistance protects against this extra damage)
* ''Crystal Way'': deals extra light damage and gives a Disorientation debuff (Dark Way Magic Resistance protects against this extra damage)
* ''Azure Way'': drains Mana (Brown Way Magic Resistance protects against this extra damage)
* ''Red Way'': deals extra fire damage (Blue Way Magic Resistance protects against this extra damage)
* ''Dark Way'': drains HP (Crystal Way Magic Resistance protects against this extra damage)
* ''Brown Way'': drains Strength (Azure Way Magic Resistance protects against this extra damage)

===Armors===
Enchanted Armors gives '''Magic Resistance''' against the way '''opposed''' to the enchanted glyph. More powerful glyphs can also give magic resistance against ways friendly toward the opposed way, therefore a single piece of armor can have magic resistance against up to '''three''' ways. Like weapons a magic way '''empower''' the related '''protection type'''.

===Jewelry===
Enchanted Jewels '''empower skills''' related to the magic way used to enchant, below there is the list of way related skills:

'''Azure Way'''
* Empathy
* Set Traps
* Find Traps
* Knives & Daggers
* Light Armor
'''Blue Way'''
* Pottery
* Masonry
* Fishing
* Heavy Armors
'''Brown Way'''
* Harvesting
* Leatherworking
* Tailoring
* Light Armor
'''Crystal Way'''
* Musical Instrument
* Hide in Shadows
* Drawing
* Medium Armor
'''Dark Way'''
* Pickpockets
* Repair Armors
* Backstab
* Medium Armor
'''Red Way'''
* Tool Making
* Blacksmith
* Jewelry Making
* Repair Tools
* Heavy Armor

=In Character References=
{| class="wikitable"
| style="background:#F5DEB3;" | [[image:lexicon.jpg]]
| style="background:#F5DEB3;" | In game, a couple of books refer to Magic. They can be found in the famous Hydlaa [[Library|library]] owned by the Ylian [[Jayose]] or in the magic shop of Levrus:
* ''History of Magic Vol 1: The Birth''
* ''History of Magic Vol 2: The Taming''
* ''History of Magic Vol.3: The Invasions''
* ''History of Magic Vol.4: The Heresy''
* ''History of Magic Vol.5: The Ways''
|}

* Go to [[Players_Guide#Game_Basics|Player Guide]]

[[Category:Magic]]
[[Category:Glyphs]]
[[Category:Game Guides]]
[[Category:Players Guide (Old)]]

Network load

2025-12-20T22:23:19Z

Talad:

=== Unreal engine 5.1.1 - PSServer 0.7.41 ===
5 players online after event with 15

> nload

Incoming:

Curr: 185.34 kBit/s

Avg: 184.02 kBit/s

Min: 152.20 kBit/s

Max: 355.02 kBit/s

Outgoing:

Curr: 29.88 kBit/s

Avg: 34.55 kBit/s

Min: 26.26 kBit/s

Max: 60.16 kBit/s

=== Unreal Engine 5.4.3 - PSServer 0.7.48 ===
Saturday event with 23 players online

> nload

Incoming:

Curr: 534.70 kBit/s

Avg: 587.16 kBit/s

Min: 482.02 kBit/s

Max: 739.51 kBit/s

Outgoing:

Curr: 320.27 kBit/s

Avg: 395.70 kBit/s

Min: 237.39 kBit/s

Max: 653.91 kBit/s

=== Unreal Engine 5.4.3 - PSServer 0.7.52 ===
Saturday event with 22 players online

Incoming:

Curr: 919.27 kBit/s

Avg: 706.23 kBit/s

Min: 367.48 kBit/s

Max: 2.03 MBit/s

Outgoing:

Curr: 160.20 kBit/s

Avg: 234.08 kBit/s

Min: 87.16 kBit/s

Max: 461.51 kBit/s

Crafting

2025-12-03T22:09:53Z

Talad:

Crafting, the art of creating something out of something else, is an ability that [[PlaneShift]] promotes.

==Crafts==
A lot of crafts are already available in game. Some are on the verge of being implemented.

====Crafts currently implemented====
* Alchemy ([[Players_Guide/Skills#Alchemy|Player Guide]])
* Blacksmith ([[Players_Guide/Skills#Blacksmith|Player Guide]])
** Armor Making ([[Players_Guide/Skills#Armor Making|Player Guide]])
** Blades Making (Player Guide : [[Players_Guide/Skills#Knife Making|Knife]], [[Players_Guide/Skills#Sword Making|Swords]], [[Players_Guide/Skills#Axe Making|Axe]])
** Mace Making (Player Guide : [[Players_Guide/Skills#Mace Making|Mace]])
** Shield Making ([[Players_Guide/Skills#Shield Making|Player Guide]])
* Bow-making ([[Players_Guide/Skills#Bow making|Player Guide]])
* Brewing ([[Players_Guide/Skills#Brewing|Player Guide]])
* [[Cooking]]
** [[Baking]]
* [[Fishing]]
* [[Harvesting]]
* [[Herbal]]
* Jewelry Making ([[Players_Guide/Skills#Jewelry Making|Player Guide]])
* [[Leatherworking]]
* [[Metallurgy]]
* [[Mining]]
* Musical Instruments ([[Players_Guide/Skills#Musical Instrument|Player Guide]])
* [[Repair Armors]]
* [[Repair Weapons]]

====Crafts not currently implemented====
* Drawing
* Gem-cutting ([[Players_Guide/Skills#Gem_cutting|Player Guide]])
* Glass-blowing ([[Players_Guide/Skills#Glassblowing|Player Guide]])
* Masonry ([[Players_Guide/Skills#Masonry|Player Guide]])
* Painting ([[Players_Guide/Skills#Painting|Player Guide]])
* Pottery ([[Players_Guide/Skills#Pottery|Player Guide]])
* Repair Tools
* Tailoring ([[Players_Guide/Skills#Tailoring|Player Guide]])
* Tool Making

==How do I...?==
Check your crafting page above.

See also [[Players Guide/Crafting]]

==Expanding Crafting==

Crafting can be expanded by players and contributors if they get the right knowledge on how to do it. Here you can find a spreadsheet which the developers use to add new crafting processes to the game. If you are interested in adding a new craft, you can populate this excel file and post it here or contact the devs about it. If you want to work with multiple people on it, we suggest you to import this excel file into google docs, and then give access to your team mates.

[http://www.planeshift.it/download/example_crafting_sheet.xls Example Crafting Excel.]

== Extra crafting properties ==
When you craft an item there is a chance based on the worker skill to get an extra prefix:

- Valuable

- Extravagant

- Priceless

It ranges from 3% to 5%

[[Category:Crafting|!]]
[[Category:Yliakum]]

Players Guide/Magic

2025-11-29T18:10:31Z

Talad: /* Enchanted items */

The magical energy in [[Yliakum]] is divided into six ways of arcane: [[Players Guide/Magic#Crystal Way | Crystal Way]], [[Players Guide/Magic#Azure Way | Azure Way]], [[Players Guide/Magic#Red Way | Red Way]], [[Players Guide/Magic#Dark Way | Dark Way]], [[Players Guide/Magic#Brown Way | Brown Way]] and [[Players Guide/Magic#Blue Way | Blue Way]].
[[Image:Magecasting.jpeg|thumb|300px]]

==The Ways of Magic==
[[Image:Ways.png|left|150px]]
Each Way has a particular color and a [[Ingame Help#Stats and Skills | mental stat]] associated. The three mental stats linked to magic are: [[Players Guide#Stats and Skills|Charisma]], [[Players Guide#Stats and Skills|Intelligence]] and [[Players Guide#Stats and Skills|Willpower]]. They give bonuses to the casting of spells that pertain to that way.

Each way is composed of a set of spells and each spell can be casted by a wizard thanks to the combination of a set of runes, called [[Players Guide/Magic#The Glyphs | "glyphs"]]. The spells of a particular Way are related to the same energy and the same concepts (Water, Air or Healing, Drain). They produce either a direct damage or a damage over time on the opponent.

The ways are all somewhat linked by relationship of opposition or attraction. A specific way opposes another and is "friendly" with two others (ie. Crystal Way opposes Dark Way and is friendly with Blue and Azure Way).
Therefor, each spell giving a buff for a given time will provide at least a small way resistance (ie. Casting a Red Way "Strength" spell on yourself will also protect you slightly againt Blue Way).

----

===Crystal Way (CW)===
Users of this Way, get the pure energy of the [[Azure Sun|Crystal]], more directly than all other Ways. Famous for the ability to heal, and cure the most terrible wounds, people have said that if you reach a great knowledge, you can even bring back a person from death. Nonetheless there are many powerful offensive spells, particularly effective against evil and dark creatures. While warriors and farmers with injured animals are more then happy to see these practitioners around; around most towns people feel the appearance of these practitioners is a bad omen of bad times to come.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:CrystalWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| White || Energy, Life and Light || Buff Self & Allies, Direct Damage, Direct Healing || Charisma || Opposed to: Dark Way
Friendly with: Blue & Azure Way
|}

===Dark Way (DW)===
This Way is one that conquers more myth then any of the others. Its practitioners have a history of being the most innovative of any practitioners of the Ways of Magic, but with all innovation there is both good and bad. It's well known that many disasters and epidemics were caused by the adepts of this ancient Way. Holding some spells with terrifying effects, things can become even worse if you lose the control of its power. Some spells enable the control of horrific creatures, such as undead, demons and spirits, whilst some enable the caster to control objects and people in a subtle manner at distance.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:DarkWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Black || Entropy, Death and Darkness || Fear & Debuff, Drain, Direct Damage and Damage Over Time || Charisma || Opposed to: Crystal Way
Friendly with: Brown & Red Way
|}

===Azure Way (AW)===
Basically a sneaky and insidious energy, the Azure Way can control the will, the perceptions and the intentions of any intelligent being. It's power comes from the deep knowledge of the mind and the way to influence it, but it relies also on the mind's potential to influence the surrounding areas and objects, particularly all that is related to the air element.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:AzureWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Light Blue || Mind, Illusion and Air element ||Charm & Buff NPCs, Paralyzation, Minor Direct Damage and Damage Over Time || Will || Opposed to: Brown Way
Friendly with: Crystal & Red Way
|}

===Red Way (RW)===
The spellcaster is able to invoke the power of Chaos, and to bend to his/her/kra's will the devastating fury of fire, summoning it for its both damaging and purifying qualities. Spells of the Red Way can also instil courage and strength into companions or other creatures. Most spells in this Way are fire related, and the majority of metal workers have knowledge of it.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:RedWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Red || Strength, Chaos & Fire element||Major Direct Damage, Combat Buffs|| Will || Opposed to: Blue Way
Friendly with: Azure & Dark Way
|}

===Blue Way (BlW)===
Many diseases and poisons would be incurable without the help of the spells of this Way. The offensive and defensive potential of this art reside mainly on the control of the water element, but also of cold and ice that are strictly related to it. Equally inestimable are the divination spells that can provide very useful information on the past, present and future.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BlueWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Blue || Divination, Purification and Water element ||Immobilize, Major Damage Over Time, Healing Over Time, Polymorph|| Intelligence ||Opposed to: Red Way
Friendly with: Brown & Crystal Way
|}

===Brown Way (BrW)===
The glyphs of this Way give to the wizard the ability to cast different protective spells, to summon natural creatures and some monsters and to influence their will. This Way is really close to the element of Earth and can control all that's related to it. Users can call nature spirits for assistance or mark themselves and allies as friends of nature.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BrownWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Brown || Nature, Protective magic and Earth element ||Defensive Buff, Summon Monster, Direct Damage, Immobilization, Minor Polymorph|| Intelligence ||Opposed to: Azure Way
Friendly with: Blue & Dark Way
|}

==Casting a Spell==
===The Glyphs===
At the beginning of [[Players Guide/Yliakum History | Yliakum History]], the [[God|god]] [[Talad]], forged pure magical energy into shapes called "Glyphs". They form the base of Yliakum magic.

* No spell can be casted without a glyph.

They are found in nature with no real explanation, no one knows exactly why they form but when some type of energy is strongly present in one place a glyph can form. Glyphs patterns appear on very different materials from a leaf to the fur of an animal and usually on any type of rock.

During the centuries many glyphs have been found and studied by the wizards. They discovered that each glyph can create a spell effect and that several glyphs can be combined to obtain greater effects. To simplify casting of spells, the glyphs are associated with a concept (ie. "Weight") and wizards combine those concepts to form new spells (ie. "Weight" and "Negate" to become very light).

Nowadays, glyphs can be found rendering services to the people of Yliakum or can be bought to mages like [[Levrus Dahrenn]] in the [[Magic Shop | magic shop]] for the more basic of them. The more rare and powerfull glyphs can be obtained by joining a Way Circle (school of magic) and follow its path to the Mastery of a particular Way.

* The glyphs purchased or rewarded will appear in your [[Ingame Help#Inventory Window | Inventory]] and be visible in the Glyphs Window in your [[Ingame Help#Spell Book Window | Spell Book]].

[[File:Glyphs.jpg|500px]]

===Purification===
To use a glyph, the wizard must apply a process of Purification, which take some time. The Purification establish a strong link in between the wizard and his glyph. If he dies, the glyphs will be taken to the [[Death|Death Realm]] with him. A wizard can trade a glyph, but the recipient will need to purify the glyph as well to create a new magic link and be able to use it.

* To purify a glyph, open the Glyph window from your Spell Book.
* Drag the glyph and drop it on the button called: '''Purify'''.
* When the Purification is done, you will see a message in your Chat Window > System Tab and your glyph will be surrounded of a white aura.

===Researching a Spell===
[[Image:SpellbookVen.jpg|300px|thumb|left]]
Once you have one or more glyphs, you can start to research spells. To be discovred, a spell can ask one glyph or a combinaison of up to 3 glyphs.

Shown on this pic is the glyph window of your Spell Book. The six main boxes will content the glyphs of the six ways of magic. The small row of boxes at the bottom of the window is where you put glyphs in order to combine or purify them.
* To discover a spell, drag one or several glyphs in the small row of boxes at the bottom of the window and hit the button called: '''Research'''.
* When you effectivly discovred a spell, its name and description will appear.
* Once discovred, the spell will automatically be added in your Spell Book. You wont have to research it again to cast it.

In this example, the Blue Way glyph "Cold" has been placed in the box and the wizard has discovred the spell called "Freeze".
* If you fail to discover a spell it might be for several raison : the combinaison of glyphs isn't right; you have not trained that way of magic high enough; or the glyph isn't purified.
Researching a spell is dangerous for the wizard. In effect, it ask a lot of mental focus and the strong magical energy at work may wound an unwary magician.

===Casting===
There are two great categories of spells available to the wizards: the enhancing spells that we call "buffs" and the attack spells.

The enhancing spells like "Rock Armor" (Brown Way) are made to be cast on the wizard. They enhance one health or stamina or increase one defensive ability. Some of those spells can be cast on friends, like "Life Infusion" (CW).

The attack spells like "Flame Burst" (RW) are made to defeat enemies. Some are efficient in close range, some in very long range. Those spells can be cast on players too in case of [[General FAQ#Will there be Player vs. Player combat in PlaneShift?|PvP]] (player versus player).

The process to cast a spell is as follow:
* Select your character or an enemy [[Non-Player Character|NPC]]
* Open your spell book, select the spell you wish to cast and click '''Cast Spell'''.
There is many ways to make this operation less long. The quickest one is to create a [[Ingame Help#Shortcuts Window|shortcut]] of the spell you plan to use a lot.
* Once you clicked on the chosen spell, a count down window will appear. When it is finished, the spell will be cast.

[[Image:magepower.jpeg|left|thumb|400px]] [[Image:Magered.jpg|center|thumb|350px]]

==Magic Mechanism==

===Type of Damage===

Spells and Magical effects can have different type of effects:

'''Direct Damage''' (DD): direct damage is applied as soon as the spell has been cast. Red Way offensive spells usually deal direct damage.

'''Damage over Time''' (DoT): this damage is applied over a period of time. Starting from when the spells has been successfully cast and until the spell duration runs out, the target HPs are constantly reduced. Blue Way offensive spells usually deal damage over time. This type of damage usually deal more damage than an equivalent realm spell, on the other side the duration can allow the target to try to heal itself or dispel the offensive spell.

===Damage and Saving Throws===
When a spell deals damage may allow the opponent to roll a ''saving throw'' to reduce the amount of damage sustained; this ''saving throw'' is made by the server confronting the caster and the target knowledge of the spell's magic way (e.g. Crystal Magic) plus a random factor: the higher is the target's knowledge of the way the higher is the chance to succeed the roll. When a target successfully roll the save the spell damage is usually halved.
If a spell which deals damage does not allow for a ''saving throw'' roll, that spell will usually deal about 70% less damage than an equivalent spell (same realm and same magic way).

<div style="background: #efe; padding: 4px 4px; width: 1000px">
[[Image:Fountain.png|40px]] '''Tip: The higher is your knowledge in a way the higher is your chance to counter or avoid damage and effects of the same way.'''
</div>

===Magic Resistance===
...

===Spell Power (KFactor)===
''(under construction)''
The spell caster can decide to channel more mana into casting by setting the additional spell power, allowing the caster to cast a more powerful spell.

The additional spell power factor is expressed as a percentage value, from 0% to 100%. If you set an additional spell power factor of 50% then you will channel an additional 50% of the base mana requirement for a spell into the spell.

The more you push the additional spell power, the more you must have affinity with the ways and its associated Mental Stat to control the effects. The power level of the spell is raised by the additional spell power, so the spell will be more powerful.

The use of additional spell power has the side-effect that the spell can fizzle or even produce damages to the caster, depending on how much the spell goes out of control.

To set your additional spell power, use the slider in your Status Window.

===Spellcasting Time===
...

=Enchanted items=
Glyphs can be used in combination with special Enchanters to imbue crystals (ruby, sapphire, emerald and diamond) with magical powers. These crystals held or set on items during their particular crafting stage. Once set the enchanted gem bestow its magical power on the enchanted item.
Each gem can be enchanted with only one glyph at time, therefore a single item cannot be enchanted with more than a single way.

Please note that the modifiers found in randomly looted weapons are different from the ones you may obtain by crafting with glyphs.

The process is:

1) Get a ruby, sapphire, emerald or diamond crystal

2) Get a glyph you want to use for the enchantment. The glyphs is NOT destroyed in the proces.

3) You need to have one of these two books: "Enchanting Gems of Spirit" or "Enchanting Gems of Power"

4) You need access to a special equipment: "Enchanter of Power" (used with glyphs of Crystal, Brown, Blue Ways) or "Enchanter of Spirit" (used with glyphs of Dark, Red, Azure Ways).

5) Certain glyphs can be put only in certain gems

6) You put the glyph you want to use in your right hand, and the gem into the Enchanter container. Then you "Use" the Enchanter.

7) The result is an enchanted gem, for example Meteor Glyph + Sapphire Crystal with Enchanter of Spirit creates "Flaming Major Sapphire Crystal". So the item got a Prefix and an Adjective which provide magical properties. The gem has to be identified with a spell to read its properties.

8) You have to craft a weapon where you will set the socket with the gem. For example you arrive up to the "Battle Hammer Assembly", before making the final hammer. This is true for all crafted weapons, shields, armors and jewelry, as all have the "Assembly" or "Kit" stage before the final item is created.

9) You have to craft a Gem Socket. This can be of three types, of increasing quality and complexity to make: Standard, Superior and Perfect.

10) You can put together the pieces, the gem socket and the kit to create the final enchanted item. This item will take the modifiers (magical properties) of the gem.

===Weapons & Shields===
Weapons usually '''empower''' the weapon's '''damage type''' and add a special ability. The following list associate the damage type with the related magic way:
* ''Blue Way & Red Way'': slash damage
* ''Crystal Way & Dark Way'': pierce damage
* ''Azure Way & Brown Way'': blunt damage

More powerful enchantments can also bestow the weapon the following effects:
* ''Blue Way'': deals extra frost damage (Red Way Magic Resistance protects against this extra damage)
* ''Crystal Way'': deals extra light damage and gives a Disorientation debuff (Dark Way Magic Resistance protects against this extra damage)
* ''Azure Way'': drains Mana (Brown Way Magic Resistance protects against this extra damage)
* ''Red Way'': deals extra fire damage (Blue Way Magic Resistance protects against this extra damage)
* ''Dark Way'': drains HP (Crystal Way Magic Resistance protects against this extra damage)
* ''Brown Way'': drains Strength (Azure Way Magic Resistance protects against this extra damage)

===Armors===
Enchanted Armors gives '''Magic Resistance''' against the way '''opposed''' to the enchanted glyph. More powerful glyphs can also give magic resistance against ways friendly toward the opposed way, therefore a single piece of armor can have magic resistance against up to '''three''' ways. Like weapons a magic way '''empower''' the related '''protection type'''.

===Jewelry===
Enchanted Jewels '''empower skills''' related to the magic way used to enchant, below there is the list of way related skills:

'''Azure Way'''
* Empathy
* Set Traps
* Find Traps
* Knives & Daggers
* Light Armor
'''Blue Way'''
* Pottery
* Masonry
* Fishing
* Heavy Armors
'''Brown Way'''
* Harvesting
* Leatherworking
* Tailoring
* Light Armor
'''Crystal Way'''
* Musical Instrument
* Hide in Shadows
* Drawing
* Medium Armor
'''Dark Way'''
* Pickpockets
* Repair Armors
* Backstab
* Medium Armor
'''Red Way'''
* Tool Making
* Blacksmith
* Jewelry Making
* Repair Tools
* Heavy Armor

=In Character References=
{| class="wikitable"
| style="background:#F5DEB3;" | [[image:lexicon.jpg]]
| style="background:#F5DEB3;" | In game, a couple of books refer to Magic. They can be found in the famous Hydlaa [[Library|library]] owned by the Ylian [[Jayose]] or in the magic shop of Levrus:
* ''History of Magic Vol 1: The Birth''
* ''History of Magic Vol 2: The Taming''
* ''History of Magic Vol.3: The Invasions''
* ''History of Magic Vol.4: The Heresy''
* ''History of Magic Vol.5: The Ways''
|}

* Go to [[Players_Guide#Game_Basics|Player Guide]]

[[Category:Magic]]
[[Category:Glyphs]]
[[Category:Game Guides]]
[[Category:Players Guide (Old)]]

Players Guide/Magic

2025-11-29T17:55:07Z

Talad: /* Enchanted items */

The magical energy in [[Yliakum]] is divided into six ways of arcane: [[Players Guide/Magic#Crystal Way | Crystal Way]], [[Players Guide/Magic#Azure Way | Azure Way]], [[Players Guide/Magic#Red Way | Red Way]], [[Players Guide/Magic#Dark Way | Dark Way]], [[Players Guide/Magic#Brown Way | Brown Way]] and [[Players Guide/Magic#Blue Way | Blue Way]].
[[Image:Magecasting.jpeg|thumb|300px]]

==The Ways of Magic==
[[Image:Ways.png|left|150px]]
Each Way has a particular color and a [[Ingame Help#Stats and Skills | mental stat]] associated. The three mental stats linked to magic are: [[Players Guide#Stats and Skills|Charisma]], [[Players Guide#Stats and Skills|Intelligence]] and [[Players Guide#Stats and Skills|Willpower]]. They give bonuses to the casting of spells that pertain to that way.

Each way is composed of a set of spells and each spell can be casted by a wizard thanks to the combination of a set of runes, called [[Players Guide/Magic#The Glyphs | "glyphs"]]. The spells of a particular Way are related to the same energy and the same concepts (Water, Air or Healing, Drain). They produce either a direct damage or a damage over time on the opponent.

The ways are all somewhat linked by relationship of opposition or attraction. A specific way opposes another and is "friendly" with two others (ie. Crystal Way opposes Dark Way and is friendly with Blue and Azure Way).
Therefor, each spell giving a buff for a given time will provide at least a small way resistance (ie. Casting a Red Way "Strength" spell on yourself will also protect you slightly againt Blue Way).

----

===Crystal Way (CW)===
Users of this Way, get the pure energy of the [[Azure Sun|Crystal]], more directly than all other Ways. Famous for the ability to heal, and cure the most terrible wounds, people have said that if you reach a great knowledge, you can even bring back a person from death. Nonetheless there are many powerful offensive spells, particularly effective against evil and dark creatures. While warriors and farmers with injured animals are more then happy to see these practitioners around; around most towns people feel the appearance of these practitioners is a bad omen of bad times to come.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:CrystalWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| White || Energy, Life and Light || Buff Self & Allies, Direct Damage, Direct Healing || Charisma || Opposed to: Dark Way
Friendly with: Blue & Azure Way
|}

===Dark Way (DW)===
This Way is one that conquers more myth then any of the others. Its practitioners have a history of being the most innovative of any practitioners of the Ways of Magic, but with all innovation there is both good and bad. It's well known that many disasters and epidemics were caused by the adepts of this ancient Way. Holding some spells with terrifying effects, things can become even worse if you lose the control of its power. Some spells enable the control of horrific creatures, such as undead, demons and spirits, whilst some enable the caster to control objects and people in a subtle manner at distance.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:DarkWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Black || Entropy, Death and Darkness || Fear & Debuff, Drain, Direct Damage and Damage Over Time || Charisma || Opposed to: Crystal Way
Friendly with: Brown & Red Way
|}

===Azure Way (AW)===
Basically a sneaky and insidious energy, the Azure Way can control the will, the perceptions and the intentions of any intelligent being. It's power comes from the deep knowledge of the mind and the way to influence it, but it relies also on the mind's potential to influence the surrounding areas and objects, particularly all that is related to the air element.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:AzureWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Light Blue || Mind, Illusion and Air element ||Charm & Buff NPCs, Paralyzation, Minor Direct Damage and Damage Over Time || Will || Opposed to: Brown Way
Friendly with: Crystal & Red Way
|}

===Red Way (RW)===
The spellcaster is able to invoke the power of Chaos, and to bend to his/her/kra's will the devastating fury of fire, summoning it for its both damaging and purifying qualities. Spells of the Red Way can also instil courage and strength into companions or other creatures. Most spells in this Way are fire related, and the majority of metal workers have knowledge of it.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:RedWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Red || Strength, Chaos & Fire element||Major Direct Damage, Combat Buffs|| Will || Opposed to: Blue Way
Friendly with: Azure & Dark Way
|}

===Blue Way (BlW)===
Many diseases and poisons would be incurable without the help of the spells of this Way. The offensive and defensive potential of this art reside mainly on the control of the water element, but also of cold and ice that are strictly related to it. Equally inestimable are the divination spells that can provide very useful information on the past, present and future.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BlueWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Blue || Divination, Purification and Water element ||Immobilize, Major Damage Over Time, Healing Over Time, Polymorph|| Intelligence ||Opposed to: Red Way
Friendly with: Brown & Crystal Way
|}

===Brown Way (BrW)===
The glyphs of this Way give to the wizard the ability to cast different protective spells, to summon natural creatures and some monsters and to influence their will. This Way is really close to the element of Earth and can control all that's related to it. Users can call nature spirits for assistance or mark themselves and allies as friends of nature.
{| width=100% {{Prettytable}}
!rowspan="2" width="40" | [[Image:BrownWay.png|32px]]
!width="60"|Glyph Colour
!width="60"|Focus
!width="60"|Gameplay
!width="60"|Mental Stat
!width="90"|Relationships
|-
| Brown || Nature, Protective magic and Earth element ||Defensive Buff, Summon Monster, Direct Damage, Immobilization, Minor Polymorph|| Intelligence ||Opposed to: Azure Way
Friendly with: Blue & Dark Way
|}

==Casting a Spell==
===The Glyphs===
At the beginning of [[Players Guide/Yliakum History | Yliakum History]], the [[God|god]] [[Talad]], forged pure magical energy into shapes called "Glyphs". They form the base of Yliakum magic.

* No spell can be casted without a glyph.

They are found in nature with no real explanation, no one knows exactly why they form but when some type of energy is strongly present in one place a glyph can form. Glyphs patterns appear on very different materials from a leaf to the fur of an animal and usually on any type of rock.

During the centuries many glyphs have been found and studied by the wizards. They discovered that each glyph can create a spell effect and that several glyphs can be combined to obtain greater effects. To simplify casting of spells, the glyphs are associated with a concept (ie. "Weight") and wizards combine those concepts to form new spells (ie. "Weight" and "Negate" to become very light).

Nowadays, glyphs can be found rendering services to the people of Yliakum or can be bought to mages like [[Levrus Dahrenn]] in the [[Magic Shop | magic shop]] for the more basic of them. The more rare and powerfull glyphs can be obtained by joining a Way Circle (school of magic) and follow its path to the Mastery of a particular Way.

* The glyphs purchased or rewarded will appear in your [[Ingame Help#Inventory Window | Inventory]] and be visible in the Glyphs Window in your [[Ingame Help#Spell Book Window | Spell Book]].

[[File:Glyphs.jpg|500px]]

===Purification===
To use a glyph, the wizard must apply a process of Purification, which take some time. The Purification establish a strong link in between the wizard and his glyph. If he dies, the glyphs will be taken to the [[Death|Death Realm]] with him. A wizard can trade a glyph, but the recipient will need to purify the glyph as well to create a new magic link and be able to use it.

* To purify a glyph, open the Glyph window from your Spell Book.
* Drag the glyph and drop it on the button called: '''Purify'''.
* When the Purification is done, you will see a message in your Chat Window > System Tab and your glyph will be surrounded of a white aura.

===Researching a Spell===
[[Image:SpellbookVen.jpg|300px|thumb|left]]
Once you have one or more glyphs, you can start to research spells. To be discovred, a spell can ask one glyph or a combinaison of up to 3 glyphs.

Shown on this pic is the glyph window of your Spell Book. The six main boxes will content the glyphs of the six ways of magic. The small row of boxes at the bottom of the window is where you put glyphs in order to combine or purify them.
* To discover a spell, drag one or several glyphs in the small row of boxes at the bottom of the window and hit the button called: '''Research'''.
* When you effectivly discovred a spell, its name and description will appear.
* Once discovred, the spell will automatically be added in your Spell Book. You wont have to research it again to cast it.

In this example, the Blue Way glyph "Cold" has been placed in the box and the wizard has discovred the spell called "Freeze".
* If you fail to discover a spell it might be for several raison : the combinaison of glyphs isn't right; you have not trained that way of magic high enough; or the glyph isn't purified.
Researching a spell is dangerous for the wizard. In effect, it ask a lot of mental focus and the strong magical energy at work may wound an unwary magician.

===Casting===
There are two great categories of spells available to the wizards: the enhancing spells that we call "buffs" and the attack spells.

The enhancing spells like "Rock Armor" (Brown Way) are made to be cast on the wizard. They enhance one health or stamina or increase one defensive ability. Some of those spells can be cast on friends, like "Life Infusion" (CW).

The attack spells like "Flame Burst" (RW) are made to defeat enemies. Some are efficient in close range, some in very long range. Those spells can be cast on players too in case of [[General FAQ#Will there be Player vs. Player combat in PlaneShift?|PvP]] (player versus player).

The process to cast a spell is as follow:
* Select your character or an enemy [[Non-Player Character|NPC]]
* Open your spell book, select the spell you wish to cast and click '''Cast Spell'''.
There is many ways to make this operation less long. The quickest one is to create a [[Ingame Help#Shortcuts Window|shortcut]] of the spell you plan to use a lot.
* Once you clicked on the chosen spell, a count down window will appear. When it is finished, the spell will be cast.

[[Image:magepower.jpeg|left|thumb|400px]] [[Image:Magered.jpg|center|thumb|350px]]

==Magic Mechanism==

===Type of Damage===

Spells and Magical effects can have different type of effects:

'''Direct Damage''' (DD): direct damage is applied as soon as the spell has been cast. Red Way offensive spells usually deal direct damage.

'''Damage over Time''' (DoT): this damage is applied over a period of time. Starting from when the spells has been successfully cast and until the spell duration runs out, the target HPs are constantly reduced. Blue Way offensive spells usually deal damage over time. This type of damage usually deal more damage than an equivalent realm spell, on the other side the duration can allow the target to try to heal itself or dispel the offensive spell.

===Damage and Saving Throws===
When a spell deals damage may allow the opponent to roll a ''saving throw'' to reduce the amount of damage sustained; this ''saving throw'' is made by the server confronting the caster and the target knowledge of the spell's magic way (e.g. Crystal Magic) plus a random factor: the higher is the target's knowledge of the way the higher is the chance to succeed the roll. When a target successfully roll the save the spell damage is usually halved.
If a spell which deals damage does not allow for a ''saving throw'' roll, that spell will usually deal about 70% less damage than an equivalent spell (same realm and same magic way).

<div style="background: #efe; padding: 4px 4px; width: 1000px">
[[Image:Fountain.png|40px]] '''Tip: The higher is your knowledge in a way the higher is your chance to counter or avoid damage and effects of the same way.'''
</div>

===Magic Resistance===
...

===Spell Power (KFactor)===
''(under construction)''
The spell caster can decide to channel more mana into casting by setting the additional spell power, allowing the caster to cast a more powerful spell.

The additional spell power factor is expressed as a percentage value, from 0% to 100%. If you set an additional spell power factor of 50% then you will channel an additional 50% of the base mana requirement for a spell into the spell.

The more you push the additional spell power, the more you must have affinity with the ways and its associated Mental Stat to control the effects. The power level of the spell is raised by the additional spell power, so the spell will be more powerful.

The use of additional spell power has the side-effect that the spell can fizzle or even produce damages to the caster, depending on how much the spell goes out of control.

To set your additional spell power, use the slider in your Status Window.

===Spellcasting Time===
...

=Enchanted items=
Glyphs can be used in combination with special Enchanters to imbue crystals (ruby, sapphire, emerald and diamond) with magical powers. These crystals held or set on items during their particular crafting stage. Once set the enchanted gem bestow its magical power on the enchanted item.
Each gem can be enchanted with only one glyph at time, therefore a single item cannot be enchanted with more than a single way.

The process is:

1) Get a ruby, sapphire, emerald or diamond crystal

2) Get a glyph you want to use for the enchantment. The glyphs is NOT destroyed in the proces.

3) You need to have one of these two books: "Enchanting Gems of Spirit" or "Enchanting Gems of Power"

4) You need access to a special equipment: "Enchanter of Power" (used with glyphs of Crystal, Brown, Blue Ways) or "Enchanter of Spirit" (used with glyphs of Dark, Red, Azure Ways).

5) Certain glyphs can be put only in certain gems

6) You put the glyph you want to use in your right hand, and the gem into the Enchanter container. Then you "Use" the Enchanter.

7) The result is an enchanted gem, for example Meteor Glyph + Sapphire Crystal with Enchanter of Spirit creates "Flaming Major Sapphire Crystal". So the item got a Prefix and an Adjective which provide magical properties. The gem has to be identified with a spell to read its properties.

8) You have to craft a weapon where you will set the socket with the gem. For example you arrive up to the "Battle Hammer Assembly", before making the final hammer. This is true for all crafted weapons, shields, armors and jewelry, as all have the "Assembly" or "Kit" stage before the final item is created.

9) You have to craft a Gem Socket. This can be of three types, of increasing quality and complexity to make: Standard, Superior and Perfect.

10) You can put together the pieces, the gem socket and the kit to create the final enchanted item. This item will take the modifiers (magical properties) of the gem.

===Weapons & Shields===
Weapons usually '''empower''' the weapon's '''damage type''' and add a special ability. The following list associate the damage type with the related magic way:
* ''Blue Way & Red Way'': slash damage
* ''Crystal Way & Dark Way'': pierce damage
* ''Azure Way & Brown Way'': blunt damage

More powerful enchantments can also bestow the weapon the following effects:
* ''Blue Way'': deals extra frost damage (Red Way Magic Resistance protects against this extra damage)
* ''Crystal Way'': deals extra light damage and gives a Disorientation debuff (Dark Way Magic Resistance protects against this extra damage)
* ''Azure Way'': drains Mana (Brown Way Magic Resistance protects against this extra damage)
* ''Red Way'': deals extra fire damage (Blue Way Magic Resistance protects against this extra damage)
* ''Dark Way'': drains HP (Crystal Way Magic Resistance protects against this extra damage)
* ''Brown Way'': drains Strength (Azure Way Magic Resistance protects against this extra damage)

===Armors===
Enchanted Armors gives '''Magic Resistance''' against the way '''opposed''' to the enchanted glyph. More powerful glyphs can also give magic resistance against ways friendly toward the opposed way, therefore a single piece of armor can have magic resistance against up to '''three''' ways. Like weapons a magic way '''empower''' the related '''protection type'''.

===Jewelry===
Enchanted Jewels '''empower skills''' related to the magic way used to enchant, below there is the list of way related skills:

'''Azure Way'''
* Empathy
* Set Traps
* Find Traps
* Knives & Daggers
* Light Armor
'''Blue Way'''
* Pottery
* Masonry
* Fishing
* Heavy Armors
'''Brown Way'''
* Harvesting
* Leatherworking
* Tailoring
* Light Armor
'''Crystal Way'''
* Musical Instrument
* Hide in Shadows
* Drawing
* Medium Armor
'''Dark Way'''
* Pickpockets
* Repair Armors
* Backstab
* Medium Armor
'''Red Way'''
* Tool Making
* Blacksmith
* Jewelry Making
* Repair Tools
* Heavy Armor

=In Character References=
{| class="wikitable"
| style="background:#F5DEB3;" | [[image:lexicon.jpg]]
| style="background:#F5DEB3;" | In game, a couple of books refer to Magic. They can be found in the famous Hydlaa [[Library|library]] owned by the Ylian [[Jayose]] or in the magic shop of Levrus:
* ''History of Magic Vol 1: The Birth''
* ''History of Magic Vol 2: The Taming''
* ''History of Magic Vol.3: The Invasions''
* ''History of Magic Vol.4: The Heresy''
* ''History of Magic Vol.5: The Ways''
|}

* Go to [[Players_Guide#Game_Basics|Player Guide]]

[[Category:Magic]]
[[Category:Glyphs]]
[[Category:Game Guides]]
[[Category:Players Guide (Old)]]

Maps editing workflow

2025-11-24T21:47:58Z

Talad:

== How Landscape is setup ==
In the outliner we have a Landscape Object. If you click on it, you see the details it's linked to a MI_Landscape.

MI_Landscape contains all the parameters including the visibility of rocks , grass, etc...

The actual meshes are part of "Landscape Grass Type" a special object that can contain a mesh, its density, culling distance, etc...

M_Landscape has a special node called : "Landscape Grass" of type "Landscape Grass Output". It the detail panel of this node, there are all the "Landscape Grass Type" linked with a name (which is the name of the layer).

=== Landscape limits ===
Vertically our landscape can go from -250 meters up to +250 meters, if you try to go beyond these values you just get flat terrain at the max height and you cant go beyond.

Our maps at the moment have the lowest point to the south of Homestead where it reach -177 meters. Plus we need to consider the Death Ream boundaries, that reach at the moment -199 meters.

We have set the Kill Z value to -185 meters.

=== Notes ===

* BuiltData files are storing:
** lightmap textures (created by Build Lighting only)
** volumetric light probes / samples (created by Build Lighting only)
* umap files are storing:
** navigation paths (created by Build Paths)

=== Map creation flow ===
You should never upload BuiltData file in SVN. Those will be regenerated when we create the shipping release.

If you want to test locally the full game including lights then you need to:

* Load all the levels and Build Lighting only, this gives the best result on map borders, but I think you can avoid it

OR

* Load Persistent Level + one or more maps you want relit, and Build Lighting only. In this case the single maps will be ok, but the borders between maps will not

If you want to test locally the full game including NPC movement then you need to:

* Follow Option 1 in [[PSUnreal Navigation Meshes|this page]].

Skybox and Lights setup

2025-11-20T22:17:22Z

Talad:

== Elements contributing to day / night cycle ==

* DirectionalLight, actor in the Persistent Level (Yliakum). Casting light globally in a certain direction.
** Intensity
** Light Color
* SkyLight, actor in the Persistent Level. Stores the color of the skybox and influence all items in the game with indirect light based on the skybox color.
** Intensity
* bp_sky, actor in the Persistent Level, which contains all the logic for rain/snow/fog/... , clouds, time of the day, the actual skybox which is a static mesh (dome).
** Light, scalar parameter on the Material applied to the skybox mesh
* ExponentialHeightFog, actor in the Persistent Level, managing the fog. Careful to change its color at night, or the skydome will stay lit.
** Light color
*"PostProcessVolumeWholeGame", this is applied to the whole game, any level. It has Min Brightness=0.5 and Max Brightness=4. If you want your level in game to look like in the editor you need to be sure in game you have the same min/max settings
*Exposure, made of Min Brightness=0.5 and Max Brightness=4. Min Brightness changes based on the time of the day. Max Brightness is fixed = 4.

== 5.1.1 Build All Bug ==
In Unreal engine 5.x if you click on "Build All Levels" it will actually break the relight. The same if you click on "Build Geometry" as all the BP containing lights will disappear from the editor until you relaunch it. This causes the lights in BP not to be recalculated.

The solution is to click on "Built Lighting Only".

== Static vs Dynamic lights ==

I tried with many different settings and Lightmass is crashing on our hydlaa level very often. Trying to create a minimal set of objects exposing the crash seems not possible, as when you delete some objects may stop crashing, but then deleting more seems to stop crashing, so looks like the combination of meshes, not one particular mesh.

The crash happen with SkyLight and DirectionalLight set as Stationary and also with SkyLight as Stationary and DirectionalLight set as Moveable.

The crash does NOT happen with '''SkyLight as Moveable''' and DirectionalLight set as Stationary. So we tried this setting, the problem is the size of the generated BuiltData files.

{| class="wikitable"
|-
! Map !! Skylight Moveable, Directional Static !! Both Moveable
|-
| Hydlaa plaza || 530Mb || 139Mb
|-
| Gugrontid || 372Mb|| 13Mb
|-
| Ojaveda|| 92.5Mb || 53Mb
|-
| Amdeneir|| 744Mb|| 38Mb
|}
Given the sizes above, at the end we decided to keep both '''SkyLight and DirectionalLight set as Moveable'''.

== up to 0.7.7 release values ==

At noon:
* Fog Inscattering Color: (R=0.313989,G=0.467784,B=0.887923,A=1.000000)
* Skybox Light: 2.0
* Skylight Intensity: 1.5
* Skylight Color: (R=0.853051,G=0.958179,B=1.000000,A=1.000000)
* DirectionalLight Intensity: 4.965001

At night:
* Fog Inscattering Color: (R=0.023549,G=0.035084,B=0.066594,A=0.075000)
* Skybox Light: 0.15
* Skylight Intensity: 0.1125
* Skylight Color: (R=0.988979,G=0.996863,B=1.000000,A=1.000000)
* DirectionalLight Intensity: 0.3

== values from 0.7.8 release ==

At noon:
* Skybox Light: 1.0
* Skylight Intensity: 1
* DirectionalLight Intensity: 2

At night:
* Fog Inscattering Color: 0
* Skybox Light: 0.04
* Skylight Intensity: 0.07
* DirectionalLight Intensity: 0.07

== Rebuild lights - size and timings ==
Foliage set as static lighting
{| class="wikitable"
|+
!Level
!Skylight Moveable
!BuiltData size
!Skylight Stationary
!BuiltData size
!Date
|-
|Hydlaa_X08_Y04
|10 minutes
|132Mb
|39 minutes
|1493 Mb
|19 April 2022
|-
|Ojaveda_X11_Y04
|4 minutes
|43Mb
|6 minutes
|84Mb
|19 April 2022
|-
|
|
|
|
|
|
|}
After changing foliage to moveable
{| class="wikitable"
!Level
!Skylight Moveable
!BuiltData size
!Skylight Stationary
!BuiltData size
!Date
|-
|Hydlaa_X08_Y04
|?
|?
|7 minutes
|201 Mb
|24 April 2022
|}

== Changes 0.7.19 release ==

Lights update based on Rycer feedback.

[X] Change on the Persistent Level: World Settings -> Volume Lighting Method -> Volumetric Lighmap

[X] Keep the Directional Light as Moveable. Change the skylight to stationary (was moveable). Persistent Level -> skylight

[X] Disable Distance field, since they would be no longer needed with static lighting. Project Settings -> Engine -> Rendering -> Generate Mesh Distance Fields

[X] Keep the landscape lightmap resolution to 1

[X] Trees, go to Foliage mode, and then click on all meshes part of foliage and set Mobility as "moveable"

[X] Persistent Level (Yliakum Map file) -> WorldSettings -> Lightmass -> Volumetric Lightmap Details -> 400 (was 200)

[X] Added an Unbound Post Process Volume (PostProcessVolumeWholeGame) with Lens->Exposure->min/max Brightness, min=0.5, max=4 . Set with Infinite extent = true

[X] World Settings -> Lightmass -> Num Sky Lighting Bounces to 5 (it was 1)

[X] No Change. Change the static lighting lod to 1 or 2 on landscape only if lightmass crashes

[X] No change. Grass is already dynamic because its placed by the engine

[X] No change. Seems our lightmap resolution is between 32 and 64, overriden by the engine or some of us.

[NO, it was causing too large lightmaps on hydlaa_level] Trees, go to Foliage mode, and then click on all meshes part of foliage and set Mobility as "static" and change Lighting mode to "Force Volumetric", Keep it as lightmap resolution of 8.

Additional Notes:

5) Because of a low lightmap resolution, make the point lights (torches and similar) a combination of a static and dynamic light. One low brightness, high radius static point light (for bounced lighting) and a second light - bright, dynamic with a short radius

6) Careful use of reflection capture. Ideally one per building, some will require more. It would be useful to change their resolution to 64 or even 32 to save memory.

7) Split some underground areas to new streamed sublevels for less streaming hitches, performance optimization and faster loading.

== Changes 0.7.20 release ==
[X] Change on the Persistent Level: World Settings -> Volume Lighting Method -> Sparse Volume Lighting Samples

== Changes 0.7.40 release ==
Since long time I was getting this error during relight: "InstancedFoliageActor_0 Large actor receives a pre-shadow and will cause an extreme performance hit unless bCastDynamicShadow is set to false."

I changed Crystal_Light29 from Stationary to Static, and the error went away. We should not have stationary lights impacting landscape.

== 0.7.52 test for full dynamic lights ==
1) I deleted all the *Builtdata* files (or I was gettting an error on save)

2) Turn on "World Settings"->"Force No Precomputed Lighting"

3) Build -> "Build LIghting only" (this will basically remove all the lightmaps in case you have any)

4) Resave all.