ya-tagscript 1.5.0

Yet Another TagScript fork. An easy drop in user-provided Templating system.

ya_tagscript - Yet Another TagScript fork

Current stable version: v1.5.0

Information

This is a fork of PhenoM4n4n's TagScript, which itself is a fork of JonSnowbd's TagScript, a string templating language.

The main purpose of this fork is to align the Discord-specific blocks with the most recent Discord and discord.py changes (new username system, etc.).

What?

TagScript is a drop-in, easy-to-use string interpreter that lets you provide users with ways of customizing their profiles or chat rooms with interactive text.

For example TagScript comes out of the box with a random block that would let users provide a template that produces a new result each time its ran, or assign math and variables for later use.

Changes in v1

The newly released v1 includes a complete rewrite of the entire parsing and interpretation performed by the TagScriptInterpreter class. This comes with some subtle behavioural changes but great care was taken to keep v1 behaviourally similar to v0 and PhenoM4n4n's fork. Most simple uses should behave the same but especially deeply nested scripts or dynamically assembled ones will most likely require adjustments. Some documentation examples were also outright wrong, so those were also adjusted to reflect the actual behaviour of the pre-existing interpreter.

Oh, no! Behaviour changes?!

To remove the need for dynamically assembled blocks (e.g. command blocks that only happen under some circumstances), v1 only performs interpretation of branches that were actually hit (to the best of its ability).

Take this (very bad) password check script:

{if({args}==123):{command:echo password accepted!}|something else}

If {args} is not in fact equal to 123, the interpreter WILL NOT interpret the command block AT ALL. It jumps straight to the else section after the | and only interprets that. This means that for any incorrect values of {args}, the echo command is NOT included in the list of commands in response.actions.get("commands").

Other blocks with some conditional executions (like all or any) do the same.

Installation

Download the latest version through pip:

pip install ya_tagscript

or

pip install git+https://github.com/MajorTanya/ya_tagscript.git@v1.5.0

Download from a commit:

pip install git+https://github.com/MajorTanya/ya_tagscript.git@<COMMIT_HASH>

Install for editing/development:

git clone https://github.com/MajorTanya/ya_tagscript.git
pip install -e ./ya_tagscript

Dependencies

• Python>=3.11
  • before v1.4.0, this was effectively >=3.12 due to an oversight in testing
  • after v1.4.0, Python 3.11 is actually supported
• discord.py>=2.5.0
• pyparsing>=3.2.0
• python-dateutil>=2.9.0