nightrunner_lib 0.4.0

A parser library for making text adventure games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# React Typescript Wasm Example

A React example using the wasm npm package for nightrunner-lib.

Like the vanilla typescript example, this example uses the [`Vite`](https://vitejs.dev) bundler along with the [`vite-plugin-wasm`](https://github.com/Menci/vite-plugin-wasm?tab=readme-ov-file#usage).

This example contains the configurations necessary to use the `vite-plugin-wasm` plugin with `vite`, and add
`nightrunner-lib` to your project.

Here you will see more advanced usage of the `nightrunner-lib` library, along with some ideas on how to best
parse the data returned from the library.

Steps to reproduce this example:

1. Install `vite` and `vite-plugin-wasm`
2. Create a new typescript project to use `nightrunner-lib` with `npm create vite@latest my-app -- --template react-ts`
3. Install `nightrunner-lib` in your project:
   1. From npm: `npm i @nightrunner/nightrunner_lib`
   2. From local folder: add `"nightrunner_lib": "./path/to/lib` to your package.json, under dependencies, and run `npm install` inside the project folder
4. Install the `"vite-plugin-wasm` package: `npm install --save-dev vite-plugin-wasm`
5. Add the `vite-plugin-wasm` plugin to your `vite.config.ts` file:
   ```ts
    import { defineConfig } from 'vite'
    import react from '@vitejs/plugin-react'
    import wasm from 'vite-plugin-wasm';

    export default defineConfig({
    plugins: [react(), wasm()]
    })
   ```
6. Import the library in your entry file: `import {NightRunner} from '@nightrunner/nightrunner_lib';`
7. Pass a data object to the NighRunner constructor and start calling the parse function with actions for parsing:
   ```ts
     const nightrunner = new NightRunner(data);
     let result = nightrunner.parse("look");
   ```
8. Run the example: `npm run dev`