Update BazzBasic-AI-guide.txt

BazzBasic-AI-guide.txt

@@ -1,31 +1,29 @@
 # METADATA:
-
-Name: BazzBasic
-
-Description: BazzBasic BASIC interpreter language reference. Use when writing, debugging, or explaining BazzBasic code (.bas files). Triggers on BazzBasic syntax, BASIC programming with $ and # suffixes, SDL2 graphics in BASIC, or references to BazzBasic interpreter features
-
-About: BazzBasic is built around one simple idea: starting programming should feel nice and even fun. Ease of learning, comfort of exploration and small but important moments of success. Just like the classic BASICs of decades past, but with a fresh and modern feel.
-
-Purpose: This guide has been provided with the idea that it would be easy and efficient for a modern AI to use this guide and through this either guide a new programmer to the secrets of BazzBasic or, if necessary, generate code himself.
-
-Version: This guide is written for BazzBasic version 1.1d and is updated 26.03.2026 Finnish time.
-
+**Name:** BazzBasic-AI-guide.txt  
+**Description:** BazzBasic BASIC interpreter language reference for AI. Use BazzBasic to write, debug, or teach code.    
+**File extensions:*** ".bas"*, *".bb"*  
+**Version:** This guide is written for BazzBasic version 1.2 and is updated 01.04.26 (ddmmyy)
 # END METADATA
 
 ---
 
-# BazzBasic Language Reference
-**Version:** 1.1b (March 2026) | **Author:** Kristian Virtanen (EkBass) | **Platform:** Windows x64  
+## BazzBasic details
+**Version:** 1.2  
+**Author:** Kristian Virtanen (EkBass)  
+**Platform:** Windows x64  
+**License:** MIT
+
+## BazzBasic www-references
+**Homepage:** https://ekbass.github.io/BazzBasic/  
 **GitHub:** https://github.com/EkBass/BazzBasic  
 **Manual:** https://ekbass.github.io/BazzBasic/manual/#/  
-**Examples:** https://github.com/EkBass/BazzBasic/tree/main/Examples  
+**Common examples:** https://github.com/EkBass/BazzBasic/tree/main/Examples  
 **Rosetta Code:** https://rosettacode.org/wiki/Category:BazzBasic  
-
+**Rosetta-Code examples:** https://github.com/EkBass/BazzBasic/tree/main/Examples/rosetta-code
 
 ---
 
 ## ⚠️ Critical Rules — Read First
-
 | Rule | Detail |
 |------|--------|
 | Variables end with `$` | `name$`, `score$`, `x$` |
@@ -43,37 +41,26 @@ Version: This guide is written for BazzBasic version 1.1d and is updated 26.03.2
 
 ---
 
+## For context from the author:
+**About:** BazzBasic is built around one simple idea: starting programming should feel nice and even fun. Ease of learning, comfort of exploration and small but important moments of success. Just like the classic BASICs of decades past, but with a fresh and modern feel.
 
-## ABOUT
-BazzBasic is built around one simple idea: starting programming should feel nice and even fun.
-
-Ease of learning, comfort of exploration and small but important moments of success.
-
-Just like the classic BASICs of decades past, but with a fresh and modern feel.
-
-## STORY
-Although over the years, as my own skills have grown, I have moved on to more versatile and modern languages, BASIC has always been something that has been fun to try out many different things with.
-
-Sometimes it's great to just make a simple adventure game again, a lottery machine, a quiz, or even just those balls bouncing on the screen.
+**Story:** Although over the years, as my own skills have grown, I have moved on to more versatile and modern languages, BASIC has always been something that has been fun to try out many different things with. Sometimes it's great to just make a simple adventure game again, a lottery machine, a quiz, or even just those balls bouncing on the screen. BazzBasic was created with this in mind. I wanted to create a language that makes it easy for you to give free rein to your curiosity and program something. And when you finish your first little game, you may crave something bigger and better. 
 
-BazzBasic was created with this in mind.
+*Maybe one day you will move on to another programming language, but then BazzBasic will have succeeded in doing what it was intended for: To arouse your curiosity.*
 
