JDR-Bot

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== Basic syntax ======

The scenario is composed of blocks of information, read by the bot.

Here is a basic scenario, with 3 rooms. Each part will then be explained to you, using a color code to differentiate each block.

<html>
<div style="background:#dddddd">
<span style="color:#FF00FF">scenario title or description</span><br />
<span style="color:#8000FF">3</span><br />
<span style="color:#FF0000">1 room_name_1</span><br />
<span style="color:#0000FF">Room_1 text</span><br />
<span style="color:#FFA000">|</span><br />
<div style="color:#30B000">2<br />
1->3<br />
exit->3<br />
3</div>
***************<br />
<span style="color:#FF0000">2 room_name_2</span><br />
<div style="color:#0000FF">Room_2 text+n+&&<br />
Continuation of text +n+from room 2<br /></div>
<span style="color:#FFA000">|</span><br />
<span style="color:#30B000">3</span><br />
***************<br />
<span style="color:#FF0000">3 room_name_3</span><br />
<div style="color:#0000FF">text of &&<br />
room_3</div>
<span style="color:#FFA000">|</span><br />
<span style="color:#30B000">999|Game Over</span><br />
***************<br />
</div></html>

So the scenario starts with a <html><span style="color:#FF00FF">TIRE</span></html>, which can be followed by one (or more) of the optional options (refresh, inventory, variable or room).
These options are advanced functions, using reactions. So they will be explained to you in [[reactions|use of reactions]]

Then we have the <html><span style="color:#8000FF">Number of ROOMS</span></html> (a room = a chapter or a passage of the scenario)
Next to the number of rooms, you can indicate a markdown for the colorization of your scenario on discord ("fix" by default)
Then, each room is broken down into several blocks (or parts):

  * <html><span style="color:#FF0000">Room number</span></html> (in order, serves as a cue to the bots and yourself) and <html><span style="color:#FF0000">Room name</span></html> (can replace the number for the "!"advance"" command. For example "j!advance 
  * <html><span style="color:#0000FF">Description of the room</span></html> (= text of script) with indication of different possibilities to advance, take, examine (you can also leave some things out, if it is useful for your scenario)
    * note the " +n+ " in the text: it indicates a line break in the displayed text
    * The " && " tells the bot to continue to take into account the following line as part of the text (and not the objects/states/variables block). It therefore ignores the line break present in the .txt
      * Thus the text of room 3 will be displayed in discord on a single line.
    * In summary: "+n+" = line break in discord, and "+n+" is used to space out the scenario in the text file.
      * "Continuation of text +n+ from room 2" will therefore be displayed in 2 lines on discord
  * <html><span style="color:#FFA000">Objects/States/Variables/etc.</span></html>
    * the "<html><span style="color:#FFA000">|</span></html>" tells the bot that we are not using any in this room. For a basic scenario (text and choice), we can do without it for now. Objects, states and variables will be explained in detail in the following wiki pages.
  * <html><span style="color:#30B000">Rooms</span></html> (or boxes) accessible with !advance[number], several possibilities:
    * <html><span style="color:#30B000">Number</span></html> (2 for example) => Number alone, the room is accessible without conditions
      * The conditions, allowing access or not to a room, and how to set them up will be explained in [[Conditions]]
    * <html><span style="color:#30B000">Alias->direction</span></html>: An alias can be assigned to a room. In the example, you see "exit→3|... ". This allows for "j!advance exit", which is then equivalent to "j!advance 3". Similarly "1->3", "j!advance 1" will lead to square 3...
      * You can specify conditions for accessing aliases. You will also see this in [[Conditions]].
    * <html><span style="color:#30B000">precedent</span></html> : Allows you to make the previous room accessible (for example if you come from room 52 or "kitchen", you can do j!avancer 52 or j!avancer cuisine).
      * We can also put conditions (required object or variable)
    * <html><span style="color:#30B000">998</span></html> or <html><span style="color:#30B000">999</span></html> => If this number is present in the list of accessible rooms, it means that the game ends (no matter if there are other accessible rooms), and displays the corresponding text. For example, you can use 998 for victory and 999 for defeat in your scenario
    * <html><span style="color:#30B000">997</span></html> => Will be detailed in the [[https://www.cyril-fiesta.fr/jdr-bot-wiki/doku.php?id=en:events|events]] page, allows you to perform an action (change a variable, change room, etc.) automatically if all conditions are correct (having a certain object for example) or manually via a discord reaction.
  * Finally the rooms end with "<html><span style="color:#000000">***********</span></html>" (no matter how many *, minimum 5 in a row.), to separate it from the others.

**Find us on the [[https://discord.gg/Z63DtVV|discord Make&Play]]**
JDR-Bot

Outils pour utilisateurs

Outils du site

Outils de la page
