Skip to content

Basic features

Jump to bottom
Dmitry Shin edited this page Nov 18, 2020 · 12 revisions

Functional module for creating your own guides for dungeons, bosses and mechanics. With this set of features, you can create your guide in any translation, for this you just need to write a simple script and require the tera-guide-core module into your index.js.

The guides based on this module can be found here: https://github.com/hsdn/tera-guide

Features

  • Complete tools for custom guides creation for your favorite dungeons.
  • Support for the features to add your languages translations.
  • Built-in GUI support for all guide settings.
  • Support for voice notifications (Windows TTS module is used).
  • Flexible and powerful functionality for scripting guides.
  • Automatically generated dungeon list based on game client files.
  • Used modern JavaScript for improved performance.
  • To handle all events and hooks used nodejs EventEmitter.

Built-in commands

The default command is guide, but you can change this in your index.js file.

Toolbox(/8) Command description
guide Module on/off
guide g[ui] Show module GUI.
guide voice
(default: on)		 Text-to-speech (TTS) notices on/off, speech rate is set by command guide 1~10.
guide lNotice
(default: off)		 Send notices to chat channel "Notice" instead of on-screen messages on/off.
guide gNotice
(default: off)		 Send notices to party chat channel on/off.
guide male~female
(default: female)		 Set TTS speech voice gender (if available).
guide 1~10
(default: 2)		 Set TTS speech rate.
guide spawnObject
(default: on)		 Spawn marker objects on/off.
guide stream
(default: off)		 Streamer Mode on/off (hide all notices and objects, TTS will played).
guide dungeons List of all supported dungeons and its ids.
guide verbose id
(default: on for all)		 Send notices for specified by id dungeon on/off.
guide spawnObject id
(default: on for all)		 Spawn marker objects for specified by id dungeon on/off.
guide help List of supported commands.

Notices settings

  • On screen (on bottom side) and chat notices, if lNotice parameter is on.

  • When gNotice parameter is on, notices will also be sent to party chat channel.

  • The message on top side of the screen, if lNotice parameter is off (by default).

    You can set the color for this type of notices using the commands or GUI (also change color in the Toolbox chat).

  • When Streamer Mode is on (stream parameter), all text notices ONLY sent to Toolbox(/8) chat channel, but TTS notices will be played.

  • To disable or enable TTS notifications, use the guide voice command.

Module GUI

  • When you enter the guide gui command, the module GUI is displayed, allowing you to change basic settings.

Configuration file format

{
    "version": 1.14,
    "data": {
        "enabled": true,
        "lNotice": false,
        "gNotice": false,
        "stream": false,
        "spawnObject": true,
        "speech": {
            "enabled": true,
            "rate": 2,
            "volume": 100,
            "gender": "female"
        },
        "cc": [
            "</font><font color=\"#ffff00\">"
        ],
        "language": "auto",
        "debug": {
            "chat": true,
            "all": false,
            "s": false,
            "am": false,
            "ae": false,
            "ab": false,
            "ar": false,
            "ad": false,
            "h": false,
            "ns": false,
            "nd": false,
            "rb": false,
            "re": false,
            "dm": false,
            "qb": false
        },
        "dungeons": {
            "3020": {
                "name": "Sea of Honor",
                "verbose": true,
                "spawnObject": true
            }
        }
    }
}
Clone this wiki locally