-I wanted to create a language that makes it easy for you to give free rein to your curiosity and program something.
-
-And when you finish your first little game, you may crave something bigger and better.
-
-Maybe one day you will move on to another programming language, but then BazzBasic will have succeeded in doing what it was intended for.
-
-To arouse your curiosity.
+- Kristian Virtanen (EkBass), author of BazzBasic
 
 ## Variables & Constants
 
 ```basic
-LET a$                      ' Declare without value
-LET name$ = "Alice"         ' String variable
-LET score$ = 0              ' Numeric variable
-LET x$, y$, z$ = 10        ' Multiple declaration
-LET PI# = 3.14159           ' Constant (immutable)
+' variables
+LET a$  ' Declare without value
+LET name$ = "Alice"  ' String variable
+LET score$ = 0   ' Numeric variable
+LET x$, y$, z$ = 10 ' Multiple declaration
+' x$ & y$ has value of 0 while z$ has 10
+
+' constants
 LET TITLE# = "My Game"      ' String constant
 ```
 
@@ -85,7 +72,7 @@ LET TITLE# = "My Game"      ' String constant
 ### Built-in Constants
 - **Boolean:** `TRUE`, `FALSE`
 - **Math:** `PI`, `HPI` (π/2 = 90°), `QPI` (π/4 = 45°), `TAU` (2π = 360°), `EULER` (e)
-- **System:** `ROOT#` (program base directory path)
+- **System:** `PRG_ROOT#` (program base directory path), `BBVER#` (interpreter version as text, e.g. `"1.1"`)
 - **Keyboard:** `KEY_ESC#`, `KEY_ENTER#`, `KEY_SPACE#`, `KEY_UP#`, `KEY_DOWN#`, `KEY_LEFT#`, `KEY_RIGHT#`, `KEY_F1#`…`KEY_F12#`, `KEY_A#`…`KEY_Z#`, `KEY_0#`…`KEY_9#`, `KEY_LSHIFT#`, `KEY_LCTRL#`, etc.
 
 ---
@@ -106,6 +93,7 @@ matrix$(0, 1) = "A2"                ' Multi-dimensional
 | `HASKEY(arr$(key))` | 1 if exists, 0 if not |
 | `DELKEY arr$(key)` | Remove one element |
 | `DELARRAY arr$` | Remove entire array (can re-DIM after) |
+| `JOIN dest$, src1$, src2$` | Merge two arrays into dest$; src2$ keys overwrite src1$ on conflict |
 
 **Always check with `HASKEY` before reading uninitialized elements.**
 
@@ -165,6 +153,8 @@ END                         ' Terminate program
 | `LINE INPUT "prompt", var$` | Read entire line with spaces |
 | `CLS` | Clear screen |
 | `LOCATE row, col` | Move cursor (1-based) |
+| `CURPOS("row")` | Returns current cursor row |
+| `CURPOS("col")` | Returns current cursor column |
 | `COLOR fg, bg` | Text colors (0–15 palette) |
 | `SHELL("cmd")` | Run shell command, returns output |
 | `SHELL("cmd", ms)` | With timeout in ms (default 5000) |
@@ -257,7 +247,8 @@ FN Clamp$(5, 1, 10)                ' ✗ ERROR — return value unused
 | `MAX(a, b)` / `MIN(a, b)` | Larger / smaller of two |
 | `MOD(a, b)` | Remainder |
 | `POW(base, exp)` | Power |
-| `RND(n)` | Random integer 0 to n-1 |
+| `RND(0)` | Random float 0.0 to <1.0         |
+| `RND(n)` | Random integer 0 to n-1 (n ≥ 1) |
 | `ROUND(n)` | Standard rounding |
 | `SGN(n)` | Sign: -1, 0, or 1 |
 | `SQR(n)` | Square root |
