isaacscript 2.0.7 → 2.0.10

package/dist/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "isaacscript",
+    "version": "2.0.10",
+    "description": "A command line tool for managing Isaac mods written in TypeScript",
+    "homepage": "https://isaacscript.github.io/",
+    "bugs": {
+        "url": "https://github.com/IsaacScript/isaacscript/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/IsaacScript/isaacscript.git"
+    },
+    "license": "GPL-3.0",
+    "author": "Zamiell",
+    "bin": {
+        "isaacscript": "./dist/src/main.js"
+    },
+    "files": [
+        "dist/**/*.js",
+        "dist/**/*.d.ts",
+        "dist/**/*.json",
+        "isaacscript-watcher/**"
+    ],
+    "dependencies": {
+        "@types/node": "^17.0.35",
+        "chalk": "4.1.2",
+        "command-exists": "^1.2.9",
+        "dotenv": "^16.0.1",
+        "figlet": "^1.5.2",
+        "fs-extra": "^10.1.0",
+        "isaacscript-tsconfig": "^1.1.16",
+        "jsonc-parser": "^3.0.0",
+        "moment": "^2.29.3",
+        "npm-check-updates": "^13.0.1",
+        "prompt": "^1.3.0",
+        "source-map": "^0.7.3",
+        "source-map-support": "^0.5.21",
+        "sync-directory": "^5.0.8",
+        "ts-node": "^10.7.0",
+        "typescript": "^4.6.4",
+        "typescript-to-lua": "^1.4.4",
+        "update-notifier": "^5.1.0",
+        "yaml": "^2.1.0",
+        "yargs": "^17.5.1"
+    },
+    "devDependencies": {
+        "@types/command-exists": "^1.2.0",
+        "@types/figlet": "^1.5.4",
+        "@types/fs-extra": "^9.0.13",
+        "@types/prompt": "^1.1.2",
+        "@types/source-map-support": "^0.5.4",
+        "@types/update-notifier": "^5.1.0",
+        "@types/yargs": "^17.0.10",
+        "isaacscript-lint": "^1.0.159",
+        "isaacscript-spell": "^1.0.3"
+    }
+}

package/dist/src/commands/monitor/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COMPILATION_SUCCESSFUL = void 0;
+exports.COMPILATION_SUCCESSFUL = "Compilation successful.";
+//# sourceMappingURL=constants.js.map

package/dist/src/commands/monitor/monitor.js

@@ -34,10 +34,12 @@ const path_1 = __importDefault(require("path"));
 const constants_1 = require("../../constants");
 const file = __importStar(require("../../file"));
 const utils_1 = require("../../utils");
+const constants_2 = require("./constants");
 const copyWatcherMod_1 = require("./copyWatcherMod");
 const notifyGame = __importStar(require("./notifyGame"));
 const spawnSaveDatWriter_1 = require("./spawnSaveDatWriter");
 const touchWatcherSaveDatFiles_1 = require("./touchWatcherSaveDatFiles");
