From 0cc83698f9dbdc67c952f581bc3d1aa3b79e2513 Mon Sep 17 00:00:00 2001 From: Zach Parks Date: Mon, 2 Jan 2023 14:42:47 -0600 Subject: [PATCH] Docs: Add special name keywords to docs. (#1353) --- worlds/generic/docs/advanced_settings_en.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/worlds/generic/docs/advanced_settings_en.md b/worlds/generic/docs/advanced_settings_en.md index b96b1d57..be2eced7 100644 --- a/worlds/generic/docs/advanced_settings_en.md +++ b/worlds/generic/docs/advanced_settings_en.md @@ -63,7 +63,14 @@ games you want settings for. using this to detail the intention of the file. * `name` is the player name you would like to use and is used for your slot data to connect with most games. This can - also be filled with multiple names each having a weight to it. + also be filled with multiple names each having a weight to it. Names can also contain certain keywords, surrounded by + curly-braces, which will be replaced on generation with a number: + + * `{player}` will be replaced with the player's slot number. + * `{PLAYER}` will be replaced with the player's slot number if that slot number is greater than 1, otherwise blank. + * `{number}` will be replaced with the counter value of the name. + * `{NUMBER}` will be replaced with the counter value of the name if the counter value is greater than 1, otherwise + blank. * `game` is where either your chosen game goes or if you would like can be filled with multiple games each with different weights.