@@ -312,9 +303,11 @@ CLS                                 ' Clear screen (slow — prefer LINE BF)
 ### Shapes & Images
 ```basic
 ' Create shape
-LET id$ = LOADSHAPE("RECTANGLE", w, h, color)   ' or "CIRCLE", "TRIANGLE"
-LET img$ = LOADIMAGE("player.png")               ' PNG (alpha) or BMP
-LET img$ = LOADIMAGE("https://example.com/a.png") ' Download + load
+' LOADSHAPE and LOADIMAGE return a stable integer handle — never reassigned.
+' SDL2 owns the resource; your code only ever holds this one reference. Use constants.
+LET RECT# = LOADSHAPE("RECTANGLE", w, h, color)  ' or "CIRCLE", "TRIANGLE"
+LET IMG_PLAYER# = LOADIMAGE("player.png")         ' PNG (alpha) or BMP
+LET IMG_REMOTE# = LOADIMAGE("https://example.com/a.png") ' Download + load
 
 ' Sprite sheet — sprites indexed 1-based
 DIM sprites$
@@ -322,12 +315,12 @@ LOADSHEET sprites$, 128, 128, "sheet.png"        ' tileW, tileH, file
 MOVESHAPE sprites$(1), x, y                      ' sprites$(1) = first sprite
 
 ' Transform
-MOVESHAPE id$, x, y                 ' Position by center point
-ROTATESHAPE id$, angle              ' Degrees (absolute)
-SCALESHAPE id$, scale               ' 1.0 = original size
-DRAWSHAPE id$                       ' Render to buffer
-SHOWSHAPE id$ / HIDESHAPE id$       ' Toggle visibility
-REMOVESHAPE id$                     ' Free memory (always clean up)
+MOVESHAPE RECT#, x, y               ' Position by center point
+ROTATESHAPE RECT#, angle            ' Degrees (absolute)
+SCALESHAPE RECT#, scale             ' 1.0 = original size
+DRAWSHAPE RECT#                     ' Render to buffer
+SHOWSHAPE RECT# / HIDESHAPE RECT#   ' Toggle visibility
+REMOVESHAPE RECT#                   ' Free memory (always clean up)
 ```
 
 ---
@@ -335,12 +328,14 @@ REMOVESHAPE id$                     ' Free memory (always clean up)
 ## Sound
 
 ```basic
-LET snd$ = LOADSOUND("jump.wav")    ' Load (WAV recommended)
-SOUNDONCE(snd$)                     ' Play once, non-blocking
-SOUNDONCEWAIT(snd$)                 ' Play once, wait for finish
-SOUNDREPEAT(snd$)                   ' Loop continuously
-SOUNDSTOP(snd$)                     ' Stop specific sound
-SOUNDSTOPALL                        ' Stop all sounds
+' LOADSOUND returns a stable integer handle — SDL2 manages the resource.
+' The handle never changes; store it in a constant to protect it from accidental reassignment.
+LET SND_JUMP# = LOADSOUND("jump.wav")   ' Load (WAV/MP3 recommended)
+SOUNDONCE(SND_JUMP#)                    ' Play once, non-blocking
+SOUNDONCEWAIT(SND_JUMP#)               ' Play once, wait for finish
+SOUNDREPEAT(SND_JUMP#)                 ' Loop continuously
+SOUNDSTOP(SND_JUMP#)                   ' Stop specific sound
+SOUNDSTOPALL                            ' Stop all sounds
 ```
 
 Load all sounds at startup. Call `SOUNDSTOPALL` before `END`.
@@ -366,7 +361,7 @@ LET env$ = FileRead(".env")
 LET API_KEY# = env$("OPENAI_API_KEY")
 ```
 
-**Paths:** Use `/` or `\\` — never single `\` (it's an escape char). Relative paths are from `ROOT#`.  
+**Paths:** Use `/` or `\\` — never single `\` (it's an escape char). Relative paths are from `PRG_ROOT#`.  
 **FileWrite with array** saves in key=value format (round-trips with FileRead).
 
 ---
