narrat 2.2.4 → 2.2.7

package/CHANGELOG.md

@@ -0,0 +1,1081 @@
+# Narrat changelog
+
+## 2.2.3
+
+New `think` command. Works the same as talk, but doesn't wrap text in quotes.
+
+It also has custom CSS so each version of text can be customised. talk commands add the CSS class `talk-command`, think: `think-command`, and the basic text command adds `text-command`.
+
+Example:
+
+```py
+think player idle "I wonder if I could eat a whole pizza in 28 seconds"
+```
+
+## 2.2.2
+
+New notification commands and options:
+
+- `disable_notifications`: Disables notifications
+- `enable_notifications`: Enables notifications
+
+New config option: `skillOptions.notifyLevelUp` (boolean). Default: true. If set to false, will disable notifications from level ups for the whole game.
+
+## 2.2.1
+
+Notifications can now use html tags and string interpolation
+
+Example: `notify "Hello <span style='color:red;'>%{playerName}</span>"` will work
+
+## 2.2.0
+
+Audio improvements:
+
+- New audio mode: `ambiant` for ambiant music/sound
+- New audio channels feature: Optional `channel` parameter in `play`, `stop` and `pause` commands to choose a channel (defaults to 0). This allows having multiple musics, or multiple ambiant sounds to play at once.
+
+Examples:
+
+- `play music calm` will play the music `calm` on channel 0.
+- `wait 2000`
+- `play music calm 1` will play the music `calm` on channel 1. Because it's a different channel, the musics will superpose
+- `wait 2000`
+- `stop music 1` will stop the music on channel 1.
+- `play ambiant forest` will play the ambiant sound `forest` on channel 0. This is a different audio mode, so it will be played independently of the musics.
+
+Sounds now also use channels, but they ignore all the code related to fading musics in and out, or stopping the previous audio on the channel (because sounds are meant to be a one off and people shouldn't have to bother keeping track of sound channels).
+
+To stop the last audio played on the channel `stop sound` works. It is still possible to use channels with sounds (`play sound bang 1` then later `stop sound 1`), but it shouldn't be necessary.
+
+## 2.1.6
+
+Fixed an issue where the `random` command didn't accept 0 as a number
+
+## 2.1.5
+
+Bugfixes related to save slots edge cases
+
+## 2.1.4
+
+New math commands:
+
+- `floor`: Turns a number into an integer (whole number), rounding down.
+- `ceil`: Turns a number into an integer (whole number), rounding up.
+- `round`: Rounds a number to the nearest integer.
+- `sqrt`: Square root of a number.
+- `^`: Exponentiation.
+
+Also, the `set_level` and `add_level` commands will give a warning and auto round values passed if they're not whole numbers.
+
+### Save slots
+
+The engine now supports save slots. The "Load game" button will open a window for the player to choose a save file to load.
+
+There is also a new "Continue" button that will appear if the player has already played to continue playing on the same slot as last time.
+
+## 2.1.3
+
+There is now access to the game's config and app options in script, notably useful to check if the game is in debug mode. New available options:
+
+`$config`: The game's config.
+`$gameOptions`: The options passed when launching the game with `startApp`
+
+Example:
+
+```rpy
+main:
+  if $gameOptions.debug:
+    "Do something in debug mode"
+```
+
+## 2.1.2
+
+### Internal Refactor
+
+The scripting engine has been refactored internally to differentiate between blocks and frames. A frame in the stack is now a function call (running a label or jumping), whereas blocks are for branching. That means any block inside a frame still has access to the same scoped variables (which are stored in the frame), and `return` can now be called anywhere inside a function and will interrupt the function and return, like in other languages.
+
+### Bugfixes
+
+- There was an issue with the `text` command from the fix in 2.1.1, now solved
+- There were various issues affecting performance and logic in keyboard handling with the dialogue box which are now fixed
+- Added a bit of debouncing on the keyboard events because there was an issue when speeding through games
+
+### Keyboard events in production
+
+Previously, the engine was using a `keydown` event for picking choices with the keyboard. This allowed speeding through the game quickly, but shouldn't be possible in production.
+
+The engine now instead uses a `keyup` event if the debug mode is up, to make it impossible to speed through the game by holding space for normal players.
+
+## 2.1.1
+
+fix: The `text` command (default command for printing text without using `talk`) was adding quotes around text since 2.0.0. This is now fixed.
+
+## 2.1.0
+
+### ⚠️ Breaking Change ⚠️
+
+Narrat has been updated to use [vite 3](https://vitejs.dev/blog/announcing-vite3.html#the-ecosystem-is-ready-for-v3). The only breaking change is that the path of the narrat CSS file has changed:
+
+In the game's `index.ts` the import of CSS needs to change. Before:
+
+`import 'narrat/dist/lib.css';`
+
+After:
+
+`import "narrat/dist/style.css";`
+
+Many new features, TODO: fill changelog.
+
+### Data shorthand
+
+It is now no longer necessary to prefix things with `data` when setting or getting variables.
+
+For example `set player.name` is equivalent to `set data.player.name`.
+
+The way the system works when looking up variables is:
+
+- Return if there's a base variable in the lookup state matching (for example `data`, `skills` etc)
+- Otherwise if a variable exists in the local scope (created with `var`) use that
+- Otherwise default to assuming we're editing something inside `data`
+
+### New example RPG game
+
+There is now an example [dungeon crawler turn based RPG](https://github.com/liana-p/narrat/tree/main/examples/rpg) game made as a test to push the engine and scripting features. It is not meant to be a full game, but can be a useful reference for advanced usage.
+
+### Anchor feature for buttons
+
+There is now an optional `anchor` property for buttons, useful for anchoring a buttom from its center or any other place.
+
+Example:
+
+```json
+{
+  "buttons": {
+    "go_front": {
+      "enabled": false,
+      "background": "img/ui/front.png",
+      "position": {
+        "left": 440,
+        "top": 120,
+        "width": 96,
+        "height": 96
+      },
+      "anchor": {
+        "x": 0.5,
+        "y": 0.5
+      },
+      "action": "choose_front"
+    }
+  }
+}
+```
+
+### Base assets path
+
+There is now a way to pass a base assets path to narrat, which will be prepended to the path of any assets that need to be loaded by the engine (this was needed to implement the multiple demos in a single repo).
+
+The option is `baseAssetsPath` which can be passed in the first options object of `startApp`.
+
+See the `demo.ts` file for an example of how to use it.
+
+### Game examples now in the repo
+
+The repo has been restructures to allow having multiple example games directly inside it.
+
+The `examples/` folder contains a subfolder for each demo game, where the data/asset files for a game can be placed.
+
+To run an example game, the dev script needs to be run with a special environment variable pointing to the path of the game to run. For example, a command has been added to run the rpg game:
+
+`npm run rpg` -> Runs `cross-env VITE_EXAMPLE=examples/rpg npx vite dev`
+
+Demo games can also be built from the repo. For example:
+
+`npm run build-rpg` -> Runs `cross-env VITE_DEMO_BUILD=rpg npx vite build && shx cp -r examples/rpg/* built-example/rpg`. The built game is then available in the `built-example/rpg` folder.
+
+### New commands
+
+Added a lot of new commands while making the RPG example.
+
+#### Math operations
+
+- Negate numbers: `neg 1` -> returns -1
+- Absolute function: `abs -1` -> returns 1
+- Min - returns lowest passed number: `min 1 2` -> returns 1
+- Max - returns highest passed number: `max 1 2` -> returns 2
+- Clamp - returns number between min and max: `clamp 1 2 3` -> returns 2 (syntax: `clamp [min] [max] [value]`)
+
+#### Random generation
+
+- Random number: `random 1 10` -> returns an **integer** random number between 1 and 10 (inclusive)
+- Random float: `random_float 1 10` -> returns a float between 1 and 10
+- Random from args: `random_from_args "a thing" "another thing" 2 "things can be any value"` -> returns a random item from the list of arguments
+
+#### Strings
+
+- Concat: `concat "a" "b"` -> returns "ab" (Syntax: `concat [string1] [string2] [string3]...`)
+- Join: `join ", " "a" "b"` -> returns "a, b" (Syntax: `join [separator] [item1] [item2] [item3] ...`)
+
+#### Skills
+
+- Set level: `set_level agility 1` -> sets the level of the skill "agility" to 1
+- Get level: `get_level agility` -> returns the level of the skill "agility"
+- Get xp: `get_xp agility` -> returns the xp of the skill "agility"
+
+#### Utility
+
+- Log: `log $someVariable` -> logs the value of the variable $someVariable to the console (Syntax: `log [value1] [value2] [value3]...`). Can be used to log anything for debugging
+
+## 2.0.12
+
+New layers feature: Multiple screens can be overlaid on top of each other in layers.
+
+Layers are defined by their number, being displayed from 0 to x. By default, the `set_screen` command sets a screen on the first layer, as it did before. To set a screen on a different layer, pass the layer number as a second parameter.
+
+```py
+set_screen my_screen 1
+// do stuff, then remove the overlay
+empty_layer 1
+```
+
+## 2.0.11
+
+feature: The left-side viewport now uses DOM instead of canvas so screens and buttons can use animated gifs or webp.
+
+The config has optionally been made easier to edit, with no need to define images in the `images` part of the config. buttons can also now be optionally defined inside the screen directly. The config is still compatible with the old syntax.
+
+Example:
+
+```json
+{
+  "screens": {
+    "default": {
+      "background": "narrat"
+    },
+    "map": {
+      "background": "img/backgrounds/map.png",
+      "buttons": [
+        {
+          "id": "shopButton",
+          "enabled": false,
+          "background": "img/ui/shop-button.png",
+          "position": {
+            "left": 38,
+            "top": 6,
+            "width": 255,
+            "height": 226
+          },
+          "action": "shopButton"
+        },
+        {
+          "id": "parkButton",
+          "enabled": false,
+          "background": "img/ui/park-button.png",
+          "position": {
+            "left": 632,
+            "top": 86,
+            "width": 255,
+            "height": 226
+          },
+          "action": "parkButton"
+        }
+      ]
+    }
+  }
+}
+```
+
+## 2.0.10
+
+fix: `quest_completed?` now returns the correct value
+
+## 2.0.9
+
+Internal engine changes, shouldn't impact users.
+
+Refactor to the VM and commands system to handle the way the stack flows better. Commands don't have to call `nextLine` on the VM to run the next line, instead the VM properly knows when a command is truly finished and controls the program's flow.
+
+Also renamed `stacks` to `frames`, as the stack is the array that contains the frames and this was confusing.
+
+## 2.0.8
+
+- Fix: Auto scrolling when new text is added now works properly
+- Fix: error when using set_stat or add_stat with a value of 0
+
+## 2.0.7
+
+Fixed an error where the `roll` function always returned true even if the skill check failed
+
+## 2.0.6
+
+Fixed a reggression bug introduced in 2.x where player choices weren't printed anymore in the dialogue history after making a choice.
+
+## 2.0.4
+
+Fixed more audio edge cases around race conditions
+
+## 2.0.1
+
+Fixed audio bug around loading
+
+### New feature: Text Fields
+
+New text fields feature to let players type answers to questions.
+
+Usage: `text_field [prompt]`
+
+Example:
+
+```py
+main:
+  set player.name (text_field "Enter your name")
+  "Your name is %{playerName}"
+```
+
+## 2.0.0
+
+The narrat 2.0.0 branch is now the main branch.
+
+Narrat 1.x has been deprecated and moved to the `v1-latest` tag on npm.
+
+To install old v 1.x for legacy games, use `npm install narrat@v1-latest` instead of just `npm install narrat`
+
+To know more about how to update a game to 2.x, see the [narrat 2.0.0 docs](https://docs.get-narrat.com/readme/narrat-2.0)
+
+## 2.0.0-rc4
+
+### Important Note
+
+The main CSS file from narrat must now be imported in games using it to have the default CSS.
+
+Simply add `import 'narrat/dist/style.css';` at the top of your `index.ts` (before your own CSS).
+
+### Switch to vite
+
+To make developping narrat easier, the bundler used has been switched from rollup to vite. Vite is recommended as the standard for Vue these days, and the rollup vue plugin is deprecated. The update was necessary to support more recent features.
+
+This has no impact on end users, other than having to import the CSS file as explained above.
+
+## 2.0.0-rc3
+
+- Improvements to debugging to show more useful info on parser/runtime errors
+- Corrected display of line numbers in errors
+- Made parser continue parsing after errors to make it easier to see all errors at once and to be able to play the game even if there are parser errors
+
+## 2.0.0-rc1
+
+### Narrat 2.0
+
+### What changed in narrat 2.0
+
+Narrat has a **new language syntax** in 2.0.0 - The parser has been improved to turn the narrat scripting into a full programming language with support for expressions, variables and functions
+
+The syntax is generally the same so existing scripts would mostly work, except for the use of `$if` (which used to be a hack by sending your code to JavaScript [eval](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval)).
+
+### Script updating tool
+
+There is a [script updating tool](https://github.com/liana-pigeot/Narrat-Script-Updater) which can be used to help automatically update existing scripts from 1.x to work with the new syntax.
+
+{% hint style="danger" %}
+The old syntax is largely compatible, but the $if instruction works very differently now. The script will update those $if instructions to match the new system, but might fail at updating long series of conditions in $if
+{% endhint %}
+
+### Installing narrat 2.0
+
+Narrat 2.0 is currently published under a different tag to avoid people on 1.x accidentally installing it.
+
+To install narrat to, run `npm install narrat@next`. The `next` tag is where the latest 2.x version is published.
+
+### Expressions
+
+Expressions are now a first party feature. An expression is any operation between parenthesis. Any command in the game can be used as an expression, if it returns a value. For example `(+ 2 3)` is an expression that would get evaluated to `5`.
+
+### Syntax for using commands
+
+The syntax for using commands hasn't changed, but it's been formalised.
+
+The format for any operation is `[operator] [arg1] [arg2] [arg3] ...`. Operator is the command's keyword (like `talk`, `set`, `if` etc).
+
+For example:
+
+`set data.player.score 3` is the operator `set` with arguments `data.player.score` and `3`.
+
+`set data.player.score (+ $data.player.score 2)`
+
+The first command would set `3` in `data.player.score`.
+
+The second command is also a set on `data.player.score`, but the second argument (the value) is an expression itself: `(+ $data.player.score 2)`. So the final resulting command is effectively `set data.player.score 5`.
+
+### Using Variables
+
+To use a variable's value in a command, prefix its name with `$` as in the example above. In the case of the `set` command, we want to pass to set the variable's name, not its value, so we don't use `$` at the start.
+
+Variables are also available in string interpolation as before, to insert variables in text:
+
+`talk player idle "Hello %{data.player.name}"`
+
+### New If syntax
+
+The previous `$if` is gone, now `if` is a command itself, which takes one argument: the condition. If the condition is true it plays the next branch, and it can have an optional else branch.
+
+Example:
+
+```py
+set data.age 25
+if (> $data.age 18):
+  "The player is an adult"
+else:
+  "The player is not an adult"
+```
+
+#### More details on syntax and expressions
+
+More complex example:
+
+```py
+main:
+  set data.winThreshold 10
+  set data.player.score 5
+  set data.player.scoreBonus 5
+  if (== (+ $data.player.score $data.player.scoreBonus) $data.winThreshold):
+    "The player won!"
+```
+
+In this example, the script stores a few variables, and then uses them in an `if` to compare their value. The `==` operation returns true if all arguments are equal, while the `+` operation adds values together and returns the result.
+
+Here's how the code above would get broken down as the expressions get calculated:
+
+```py
+if (== (+ $player.score $player.scoreBonus) $data.winThreshold):
+if (== 10 $data.winThreshold):
+if (== 10 10):
+if true
+```
+
+### New operators
+
+A lot of new operators have been added to be able to perform basic operations with the new scripting system:
+
+- `+`, `-`, `*`, `/` : Will add/substract/etc arguments passed and return the value. Can take infinite arguments
+- `||` and `&&` : Will or/and all arguments passed and return true or false. Inifinite arguments
+- `>`, `>=`, `<`, `<=`, `==`, `!=` : Compares arguments 1 and 2, returns true or false. Note: equality uses truthy equality, not strict equality
+- `!`: Negates argument 1
+- `?`: Ternary operation. Arg 1 is the condition, 2 is what gets returned on success, 3 what gets returned on failure
+
+### New helper functions
+
+New helper functions for easily checking quests and inventory without long lines:
+
+- `quest_completed? [questId]`: Returns true if the quest `questId` is completed
+- `objective_completed? [questId] [objectiveId]`: Same for an objective
+- Also quest_started and `objective_started`
+- `has_item? [itemId] [amount (optional)]`: Returns true if the player has an item (if amount is passed, the player needs to have amount or more of it)
+- `item_amount? [itemId]` Returns how many of an item the player has.
+
+### Local variables
+
+Local variables can now be declared. They exist inside the scope in which they are declared. Example
+
+```python
+main:
+  run variables_test
+  "The variable 'test' is now undefined because we left the scope it was created in: %{test}"
+
+variables_test:
+  var test 1
+  "Test value is %{test}"
+```
+
+### Function with arguments and return values
+
+Labels are now "functions" and can take arguments or return values.
+
+Example:
+
+```renpy
+main:
+  var meal (run takeout_menu Cake)
+  "The player chose to eat %{meal}"
+
+takeout_menu third_option:
+  var meal ""
+  choice:
+    talk helper idle "Which meal do you want?"
+    "Pizza":
+      set meal pizza
+    "Burger":
+      set meal burger
+    "%{third_option}":
+      set meal $third_option
+  talk helper idle "Chosen %{meal}"
+  return $meal
+
+```
+
+### Other new features
+
+#### Audio triggers
+
+New audio triggers feature to play sounds on certain events in the game.
+
+Simply add the sounds to the config:
+
+```json
+  "audioTriggers": {
+    "onPlayerAnswered": "click",
+    "onPressStart": "game_start",
+    "onSkillCheckFailure": "failure",
+    "onSkillCheckSuccess": "success"
+  }
+```
+
+Keys are event names, and values are the id of an audio you've defined in the config. For now all the available events are the ones above. Once defined, the sound will play every time that event is triggered.
+
+## 1.3.3
+
+1.x branch is now deprecated as 2.x is being pushed to main.
+
+See [Narrat 2.0 update](https://docs.get-narrat.com/readme/narrat-2.0) docs for more info on how to update to 2.x
+
+The main breaking change is the syntax for $if has changed, and also a CSS file needs to be imported in the game's `index.ts`:
+
+`import 'narrat/dist/lib.css';`
+
+## 1.3.2
+
+- Improvement to variables editor for debugging
+- Bugfixes to access quests in conditions
+
+## 1.3.1
+
+New feature to "use" items.
+
+In an item config, an optional `onUse` value is available, which cn be set to a label to jump to when using the item.
+
+There are also interaction groups which allow scripts to toggle on/off whether using items is allowed. They can be configured to automatically be turned off during dialogue scripts (to avoid bugs/side effects that jumping to an item's label would cause halfway through dialogue).
+
+Config:
+
+```json
+  "items": {
+    "bread": {
+      "name": "Bread",
+      "description": "A bread in the game.",
+      "icon": "img/items/bread.png",
+      "onUse": {
+        "action": "jump",
+        "label": "eat_bread"
+      },
+      "tag": "default"
+    },
+    "book": {
+      "name": "Ominous Book",
+      "description": "An ominous book",
+      "icon": "img/items/book.png",
+      "onUse": {
+        "action": "run",
+        "label": "read_book"
+      },
+      "tag": "always_interactable"
+    }
+  },
+  "interactionTags": {
+    "default": {
+      "onlyInteractOutsideOfScripts": true
+    }
+  }
+```
+
+The `onUse` `action` property can be either `jump` or `run`, allowing to either jump to a script, or run a script as a function (see [1.3.0 changes](#1.3.0) or [functions docs](https://docs.get-narrat.com/features/functions)), which effectively allows interrupting the current dialogue to run an item's function before going back to it.
+
+The `tag` property on an item data sets which interaction group it is part of. This allows fine control of which items can be allowed to be used when. For example, some items might be available to use all the time, while some should only be allowed to be used at certain points.
+
+By default if not provided, items have the `default` tag, and the default configuration has the `default` tag set to use `onlyInteractOutsideOfScripts`, which automatically disables interaction during scripts to avoid issues.
+
+In the example above, the bread can only be interacted with outside of scripts and will use a jump to a label, while the book can be interacted with at any time and will use a `run`, effectively running a label as a function and then going back to where the script was.
+
+In scripts, interaction tags can be controlled:
+
+```py
+main:
+  disable_interaction someTag
+  talk player idle "Impossible to use items with the tag someTag for now"
+  enable_interaction someTag
+  talk player idle "It is now possible to use items with the tag someTag"
+```
+
+## 1.3.0
+
+New `run` function to run a label as a "function"
+
+The difference between this and jump is that using `run` will go back to where you were before once the label is over.
+
+For example:
+
+```py
+main:
+  set data.counter 1
+  jump functions_test
+
+functions_test:
+  run some_function
+  talk player idle "Back to functions_test"
+  run some_function
+  talk player idle "We're back again"
+
+some_function:
+  talk player idle "Ran the function %{data.counter} times"
+  add data.counter 1
+```
+
+In this example when running `functions_test`, the script in `some_function` will be ran, then the execution comes back to do the rest of `functions_test`.
+
+**Note:** Saving still only happens when _jumping_ to a label, because being at a specific label is the only way to make sure a save file can keep working if the code of the game gets changed in an update.
+
+## 1.2.1
+
+Improved reset feature when returning to main menu to avoid potential bugs
+
+## 1.2.0
+
+## Quests system
+
+There is a new quests system.
+
+Quests can be defined in the config:
+
+```json
+  "quests": {
+    "breadShopping": {
+      "title": "Bread Shopping",
+      "description": "The helper cat asked you to buy bread for him.",
+      "objectives": {
+        "bread": {
+          "description": "Buy bread for the helper cat."
+        },
+        "delivery": {
+          "description": "Deliver the bread to the helper cat."
+        }
+      }
+    }
+  }
+```
+
+Scripts can interact with the quest system:
+
+- Start Quest: `start_quest breadShopping`
+- Start objective: `start_objective breadShopping delivery` (for hidden objectives)
+- Complete objective: `complete_objective breadShopping bread`
+- Complete quest: `complete_quest breadShopping`
+
+Example demo:
+
+```py
+quest_demo:
+  set_button shopButton true
+  set_button parkButton false
+  jump bread_quest
+
+bread_quest:
+  choice:
+    talk helper idle "Can you get 2 pieces of bread for me?"
+    "Yes":
+      talk helper idle "Thanks, that's very nice!"
+      talk helper idle "I'll be waiting for you at the park"
+      jump bread_start
+    "No":
+      talk helper idle "Oh, okay"
+      jump quest_demo
+
+bread_start:
+  start_quest breadShopping
+  talk inner idle "Time to go to the shop to buy some bread then."
+  set_screen map
+  set_button shopButton true
+
+shopButton:
+  set_screen default
+  "You visit the bread shop"
+  talk shopkeeper idle "Hello, I'm a little baker selling bread!"
+  set data.breadPrice 5
+  jump shop_menu
+
+parkButton:
+  choice:
+    talk helper idle "Ah, so do you have my bread?"
+    "Yes!" $if this.items.bread.amount >= 2:
+      talk helper idle "Thanks a lot!"
+      complete_objective breadShopping delivery
+      complete_quest breadShopping
+    "No :(":
+      talk helper idle "Oh okay"
+  set_button parkButton false
+
+shop_menu:
+  choice:
+    talk shopkeeper idle "So, do you want some bread?"
+    "Buy bread (costs %{data.breadPrice})" $if this.stats.money.value >= this.data.breadPrice:
+      add_item bread 1
+      $if this.data.breadPrice === 5:
+        add_stat money -5
+      else:
+        add_stat money -4
+      jump map_update
+    roll bread_haggle haggling 50 "Try to haggle for bread" hideAfterRoll:
+      success "You explain that helper cat needs bread to feed his poor family":
+        set data.breadPrice 4
+        talk shopkeeper idle "I guess I can sell you bread for 4 coins"
+        jump shop_menu
+      failure "You try to pity trip the shopkeeper but he won't bulge":
+        talk shopkeeper idle "The price is 5 coins, nothing less, nothing more."
+        jump shop_menu
+    "Exit":
+      jump map_update
+
+map_update:
+  $if this.items.bread.amount >= 2:
+    complete_objective breadShopping bread
+    talk inner idle "I've got enough bread now, I'm going to go to the park."
+    start_objective breadShopping delivery
+    set_screen map
+    set_button parkButton true
+    set_button shopButton false
+  else:
+    talk inner idle "Hmm, I still need to buy more bread for helper cat."
+    set_screen map
+```
+
+## 1.1.0
+
+### Inventory system
+
+There is a new inventory system.
+
+Possible items can be defined in the config:
+
+```json
+  "items": {
+    "bread": {
+      "name": "Bread",
+      "description": "A bread in the game.",
+      "icon": "img/items/bread.png"
+    }
+  }
+```
+
+Then items can be added/removed in scripts:
+
+```py
+main:
+  add_item bread 15
+  remove_item bread 10
+  $if this.items.bread.amount > 0:
+    talk helper idle "You have %{items.bread.amount} bread"
+  else:
+    talk helper idle "You have no bread"
+```
+
+## 1.0.0
+
+### State management rewrite
+
+Rewrote the state management of the engine using [pinia](https://pinia.vuejs.org/) instead of Vuex for state management.
+
+This allows the state to be more modular, easy to use and better compatible with Vue.js devtools for development of the engine, as pinia is now the official vue state management library.
+
+The version has been bumped to 1.0.0 as it's a major rewrite. No bugs have been found when testing though.
+
+### Save files breaking change
+
+The save file format has changed, so saved games from previous versions would break. As no one is using this engine in production for now, this isn't an issue.
+
+A new `version` string has been added to save files, so that in the future it will be possible to add migrations from older save files to newer ones if needed
+
+## Updated Vue version
+
+The Vue dependency version has been updated to the current latest (3.2.37)
+
+## Vuex peer dependency deleted
+
+Vuex is no longer a peer dependency, and has been replaced with pinia.
+
+## 0.11.1
+
+Fixed an error in how the narrat packaged is exported
+
+## 0.11.0
+
+### New Plugin system!
+
+There is now a plugin system developers can use to add new functionality to narrat (more documentation soon). See the [narrat-bitsy](https://github.com/liana-pigeot/narrat-bitsy) plugin for an example.
+
+## 0.10.0
+
+### New XP System
+
+- XP can be accumulated to level
+- config option: `skillOptions.xpPerLevel`
+- Use `add_xp` in script tso add xp, just like adding levels
+- XP now displayed in skills menu
+
+### Other improvements
+
+- Improvements in skill checks display and difficulty
+- Bug fixes to skill check edge cases
+- Fixed a bug when not having a default title screen music
+- Added a new `hideAfterRoll` option to skill checks to hide their choice after they've happened once
+- Refactored skill check code for internal consistency between the different ways they're run
+- New CSS variables and classes to customise the look of skill check prompts
+
+## 0.9.4
+
+- Fixed a bug when going back to the main menu and reloading the save without refreshing the page
+- New `defaultMusic` option in audio options for title screen music
+
+## 0.9.3
+
+- Fixed a bug when loading a saved game
+
+## 0.9.2
+
+- Added new CSS variables and id/classes to make it easier to theme games
+
+Current CSS variables list (Look at [main.css](https://github.com/liana-pigeot/narrat/blob/main/src/sass/main.css) in the narrat repo for up to date version):
+
+```css
+:root {
+  --bg-color: #131720;
+  --text-color: #d9e1f2;
+  --primary: hsl(255, 30%, 55%);
+  --focus: hsl(210, 90%, 50%);
+  --secondary: #42b983;
+  --border-color: hsla(0, 0%, 100%, 0.2);
+  --light-1: hsl(210, 30%, 40%);
+  --light-2: hsl(255, 30%, 50%);
+  --light-background: linear-gradient(to right, var(--light-1), var(--light-2));
+  --shadow-1: hsla(236, 50%, 50%, 0.3);
+  --shadow-2: hsla(236, 50%, 50%, 0.4);
+  --hud-background: rgba(0, 0, 0, 0.4);
+  --hud-text-color: var(--text-color);
+  --notifications-bg: darkslateblue;
+
+  --skills-text-background: rgba(0, 0, 0, 0.5);
+  --skills-text-color: var(--text-color);
+  --skills-level-background: rgba(0, 0, 0, 0.5);
+  --skills-level-color: orange;
+}
+```
+
+Can be edited in a game's CSS file by overriding those variables in a more specific selector. For example:
+
+```css
+#app {
+  --bg-color: white;
+  --text-color: black;
+}
+```
+
+would override the background and text colors of the game
+
+## 0.9.1
+
+- Fixed a file capitalisation error in 0.9.0
+
+## 0.9.0
+
+### Breaking Changes
+
+New config options for skills:
+
+- `icon`: Path to the image to use for the skill's icon (currently the skill widget is 200x300, but you can override the CSS if needed)
+- `hidden`: Optional boolean to make the skill hidden until it is "obtained". A skill that is configured to be hidden will only start appearing in the skills menu once it's above level 0
+
+Example skills config:
+
+```json
+  "skills": {
+    "agility": {
+      "name": "Agility",
+      "description": "How good you are at moving around.",
+      "startingLevel": 0,
+      "icon": "img/skills/agility.jpg",
+      "hidden": true
+    },
+    "logic": {
+      "name": "Logic",
+      "description": "How good you are at solving problems",
+      "icon": "img/skills/logic.jpg",
+      "startingLevel": 0
+    }
+  },
+```
+
+### Bug Fixes
+
+- Music could play multiple times at once when replaying the same music
+
+### New Features and improvements
+
+#### Development and debug
+
+- Improved debug menu with a **variable editor** to view and edit values in the `data` object.
+- Also added a separate editor for the entire engine/app state. Can be useful for debugging complex bugs by exploring the state of the app.
+- New **Quick label jump** feature to easily jump to specific labels for testing. Press **J** to open and type the name of a label then select a result with up/down arrows and press Enter
+- New keyboard shortcut to open debug menu (**d**)
+- Added a debug info panel on the main starting screen of the game with info on the shortcuts
+
+#### Engine improvements
+
+- Menu modal improved to be more compact with a cleaner design
+- Added fade in and fade outs when changing music (configurable in config)
+- **Improved the default UI** to be more pleasing to look at
+- Added a **return to Main Menu** button to the main menu for resetting the game
+- New **Skills Menu** allowing players to view their skills:
+  - It only appears if the game has skills configured
+  - It shows skill icons, name and current level on a grid
+  - Clicking on a skill opens a skill page with more detailed info and the skill description
+  - The skill menu button is next to the usual menu button
+
+## 0.8.5
+
+- Fixed a bug with `clear_dialog` that was disabling all interaction upon use
+
+## 0.8.4
+
+- Fixed many issues with save being broken (it didn't properly save the name of the last label the player was on, effectively restarting the game from scratch every time)
+- Added new things to the save function so their state gets reloaded properly on game launch:
+  - Current music now gets saved and restarts when reloading the game, if any is active
+  - Stats (the ones in the HUD) now get saved
+  - Current screen is also saved
+- Removed many useless spammy `console.log` and added a `Logger` in the code so that most logs (outside of errors/important logs) will only appear in debug mode.
+
+## 0.8.3
+
+- Fixed bug where menu button would move up as more text gets added to the game
+
+## 0.8.2
+
+- Added css to hide scrollbars in the game UI
+- Added a new Menu button with the options to quit and change volume
+- Removed volume slider from the HUD and moved it to the new menu
+
+## 0.8.1
+
+- Fixed a bug in accessing values inside conditions caused by changed in 0.7.2
+
+## 0.8.0
+
+- Changed the `set` method to access things without caps (`data`, `skills`, `buttons` instead of `DATA`, `SKILLS`, `BUTTONS`) for consistency.
+- Changed string interpolation to have more accessible objects, now values in `data` need to be accessed with `%{data.something}` instead of just `%{something}`
+- Now possible to access skill levels in string interpolation with `%{skills.someSkill.level}`
+- Improvements to how skill checks are printed to be less awkward
+
+## 0.7.1
+
+- Added `stop` and `pause` functions which work similarly to play for stopping or pausing audio.
+
+## 0.6.5
+
+- Audio and music options from the config now get passed to howler
+- Renamed `path` to `src` in audio config (to be consistent with howler)
+
+## 0.6.0
+
+Added stats feature for tracking numbers and displaying them in the hud
+
+Example config:
+
+```
+  "hudStats": {
+    "money": {
+      "icon": "img/ui/money.png",
+      "name": "Money",
+      "startingValue": 0,
+      "minValue": 0
+    },
+    "energy": {
+      "icon": "img/ui/energy.png",
+      "name": "Energy",
+      "startingValue": 10,
+      "minValue": 0,
+      "maxValue": 10
+    }
+  }
+```
+
+## 0.5.4
+
+- Improved responsive layout and fixed some issues in it
+
+New config keys required in the layout part of the config (to be documented):
+
+```
+  "layout": {
+    "backgrounds": {
+      "width": 880,
+      "height": 720
+    },
+    "dialogBottomPadding": 70,
+    "minTextWidth": 475,
+    "mobileDialogHeightPercentage": 60,
+    "verticalLayoutThreshold": 1000,
+    "portraits": {
+      "width": 100,
+      "height": 100
+    }
+  },
+```
+
+## 0.4.0
+
+Added responsive layout for mobile and small screens. Still in progress, but functionnal enough to be better than before so I'm releasing it.
+
+## 0.3.4
+
+- Improved string templating to work with deep nesting and also inside choice text
+
+## 0.3.3
+
+- Now detects indentation size and can support any indentation size
+
+## 0.3.2
+
+- Added a new `add_level` function for increasing the level of a skill. Example: `add_level someSkill 1` will increase the player's level in `someSkill` by 1
+- Added a new `notify` function for displaying a notification toast that disappears after a few seconds (duration configurable in `config.json`). Example: `notify "Hello, this is a notification"`.
+
+## 0.3.1
+
+Added new config options for controlling how skill rolls are done and the display of their difficulty
+
+## 0.3.0
+
+Breaking changes around renaming data access from scripts
+
+### New Add Command
+
+New `add` command, works the same way as `set` but increments the value based on the existing value, ie. `set SKILLS.someSkill.level 2` will increment `someSkill.level` by 2.
+
+### Skills
+
+- Now possible to set the starting value of a skill (in the config)
+- Now possible to edit a skill's value with `set SKILLS.someSkill.level 2` for example
+- Skillcheck command renamed to roll (`if this.roll("someSkillCheck", "testSkill", 40);`)
+
+### General
+
+The `set` and `$if` command now refer to data in caps and have access to more data:
+
+- `set SKILLS.someSkill.level [value]` Sets the value of a skill
+- `set DATA.someData [value]` Sets a value in the data object (data is for any game-created variables)
+- `$if this.SKILLCHECKS.someSkillCheck.passed` now available for checking if a skillcheck has already been passed
+
+## 0.0.14
+
+- Added the changelog (manually made for now)
+
+## 0.0.13
+
+- Added debug menu for jumping to labels (currently doesn't support production builds disabling it)
+- Added saving and loading of the game (works by storing data, skills, skillchecks etc. When the game is reloaded, it is brought back at the last label visited)
+- Fixed a bug where conditional choices would play the wrong result if a choice is removed due to a condition
+- Made script loading and compilation happen during the initial loading, so everything is ready to play when pressing start game
+- Skill checks now also save and load their data, so a failed check becomes impossible to choose, and a succeeded skill check can be skipped if shown again