+let compilationStartTime = new Date();
 function monitor(argv, config) {
     const verbose = argv["verbose"] === true;
     // If they specified some command-line flags, override the values found in the config file.
@@ -115,11 +117,15 @@ function spawnTSTLWatcher() {
             notifyGame.msg(newMsg);
         }
         else if (msg.includes("File change detected. Starting incremental compilation...")) {
+            compilationStartTime = new Date();
             const newMsg = "TypeScript change detected. Compiling...";
             notifyGame.msg(newMsg);
         }
         else if (msg.includes("Found 0 errors. Watching for file changes.")) {
-            const newMsg = "Compilation successful.";
+            const compilationFinishTime = new Date();
+            const elapsedTimeMilliseconds = compilationFinishTime.getTime() - compilationStartTime.getTime();
+            const elapsedTimeSeconds = elapsedTimeMilliseconds / 1000;
+            const newMsg = `${constants_2.COMPILATION_SUCCESSFUL} (in ${elapsedTimeSeconds} seconds)`;
             notifyGame.msg(newMsg);
         }
         else {

package/dist/src/commands/monitor/notifyGame.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ping = exports.command = exports.msg = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const utils_1 = require("../../utils");
+const constants_1 = require("./constants");
 const spawnSaveDatWriter_1 = require("./spawnSaveDatWriter");
 function msg(data) {
     const formattedData = data
@@ -34,7 +35,7 @@ function msg(data) {
 exports.msg = msg;
 function printMsgToStandardOut(data) {
     let coloredData = data;
-    if (data.match(/Compilation successful./g) !== null) {
+    if (data.includes(constants_1.COMPILATION_SUCCESSFUL) !== null) {
         coloredData = chalk_1.default.green(data);
     }
     else if (data.match(/error/g) !== null) {

package/isaacscript-watcher/.luacheckrc

@@ -0,0 +1,96 @@
+-- These are all of the declarations in the "enums.lua" file in the "scripts" subdirectory,
+-- sorted alphabetically
+globals = {
+  "ActionTriggers",
+  "BabySubType",
+  "BombSubType",
+  "BombVariant",
+  "ButtonAction",
+  "CacheFlag",
+  "Card",
+  "Challenge",
+  "ChestSubType",
+  "CoinSubType",
+  "CollectibleType",
+  "Color",
+  "DamageFlag",
+  "Difficulty",
+  "Direction",
+  "DoorSlot",
+  "DoorState",
+  "DoorVariant",
+  "EffectVariant",
+  "EntityCollisionClass",
+  "EntityFlag",
+  "EntityGridCollisionClass",
+  "EntityPartition",
+  "EntityPtr",
+  "EntityRef",
+  "EntityType",
+  "FamiliarVariant",
+  "Font",
+  "Game",
+  "GameStateFlag",
+  "GetPtrHash",
+  "GridCollisionClass",
+  "GridEntityType",
+  "GridRooms",
+  "HeartSubType",
+  "Input",
+  "InputHook",
+  "Isaac",
+  "ItemConfig",
+  "ItemPoolType",
+  "ItemType",
+  "KColor",
+  "Keyboard",
+  "KeySubType",
+  "LaserOffset",
+  "LevelCurse",
+  "LevelStage",
+  "LevelStateFlag",
+  "LocustSubtypes",
+  "ModCallbacks",
+  "Mouse",
+  "Music",
+  "MusicManager",
+  "NpcState",
+  "NullItemID",
+  "PickupPrice",
+  "PickupVariant",
+  "PillColor",
+  "PillEffect",
+  "PlayerForm",
+  "PlayerItemState",
+  "PlayerSpriteLayer",
+  "PlayerType",
+  "ProjectileFlags",
+  "ProjectileParams",
+  "ProjectileVariant",
+  "Random",
+  "RandomVector",
+  "RegisterMod",
+  "RNG",
+  "RoomShape",
+  "RoomType",
+  "SeedEffect",
+  "SFXManager",
+  "SortingLayer",
+  "SoundEffect",
+  "Sprite",
+  "StageType",
+  "TearFlags",
+  "TearVariant",
+  "TrinketType",
+  "Vector",
+  "WeaponType",
+
+  -- Global variables
+  "ModConfigMenu",
+}
+
+max_line_length = 100
+
+-- Luacheck complains about functions in a module declared with a colon if self is unused;
+-- we may want all functions to be declared with a colon for uniformity
+unused_args = false

package/isaacscript-watcher/README.md

@@ -0,0 +1,8 @@
+# isaacscript-watcher
+
+`isaacscript-watcher` is a Lua mod that listens for messages from `IsaacScript`.
+
+It can:
+
+- print messages to the screen
+- execute console commands

package/isaacscript-watcher/main.lua

@@ -0,0 +1,270 @@
+-- Includes
+local json = require("json")
+
+-- Constants
+local MOD_NAME = "isaacscript-watcher"
+local RESTART_GAME_ON_RECOMPILATION = true
+local FRAMES_BEFORE_DISCONNECTED = 2 * 60 -- 2 seconds
+local FRAMES_BEFORE_TEXT_FADE = 2 * 60 -- 2 seconds
+local SPRITE_BOTTOM_RIGHT_OFFSET = Vector(-35, -60)
+-- (enough so that it does not overlap with a pocket active + 2 pocket items)
+
+-- Mod variables
+local saveData = {} -- An array of message objects.
+local restartFrame = 0
+local messageArray = {}
+local frameOfLastMsg = 0
+local frameOfLastSuccessfulLoad = 0
+local game = Game()
+local font = Font()
+font:Load("font/pftempestasevencondensed.fnt") -- A vanilla font good for this kind of text.
+local connected = false
+local sprite = nil
+
+local IsaacScriptWatcher = RegisterMod("IsaacScript Watcher", 1)
+
+-- On mod initialization, nuke the "save#.dat" folder to get rid of old messages that might be left
+-- there from IsaacScript.
+IsaacScriptWatcher:SaveData("")
+
+local function pushMessageArray(msg)
+  frameOfLastMsg = Isaac.GetFrameCount()
+
+  messageArray[#messageArray + 1] = msg
+  if #messageArray > 10 then
+    -- We only want to show 10 messages at a time.
+    table.remove(messageArray, 1)
+  end
+end
+
+local function getScreenBottomRightPos()
+  local screenWidth = Isaac.GetScreenWidth();
+  local screenHeight = Isaac.GetScreenHeight();
+
+  return Vector(screenWidth, screenHeight)
+end
+
+-- ModCallbacks.MC_POST_RENDER (2)
+function IsaacScriptWatcher:PostRender()
+  -- Don't do anything while fading in to a new run to prevent crashes.
+  if game:GetFrameCount() < 1 then
+    return
+  end
+
+  IsaacScriptWatcher:RenderSprite()
+  IsaacScriptWatcher:RenderText()
+  IsaacScriptWatcher:LoadSaveDat()
+  IsaacScriptWatcher:CheckInput()
+  IsaacScriptWatcher:CheckRestart()
+end
+
+function IsaacScriptWatcher:RenderSprite()
+  -- Determine if IsaacScript is connected or not.
+  local frameCount = Isaac.GetFrameCount()
+  connected = frameCount - frameOfLastSuccessfulLoad <= FRAMES_BEFORE_DISCONNECTED
+
+  -- Set the sprite
+  if connected then
+    if sprite == nil then
+      sprite = Sprite()
+      sprite:Load("gfx/logo.anm2", true)
+      sprite:SetFrame("Default", 0)
+    end
+  else
+    if sprite ~= nil then
+      sprite = nil
+    end
+  end
+
+  -- Render it
+  if sprite ~= nil then
+    local bottomRightPos = getScreenBottomRightPos()
+    local position = bottomRightPos + SPRITE_BOTTOM_RIGHT_OFFSET
+    sprite:RenderLayer(0, position)
+  end
+end
+
+function IsaacScriptWatcher:RenderText()
+  -- Don't draw IsaacScript text when custom consoles are open.
+  if AwaitingTextInput then
+    return
+  end
+
+  if frameOfLastMsg == 0 then
+    return
+  end
+
+  if game:IsPaused() then
+    return
+  end
+
+  if ModConfigMenu ~= nil then
+    if ModConfigMenu.IsVisible then
+      return
+    end
+  end
+
+  -- Local variables
+  local x = 60
+  local y = 90
+  local scale = 1
+  local lineHeight = font:GetLineHeight() * scale
+
+  -- The text will slowly fade out.
+  local elapsedFrames = Isaac.GetFrameCount() - frameOfLastMsg
+  local alpha
+  if elapsedFrames <= FRAMES_BEFORE_TEXT_FADE then
+    alpha = 1
+  else
+    local fadeFrames = elapsedFrames - FRAMES_BEFORE_TEXT_FADE
+    alpha = 1 - (0.02 * fadeFrames)
+  end
+  if alpha <= 0 then
+    frameOfLastMsg = 0
+    return
+  end
+
+  local white = KColor(1, 1, 1, alpha)
+  local red = KColor(1, 0, 0, alpha)
+  local green = KColor(0, 1, 0, alpha)
+
+  -- Go through each message.
+  for i, msg in ipairs(messageArray) do
+    local color = white
+
+    local hasSuccess = string.match(msg, "Compilation successful.")
+    if hasSuccess ~= nil then
+      color = green
+    end
+
+    local hasErrors = string.match(msg, "Found [0-9]+ errors.")
+    if hasErrors ~= nil then
+      color = red
+    end
+
+    font:DrawStringScaledUTF8(
+      msg,
+      x,
+      y + ((i - 1) * lineHeight),
+      scale,
+      scale,
+      color,
+      0,
+      true
+    )
+  end
+end
+
+function IsaacScriptWatcher:LoadSaveDat()
+  -- Local variables
+  local isaacFrameCount = Isaac.GetFrameCount()
+
+  -- Read the "save.dat" file every third second, since file reads are expensive.
+  if isaacFrameCount % 20 ~= 0 then
+    return
+  end
+
+  -- Check to see if there a "save.dat" file for this save slot.
+  if not Isaac.HasModData(IsaacScriptWatcher) then
+    IsaacScriptWatcher:ClearSaveDat()
+    return
+  end
+
+  -- The server will write JSON data for us to the "save#.dat" file in the mod subdirectory.
+  if not pcall(IsaacScriptWatcher.Load) then
+    -- Sometimes loading can fail if the file is currently being being written to, so give up for
+    -- now and try again on the next interval.
+    Isaac.DebugString(
+      MOD_NAME
+      .. " - Failed to load the TypeScript Watcher \"save.dat\" on frame: "
+      .. tostring(isaacFrameCount)
+    )
+    return
+  end
+
+  if #saveData > 0 then
+    local saveDatContents = saveData
+    IsaacScriptWatcher:ClearSaveDat()
+    IsaacScriptWatcher:LoadSuccessful(saveDatContents)
+  end
+end
+
+function IsaacScriptWatcher:LoadSuccessful(saveDatContents)
+  frameOfLastSuccessfulLoad = Isaac.GetFrameCount()
+
+  for _, entry in ipairs(saveDatContents) do
+    -- Entry is e.g. { type: "command", data: "luamod revelations" }
+    if entry.type == "command" then
+      if entry.data == "restart" then
+        -- If we restart on the first frame that a run is loading, then the game can crash.
+        restartFrame = Isaac.GetFrameCount() + 1
+      else
+        Isaac.DebugString(MOD_NAME .. " - Executing command: " .. entry.data)
+        Isaac.ExecuteCommand(entry.data)
+      end
+    elseif entry.type == "msg" then
+      Isaac.DebugString(MOD_NAME .. " - " .. entry.data)
+      pushMessageArray(entry.data)
+    end
+  end
+end
+
+function IsaacScriptWatcher:ClearSaveDat()
+  saveData = {}
+  IsaacScriptWatcher:Save()
+end
+
+function IsaacScriptWatcher:Save()
+  local saveDataJSON = json.encode(saveData)
+  IsaacScriptWatcher:SaveData(saveDataJSON)
+end
+
+function IsaacScriptWatcher:Load()
+  -- Read the "save#.dat" file into a string.
+  local saveDataJSON = Isaac.LoadModData(IsaacScriptWatcher)
+
+  -- Handle the case of a 0 byte file.
+  if saveDataJSON == "" then
+    saveDataJSON = "{}"
+  end
+
+  -- Convert a JSON string to a Lua table.
+  saveData = json.decode(saveDataJSON)
+end
+
+function IsaacScriptWatcher:CheckInput()
+  if game:IsPaused() then
+    return
+  end
+
+  -- Ensure that this feature does not overlap with custom consoles by checking for the
+  -- "AwaitingTextInput" global variable.
+  if AwaitingTextInput then
+    return
+  end
+
+  -- Manually show the log when the user presses the "I" key on the keyboard.
+  if Input.IsButtonPressed(Keyboard.KEY_I, 0) then
+    frameOfLastMsg = Isaac.GetFrameCount()
+  end
+end
+
+function IsaacScriptWatcher:CheckRestart()
+  if not RESTART_GAME_ON_RECOMPILATION then
+    return
+  end
+
+  if restartFrame == 0 or restartFrame < Isaac.GetFrameCount() then
+    return
+  end
+  restartFrame = 0
+
+  Isaac.DebugString(MOD_NAME .. " - Restarting the run.")
+  Isaac.ExecuteCommand("restart")
+end
+
+IsaacScriptWatcher:AddCallback(ModCallbacks.MC_POST_RENDER, IsaacScriptWatcher.PostRender)
+
+local initMessage = "IsaacScript Watcher initialized."
+Isaac.DebugString(initMessage)
+pushMessageArray(initMessage)

package/isaacscript-watcher/metadata.xml

@@ -0,0 +1,7 @@
+<metadata>
+  <name>IsaacScript Watcher</name>
+  <directory>isaacscript-watcher</directory>
+  <description />
+  <version>1.0</version>
+  <visibility />
+</metadata>

package/isaacscript-watcher/resources/gfx/logo.anm2

@@ -0,0 +1,27 @@
+<AnimatedActor>
+	<Info CreatedBy="Unknown" CreatedOn="2/1/2017 6:09:20 AM" Version="2" Fps="30"/>
+	<Content>
+		<Spritesheets>
+			<Spritesheet Path="logo.png" Id="0"/>
+		</Spritesheets>
+		<Layers>
+			<Layer Name="Layer 0" Id="0" SpritesheetId="0"/>
+		</Layers>
+		<Nulls/>
+		<Events/>
+	</Content>
+	<Animations DefaultAnimation="Default">
+		<Animation Name="Default" FrameNum="1" Loop="true">
+			<RootAnimation>
+				<Frame XPosition="0" YPosition="0" XScale="100" YScale="100" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
+			</RootAnimation>
+			<LayerAnimations>
+				<LayerAnimation LayerId="0" Visible="true">
+					<Frame XPosition="0" YPosition="0" XPivot="0" YPivot="0" XCrop="0" YCrop="0" Width="44" Height="28" XScale="66" YScale="66" Delay="1" Visible="true" RedTint="255" GreenTint="255" BlueTint="255" AlphaTint="255" RedOffset="0" GreenOffset="0" BlueOffset="0" Rotation="0" Interpolated="false"/>
+				</LayerAnimation>
+			</LayerAnimations>
+			<NullAnimations/>
+			<Triggers/>
+		</Animation>
+	</Animations>
+</AnimatedActor>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "2.0.7",
+  "version": "2.0.10",
   "description": "A command line tool for managing Isaac mods written in TypeScript",
   "homepage": "https://isaacscript.github.io/",
   "bugs": {
@@ -17,7 +17,9 @@
   },
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "dist/**/*.json",
+    "isaacscript-watcher/**"
   ],
   "dependencies": {
     "@types/node": "^17.0.35",
@@ -49,7 +51,7 @@
     "@types/source-map-support": "^0.5.4",
     "@types/update-notifier": "^5.1.0",
     "@types/yargs": "^17.0.10",
-    "isaacscript-lint": "^1.0.151",
+    "isaacscript-lint": "^1.0.159",
     "isaacscript-spell": "^1.0.3"
   }
 }