@@ -441,27 +436,26 @@ Library functions can read main-program constants (`#`). `.bb` files are version
 ## Program Structure
 
 ```basic
-' ---- 1. CONSTANTS (or INCLUDE "constants.bas") ----
-LET SCREEN_W# = 640
-LET SCREEN_H# = 480
-LET MAX_SPEED# = 5
-
-' ---- 2. FUNCTIONS (or INCLUDE "functions.bas") ----
+' ---- 1. FUNCTIONS (or INCLUDE "functions.bas") ----
 DEF FN Clamp$(v$, lo$, hi$)
     IF v$ < lo$ THEN RETURN lo$
     IF v$ > hi$ THEN RETURN hi$
     RETURN v$
 END DEF
 
-' ---- 3. INIT (declare ALL variables here, not inside loops) ----
+' ---- 2. INIT (declare ALL variables/constants here, not inside loops) ----
 ' Performance: variables declared outside loops avoid repeated existence checks.
 [inits]
-    SCREEN 0, SCREEN_W#, SCREEN_H#, "My Game"
+    LET SCREEN_W# = 640
+    LET SCREEN_H# = 480
+    LET MAX_SPEED# = 5
     LET x$ = 320
     LET y$ = 240
     LET running$ = TRUE
 
-' ---- 4. MAIN LOOP ----
+    SCREEN 0, SCREEN_W#, SCREEN_H#, "My Game"
+
+' ---- 3. MAIN LOOP ----
 [main]
     WHILE running$
         IF INKEY = KEY_ESC# THEN running$ = FALSE
@@ -470,9 +464,9 @@ END DEF
         SLEEP 16
     WEND
     SOUNDSTOPALL
-END
+END ' always before code enters to subroutines
 
-' ---- 5. SUBROUTINES (or INCLUDE "subs.bas") ----
+' ---- 4. SUBROUTINES (or INCLUDE "subs.bas") ----
 [sub:update]
     IF KEYDOWN(KEY_LEFT#)  THEN x$ = x$ - MAX_SPEED#
     IF KEYDOWN(KEY_RIGHT#) THEN x$ = x$ + MAX_SPEED#
@@ -489,8 +483,8 @@ RETURN
 **Key conventions:**
 - Variables: `camelCase$` | Constants: `UPPER_SNAKE_CASE#` | Functions: `PascalCase$`
 - Labels: `[gameLoop]` for jump targets, `[sub:name]` for subroutines
-- Image/sound IDs that never change → use constants: `LET MY_IMG# = LOADIMAGE("x.png")`
-- Group many image/sound IDs → use arrays: `DIM sprites$` / `sprites$("player") = LOADIMAGE(...)`
+- Image/sound/shape IDs are stable integer handles — **always** store as constants: `LET MY_IMG# = LOADIMAGE("x.png")` — never use `$` variables for these
+- Group many IDs -> use arrays: `DIM sprites$` / `sprites$("player") = LOADIMAGE(...)` — but prefer named constants when count is small
 
 ---
 
@@ -501,4 +495,142 @@ RETURN
 - Store `RGB()` results in constants/variables — don't call RGB in hot loops
 - Declare all variables in `[inits]`, not inside loops or subroutines
 - Use `FastTrig` for any loop calling trig hundreds of times per frame
