Files
st-randomness-helpers/README.md

32 lines
1.1 KiB
Markdown

# st-randomness-helpers
st-randomness-helpers is a extension for [SillyTavern](https://sillytavern.app/).
# Features
## WordLists
WordList are plaintext files containing one or more words per line. The name of the file is the name of the WordList.
## Macros
Register [macros](https://docs.sillytavern.app/usage/core-concepts/macros/) that are usually replaced with a value at save time.
## Placeholders
Placeholders are strings that are replaced with a value at generation time.
## Services
### RandomWord
Get a random word from a WordList. can be used as a Macro or a Placeholder. Macro format: `{{RandomWord::WordListName}}`. Placeholder format: `%%RandomWord:WordListName%%`.
### Shuffle
Shuffle a list of values. can be used as Placeholder only. Placeholder format: `%%Shuffle::Value1::Value2::Value3;;separator%%`. Example: `%%Shuffle::Value1::Value2::Value3;;, %%` will return `Value3, Value1, Value2`.
### Pick
Pick a random value from a list of values. can be used as Placeholder only. Placeholder format: `%%Pick::Value1::Value2::Value3%%`. Example: `%%Pick::Red::Blue::Green%%` will return one of `Red`, `Blue`, or `Green` randomly.