Tera-Guide

Is a module for creating dungeon guides extremely easily by simple "scripting".

Dependencies

https://github.com/Kaseaa/library (it also has a readme)

The say node library used for text-to-speech(works without it, so not needed). Install it by running "npm install say" in your proxy folder.

Commands

Note: All commands starts with "guide"

Command	Usage	Arguments
-	Toggles the guide module	-
debug	Toggles debug mode	debug(enables everything), hp, abnormal, skill, boss, chat(prints to in chat rather than console), dm, qb
event	triggeres an event, where you are the entity. Used for testing	First argument is a type from "Options". The second argument contains the values(or the keyword trigger). Example: /8 guide event spawn '{"id": 500, "sub_delay": 5000}', /8 guide event trigger "h-444-2000-97"
stream	Toggles streamer mode	-

Supported

Feel free to create your own guide/add-on and send a pull-request :=)

Dungeon	How much is it scripted
AANM	All bosses
AAHM	All bosses
HH P4	Firewalls
RMHM	Debuff mechanic on first boss

How to create a guide

First enable debug setting in config.json, then go into the dungeon you wish to create a guide for. Once you've entered look in console for the id. Once you have the id create a file under the guides folder. The file should start with the number followed by ".js".

It's important to note you will need to include the very basic information for the file to get loaded and for the module to print out information. It won't print out anything if it can't find number.js file. (module.exports = {};)

When the module get's loaded, you're allowed to hook hooks using a "load" key. This key will get called with a dispatch argument passed upon getting loaded. The hooks will be automatically unloaded once the module finishes it's runtime.

So, now to create actions have debug option on and log the attacks/abnormalities then script what you want to happen during those attacks. Please refer below to options(things you can trigger upon the abnormality or attack).

Naming keys

Prefix a means handle a abnormality. However in addition to this there are subtypes to abnormalities.

Sub type	Effect
m	The abnormality was applied by a mob to you. (m = mob)
e	The abnormality was applied by "nothing"/server to you. (e = empty)
b	The abnormality was applied to the bam. (b = bam)

Prefix s means handle a skill.

Prefix h means health. For instance "h-huntingZoneId-templateId-60", means it'll trigger on 60%

Prefix dm means dungeon message.

Prefix qb means quest balloon.

When creating an entry use a prefix, followed by "-huntingZoneId-templateId-" after the last "-" put the abnormality id, skill id or hp %.

Options

Key	Required	Values	Usage
type	Yes	spawn, text, sound, stop_timer, func	Determines what action(s) will be taken when the event is called
sub_type	Yes(text), Maybe(spawn), No	notification(text), message(text), speech(text), collection(spawn(default)), item(spawn), build_object(spawn)	Used in conjunction with certain types.
id	Yes(spawn, sound, stop_timer), No	A unique identifier not used "anywhere" else in the file.	It's used for spawning item(the item id), stopping a notification/text in progress and id of a sound. DO NOT USE 0 FOR THE ID IN ANY CASE!
delay	No	A delay in milliseconds	Creates a timer that can be used to delay ANY event.
sub_delay	Yes(spawn), No	How long in milliseconds before it acts upon it.	Used with spawning items
distance	Maybe(spawn), No	Distance in units(1meter = 25 units)	Used when spawning something. (How far away it'll be spawned from the boss)
offset	Maybe(spawn), No	[-PI, PI]	Used when spawning something. (How it will be spawned in relation to the boss) use this or pos
pos	Maybe(spawn), No	{x, y, z}	Used when spawning something. (The location on the map) use this or offset
message	Yes(text), No	The text you wish to display when it gets triggered	Use with type text
func	Yes(func), No	A function which should get called when an entry is called.	The callback will get passed the function handlers(spawn, text, sound, stop_timer, func) in a object, the event it was called from, what entity information that triggered the event and the dispatch
class_position	No	tank, dps, heal	if this is used, it will only do the event for that class position

Todo(in the extremely distance future of probably never)

Add interface for other modules to require/import the script and use it

Allow other modules to bind names to mob indexes. Such as 920-4000 -> Vergos_Phase4 Allowing config files to say "h-Vergos_Phase4-97" for 97% hp