-- `SLEEP 16` in game loop → ~60 FPS
+- `SLEEP 16` in game loop → ~60 FPS
+
+---
+
+## Rosetta-Code example
+
+### Animate a pendulum
+
+```basic
+' https://rosettacode.org/wiki/Animate_a_pendulum
+' BazzBasic conversion from Freebasic code
+' https://ekbass.github.io/BazzBasic/
+
+' This is done for educational purposes -> commented everything
+' Public Domain
+
+
+[inits]
+    LET SCREEN_W# = 640         ' Screen width in pixels
+    LET SCREEN_H# = 480         ' Screen height in pixels
+    LET DAMPING# = 0.9995       ' Energy loss per frame (1.0 = no loss, 0.0 = instant stop)
+
+    LET g$      = 9.81          ' Gravity constant (m/s²) — drives the swing force
+    LET l$      = 1             ' Pendulum length (affects swing speed — longer = slower)
+    LET speed$  = 0             ' Current angular velocity (how fast the angle is changing)
+    LET accel$                  ' Angular acceleration this frame (force pushing toward center)
+
+    LET px$     = SCREEN_W# / 2 ' Pivot point X — where the pendulum is attached (screen center top)
+    LET py$     = 10            ' Pivot point Y — a bit down from top edge
+    LET theta$  = HPI           ' Current angle in radians (HPI = 90° = starts horizontal)
+    LET bx$                     ' Bob X position on screen (calculated each frame)
+    LET by$                     ' Bob Y position on screen (calculated each frame)
+
+
+[main]
+    SCREEN SCREEN_W#, SCREEN_H#
+    WHILE INKEY <> KEY_ESC#
+        ' Project angle to screen coordinates
+        bx$ = px$ + l$ * (SCREEN_W# / 2) * SIN(theta$)   ' horizontal offset from pivot
+        by$ = py$ - l$ * (SCREEN_W# / 2) * COS(theta$)   ' vertical offset from pivot (Y flipped)
+
+        SCREENLOCK ON
+            LINE (0, 0) - (SCREEN_W#, SCREEN_H#), 15, BF   ' clear screen
+            LINE (px$, py$) - (bx$, by$), 0                ' draw rod
+            CIRCLE (bx$, by$), 50, 7, 1                    ' draw bob
+        SCREENLOCK OFF
+
+        accel$  = g$ * SIN(theta$) / l$ / 100  ' gravity pulls bob toward center (SIN of angle = sideways force)
+        speed$  = (speed$ * DAMPING#) + accel$ / 100  ' update speed with damping applied
+        theta$  = theta$ + speed$              ' advance the angle by current speed
+        SLEEP 16
+    WEND
+END
+```
+
+### RGB attributes generator
+```basic
+' ============================================
+' https://rosettacode.org/wiki/RPG_attributes_generator
+' BazzBasic: https://github.com/EkBass/BazzBasic
+' ============================================
+' Attributes: Strength, Dexterity, Constitution,
+'             Intelligence, Wisdom, Charisma
+'
+' Rules:
+'   - Total of all attributes must be >= 75
+'   - At least two attributes must be >= 15
+
+LET MIN_TOTAL# = 75
+LET MIN_TWO#   = 15
+
+' Roll 4d6, drop the lowest die, return sum of top 3
+DEF FN RollStat$()
+    LET r1$ = RND(6) + 1
+    LET r2$ = RND(6) + 1
+    LET r3$ = RND(6) + 1
+    LET r4$ = RND(6) + 1
+    RETURN r1$ + r2$ + r3$ + r4$ - MIN(MIN(r1$, r2$), MIN(r3$, r4$))
+END DEF
+
+[inits]
+    DIM attributes$
+        attributes$("str") = 0
+        attributes$("dex") = 0
+        attributes$("con") = 0
+        attributes$("int") = 0
+        attributes$("wis") = 0
+        attributes$("cha") = 0
+    LET stat$      = 0
+    LET total$     = 0
+    LET highCount$ = 0
+    LET passed$    = FALSE
+
+[main]
+    WHILE passed$ = FALSE
+        stat$ = FN RollStat$() : attributes$("str") = stat$
+        stat$ = FN RollStat$() : attributes$("dex") = stat$
+        stat$ = FN RollStat$() : attributes$("con") = stat$
+        stat$ = FN RollStat$() : attributes$("int") = stat$
+        stat$ = FN RollStat$() : attributes$("wis") = stat$
+        stat$ = FN RollStat$() : attributes$("cha") = stat$
+
+        total$ = attributes$("str") + attributes$("dex") + attributes$("con") + attributes$("int") + attributes$("wis") + attributes$("cha")
+
+        highCount$ = 0
+        IF attributes$("str") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+        IF attributes$("dex") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+        IF attributes$("con") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+        IF attributes$("int") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+        IF attributes$("wis") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+        IF attributes$("cha") >= MIN_TWO# THEN highCount$ = highCount$ + 1
+
+        IF total$ >= MIN_TOTAL# AND highCount$ >= 2 THEN passed$ = TRUE
+    WEND
+
+    PRINT "Attribute    Score"
+    PRINT "------------------"
+    PRINT "Strength     " + STR(attributes$("str"))
+    PRINT "Dexterity    " + STR(attributes$("dex"))
+    PRINT "Constitution " + STR(attributes$("con"))
+    PRINT "Intelligence " + STR(attributes$("int"))
+    PRINT "Wisdom       " + STR(attributes$("wis"))
+    PRINT "Charisma     " + STR(attributes$("cha"))
+    PRINT "------------------"
+    PRINT "Total        " + STR(total$)
+END
+
+' Expected output (example - varies each run):
+' Attribute    Score
+' ------------------
+' Strength     13
+' Dexterity    15
+' Constitution 12
+' Intelligence 11
+' Wisdom       15
+' Charisma     10
+' ------------------
+' Total        76
+```