FTB Echoes

Use https://github.com/FTBTeam/FTB-Mods-Issues for any mod issues

Echo Datapack Format

Each Echo is loaded a datapack json file, located in data/<modid>/echo_definitions/<echo_id>. E.g. the Echo ftbechoes:test1 should be defined in data/ftbechoes/echo_definitions/test1.json.

Top Level

Note that whenever "a serialized component" is mentioned below, this is the raw json for a Minecraft text component, as documented here.

See example echo definitions here. These test definitions are loaded by the mod only when in a development environment.

An Echo json has the following top-level fields, all required:

• id - must be unique to the Echo; match the path & filename
• title - displayed in the Echo GUI, a serialized component
• stages - an ordered list of Echo stages for this echo, see below
• all_complete - a message displayed at the end of the Echo GUI lore panel when the team has completed all stages. Optional, defaults to "All Stages Complete!"

Echo Stages

Echo stages define the progression for an Echo. Fields:

• title - optional, a serialized component displayed in the Lore page as the first text line of a stage if present
• lore - a list of lore entry components, see Lore Entry Components below
• not_ready - serialized component, text displayed after the lore or in the task panel if the player isn't ready to complete the stage
• ready - serialized component, text displayed after the lore or in the task panel if the player is ready to complete the stage
• completed - serialized component, text displayed in the lore and task panels if the player has completed the stage. Optional; defaults to "Stage Completed!"
• required_stage - a string; the game stage the player must have to complete this echo stage
• shop_unlock - optional, defaults to an empty list; a list of shop entries to unlock once the stage is completed; see Shop Entries below
• completion_reward - optional one-time reward(s) granted to players when they complete the stage; see Completion Rewards below

Note that if none of the stages of an echo define any shop entries via shop_unlock, the "Shop" tab in the GUI is simply not displayed.

Lore Entry Components

Defines the text, image and/or audio clips that make up the lore for one stage.

• type - required, must be one of ftbechoes:text, ftbechoes:image, or ftbechoes:audio

For ftbechoes:text:

• text - a serialized component

For ftbechoes:image:

• location - the resource location for an image, via the resource manager
• width - optional image width, in pixels. Defaults to 32.
• height - optional image height, in pixels. Defaults to 32.
• align - optional image alignment (left, center or right). Defaults to left.

For ftbechoes:audio:

• location - the resource location for an audio clip, which is a registered Minecraft sound event name

Shop Entries

Shop entries define items that may be bought, and/or commands that may be run (with a configurable permission level) on behalf of the player, along with an associated cost in the currency system currently in use. The player must have completed the associated echo stage to be able to buy these items.

Fields:

• name - a string to identify this entry, must be unique within this particular Echo
• item - a serialized itemstack, or list of itemstacks, possibly including component data. If omitted, then description and command must be specified.
  • This is exclusive with the command field.
• cost - an integer cost, must be > 0
• description - an optional serialized component or list of components
  • Extra (player-friendly) descriptive text about this shop entry can be added here
• icon - the resource location for an icon image; may be omitted if item is specified
• command - a json object describing a command to run on behalf of the player; see Command Entries below
  • This is exclusive with the item field.
• max_claims - an optional integer; if present, this limits the number of times this entry can be purchased, on a per-team basis
• max_stage - an optional stage number which limits the maximum stage that a player can reach and still see this entry
  • This can be used to hide earlier entries when the player has progressed beyond a certain stage, perhaps to replace that entry with a better or cheaper version
  • The value is a numeric index into the stages list of an echo definition, indexed from 0

Completion Rewards

Completion rewards define a set of rewards granted to a player when they complete a stage. This includes one or more of an item (or items), some experience, some currency, or a command to be run on behalf of the player or player's team (e.g. grant them a game stage)

All fields below are optional, but at least one of item, experience, currency or command must be specified.

Fields:

• item - a serialized itemstack, or list of itemstacks, to give to the player
• experience - an integer quantity of experience for the player
• currency - an integer quantity of currency for the player
• command - a json object describing a command to run on behalf of the player; see Command Entries below
• description - an optional serialized component, or list of serialized components, used for tooltip purposes on the "Claim Reward" button
  • The first line of the description, if it exists, is also shown in the toast popup when a player claims the reward
• autoclaim - an optional boolean, true by default; if true, then the completion reward is claimed as soon as the player completes the stage
  • Also checked for when players log in, to handle the case of party teams and offline players

Command Entries

Command entries define a string command, with an optional permission level and silent field (to suppress normal command output)

Fields:

• run - the command string, mandatory
• permission - the optional integer permission level in range 0..4, default: 0
• silent - an optional boolean to suppress normal command output, default: true
• description - an optional serialized component, or list of serialized components
  • A (player-friendly) description for what the command does; added to GUI tooltips where relevant
  • This is specifically to describe the command; see also the description field in the ShopEntry section, which is more general lore for the shop entry

Commands

There are a few commands intended for admin/debugging purposes.

Note: <stage_idx> is a numeric index into the stages list of an echo definition, and it's indexed from 0.

• /ftbechoes progress player <player> <echo_id> set_stage <stage_idx>
  • Use to force the current stage for the given player's team and echo
  • E.g. /ftbechoes player @s ftbechoes:test_echo1 set_stage 1
• /ftbechoes progress team <team-id> <echo_id> set_stage <stage_idx>
  • Equivalent to above, but using team ID directly instead of a player
• /ftbechoes progress player <player> <echo_id> reset_reward <stage_idx>
  • Resets the completion reward history for a player, echo & stage, allowing the player to claim the reward for that stage again
  • E.g. /ftbechoes player @s ftbechoes:test_echo1 reset_reward 1
  • Will give an error message if the player isn't currently recorded as having claimed the reward for the echo & stage
• /ftbechoes progress player <player> <echo_id> reset_reward
  • As above but resets all rewards for the player and echo
• /ftbechoes gamestage <add|remove> stagename
  • Gives or removes a game stage to a player. This is just a vanilla entity tag, but unlike the /tag command, this also syncs the stage to the player's client
  • Compatible with KubeJS stages, which also use vanilla entity tags, but useful if your instance doesn't have KubeJS installed

Support

• For Modpack issues, please go here: https://go.ftb.team/support-modpack
• For Mod issues, please go here: https://go.ftb.team/support-mod-issues
• Just got a question? Check out our Discord: https://go.ftb.team/discord

Licence

All Rights Reserved to Feed The Beast Ltd. Source code is visible source, please see our LICENSE.md for more information. Any Pull Requests made to this mod must have the CLA (Contributor Licence Agreement) signed and agreed to before the request will be considered.

Keep up to date