stardew-event-scripter
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

stardew event scripter

A javascript library to let you make Stardew Valley events in javascript.

installation

  1. Get nodejs and NPM.
  2. npm install stardew-event-scripter

usage

At least some basic JS/TS knowledge is expected

  1. An IDE supporting intellisense is recommended, such as Visual Studio Code.

  2. You have 3 options to import it:

    1.  const { StardewEventScripter } = require('stardew-event-scripter')
      
       const event = new StardewEventScripter( ... )
    2.  const StardewEventScripter = require('stardew-event-scripter').StardewEventScripter
      
       const event = new StardewEventScripter( ... )
    3.  const StardewEventScripter = require('stardew-event-scripter')
      
       const event = new StardewEventScripter.StardewEventScripter( ... )
  3. The constructor has 4 arguments,

   eventId: number,
   musicId: 'none' | string,
   cameraXY: [number, number],
   starting_characters: {
       name: string,
       x: number,
       y: number,
       facing: number
   }[]
  1. All precondictions are found under StardewEventScripter#preconditions, and all commands under StardewEventScripter#preconditions.

  2. If you need an example, Clint's 3 heart event can be found in test.ts

Readme

Keywords

none

Package Sidebar

Install

npm i stardew-event-scripter

Weekly Downloads

0

Version

1.0.7

License

MIT

Unpacked Size

101 kB

Total Files

8

Last publish

Collaborators

  • anotherpillow