narrat 1.3.2 → 1.3.3

package/CHANGELOG.md

@@ -1,541 +0,0 @@
-# Narrat changelog
-
-## 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",
-        "label": "read_book"
-      },
-      "tag": "always_interactable"
-    }
-  },
-  "interactionTags": {
-    "default": {
-      "onlyInteractOutsideOfScripts": true
-    }
-  }
-```
-
-The `onUse` `action` property can be either `jump` or `run_label`, 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_label`, 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_label` function to run a label as a "function"
-
-The difference between this and jump is that using `run_label` 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_label some_function
-  talk player idle "Back to functions_test"
-  run_label 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

package/lib/lib.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="@/types/character-types" />
-/// <reference types="@/types/config" />
-/// <reference types="@/types/dialog-box-types" />
-/// <reference types="@/types/parser" />
-/// <reference types="@/types/vuex" />
-export declare const lib: {};

package/lib/renpy/command-parser-functions.d.ts

@@ -1,14 +0,0 @@
-import { ParserContext } from './renpy-parser';
-export declare type CommandParserFunction = (ctx: CommandParsingContext) => void;
-export declare type ProcessCommandsFunction = (ctx: ParserContext, lines: Parser.Line[], parentLine: Parser.Line | undefined) => Parser.Branch;
-export interface CommandParsingContext {
-    parserContext: ParserContext;
-    processCommandsFunction: ProcessCommandsFunction;
-    line: Parser.Line;
-    command: Partial<Parser.Command>;
-    lines: Parser.Line[];
-    currentLine: number;
-}
-export declare const parserFunctions: {
-    [key: string]: CommandParserFunction;
-};

package/lib/renpy/renpy-helpers.d.ts

@@ -1,14 +0,0 @@
-import { State } from 'vue';
-import { ActionContext } from 'vuex';
-export declare function processSkillCheck(ctx: ActionContext<State, State>, skillcheck: Parser.SkillCheckOptions): boolean;
-export interface SkillCheckParams {
-    skill: string;
-    value: number;
-    id: string;
-    success?: string;
-    failure?: string;
-}
-export declare function runSkillCheck(ctx: ActionContext<State, State>, params: SkillCheckParams): boolean;
-export declare function runConditionCommand(ctx: ActionContext<State, State>, command: Parser.Command): Parser.Branch | undefined;
-export declare function writeText(ctx: ActionContext<State, State>, text: string): void;
-export declare function runCondition(ctx: ActionContext<State, State>, condition: string): boolean;

package/lib/renpy/renpy-parser.d.ts

@@ -1,9 +0,0 @@
-import { ProcessCommandsFunction } from './command-parser-functions';
-export declare type ParserErrorHandler = (ctx: ParserContext, line: number, text: string) => void;
-export interface ParserContext {
-    fileName: string;
-    error: (line: number, text: string) => void;
-    processCommandsFunction: ProcessCommandsFunction;
-    indentSize: number;
-}
-export declare function parseRenpyScript(errorHandler: ParserErrorHandler, code: string, fileName: string): Parser.ParsedScript;

package/lib/store.d.ts

@@ -1,12 +0,0 @@
-import { InjectionKey, State } from 'vue';
-import { Store } from 'vuex';
-import { DialogKey, MachineStack } from './types/vuex';
-import { AppOptions } from '.';
-export declare type AddDialogParams = Omit<DialogKey, 'id'>;
-export interface SetupStoreResult {
-    store: Store<State>;
-    key: InjectionKey<Store<State>>;
-}
-export declare type AddStackOptions = Partial<MachineStack>;
-export declare function setupStore(options: AppOptions): SetupStoreResult;
-export declare function useStore(): Store<State>;

package/lib/vm/commands/add_item.d.ts

@@ -1,2 +0,0 @@
-import { CommandPlugin } from './command-plugin';
-export declare const addItemPlugin: CommandPlugin;

package/lib/vm/commands/remove_item.d.ts

@@ -1,2 +0,0 @@
-import { CommandPlugin } from './command-plugin';
-export declare const removeItemPlugin: CommandPlugin;

package/lib/vm/renpy-vm.d.ts

@@ -1,11 +0,0 @@
-import { ActionContext, Commit } from 'vuex';
-import { State } from 'vue';
-import { DialogChoice } from '@/types/vuex';
-import { AddDialogParams } from '@/store';
-export declare function runLine(context: ActionContext<State, State>): Promise<void>;
-export declare function runCommand(context: ActionContext<State, State>, cmd: Parser.Command, choices?: DialogChoice[]): Promise<any>;
-export declare function playerAnswered(context: ActionContext<State, State>, choiceIndex: number): Promise<void>;
-export declare function runChoice(context: ActionContext<State, State>, cmd: Parser.Command): Promise<void>;
-export declare function textCommand(commit: Commit, dialog: AddDialogParams): Promise<void>;
-export declare function nextLine(ctx: ActionContext<State, State>): Promise<any>;
-export declare function finishGame({ commit, state }: ActionContext<State, State>): void;