fxrjson 8.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,60 @@
+# FXR ⇄ JSON
+This is a small command line tool for converting FXR files from Dark Souls 3, Sekiro, Elden Ring, and Armored Core 6 to and from JSON using the [@cccode/fxr](https://www.npmjs.com/package/@cccode/fxr) library.
+
+It also includes an option to add a context menu command for .fxr and .json files when you right click them, and converting an effect to JSON and back can be used as a simple way to convert the effect to any of the four games as it allows you to choose what game to convert it back to.
+
+## Installation
+The tool is easier to use when it is globally installed, but also works when installed locally in a folder.
+
+### Global installation
+To install it globally, use this command:
+```
+npm i -g fxrjson
+```
+This allows you to use the tool directly from anywhere, like this:
+```
+fxrjson example.fxr
+```
+
+### Local installation
+To install it locally, use this command in the folder you want to install it to:
+```
+npm i fxrjson
+```
+Note that to run the local one you need to use the `npx` command in the folder it was installed to:
+```
+npx fxrjson example.fxr
+```
+
+## Usage
+There are two ways to use the tool: through commands, and through the right-click context menu in the file explorer.
+
+### Command line
+The command line tool takes a file name and optionally a game:
+```
+fxrjson <input file> [game]
+```
+The input file can be any .fxr file from any of the four supported games, or a .json file produced by this tool. The game can be one of: `ds3`, `DarkSouls3`, `sdt`, `Sekiro`, `er`, `EldenRing`, `ac6`, `ArmoredCore6`. The game is case-insensitive, which means that `DS3` and `ds3` works the same way.
+
+If a game is not specified, the tool will prompt you to pick one from a list.
+
+Some examples:
+```
+fxrjson f000000300.fxr
+fxrjson f000000300.fxr ds3
+fxrjson f000000300.fxr.json sekiro
+```
+
+### Context menu
+Registering the context menu command requires administrator privileges!
+
+To add the context menu command, open the Windows Terminal as admin and run this command:
+```
+fxrjson add-context-menu
+```
+After doing this, there should be a new "FXR ⇄ JSON" button in the context menu when right-clicking .fxr and .json files.
+
+If you want to remove the context menu command again, you can do so by running this command as admin:
+```
+fxrjson remove-context-menu
+```

package/fxrjson.js

@@ -0,0 +1,126 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { FXR, Game } from '@cccode/fxr'
+import beautify from 'json-beautify'
+import { fileURLToPath } from 'node:url'
+
+const CTX_MENU_NAME = 'FXR ⇄ JSON'
+
+const games = {
+  ds3: Game.DarkSouls3,
+  darksouls3: Game.DarkSouls3,
+  sdt: Game.Sekiro,
+  sekiro: Game.Sekiro,
+  er: Game.EldenRing,
+  eldenring: Game.EldenRing,
+  ac6: Game.ArmoredCore6,
+  armoredcore6: Game.ArmoredCore6,
+}
+
+async function addCommand(reg, ext) {
+  const icon = path.join(fileURLToPath(import.meta.url), '..', 'fxr.ico')
+  const toolCmd = process.argv.slice(0, 2).map(e => `"${e}"`).join(' ')
+  await reg.set(`\\${ext}\\shell\\${CTX_MENU_NAME}`, 'Icon', icon)
+  await reg.set(`\\${ext}\\shell\\${CTX_MENU_NAME}\\command`, '', `${toolCmd} "%1"`)
+}
+
+async function removeCommand(reg, ext) {
+  await reg.delete(`\\${ext}\\shell\\${CTX_MENU_NAME}`)
+}
+
+await (async () => {
+  try {
+    if (process.argv[2] === 'add-context-menu') {
+      const { Registry } = await import('rage-edit')
+      const reg = new Registry('HKEY_CLASSES_ROOT\\SystemFileAssociations')
+      await addCommand(reg, '.fxr')
+      await addCommand(reg, '.json')
+      return
+    }
+    if (process.argv[2] === 'remove-context-menu') {
+      const { Registry } = await import('rage-edit')
+      const reg = new Registry('HKEY_CLASSES_ROOT\\SystemFileAssociations')
+      await removeCommand(reg, '.fxr')
+      await removeCommand(reg, '.json')
+      return
+    }
+  } catch {
+    console.error('Something went wrong while editing the context menu command. Make sure that the command is run as an administrator.')
+    return
+  }
+
+  if (process.argv.length < 3) {
+    console.error('Please provide a file to convert.')
+    console.error('Syntax:')
+    console.error('> fxrjson <input file> [game]')
+    console.error('Examples:')
+    console.error('> fxrjson f000000300.fxr')
+    console.error('> fxrjson f000000300.fxr DS3')
+    console.error('> fxrjson f000000300.fxr.json ER')
+    console.error('')
+    console.error('To manage the context menu command, use one of these commands as admin:')
+    console.error('fxrjson add-context-menu')
+    console.error('fxrjson remove-context-menu')
+    process.exitCode = 1
+    return
+  }
+
+  const packagePath = path.join(fileURLToPath(import.meta.url), '..', 'node_modules', '@cccode', 'fxr', 'package.json')
+  const { name, version } = JSON.parse(await fs.readFile(packagePath))
+
+  let game = null
+
+  if (process.argv.length === 4) {
+    game = games[process.argv[3].toLowerCase()] ?? null
+    if (game === null) {
+      console.warn(`'${process.argv[3]}' is not a valid game.`)
+    }
+  }
+
+  if (game === null) try {
+    const cliSelect = (await import('cli-select')).default
+    console.log('What game is this for?')
+    const result = await cliSelect({
+      values: [
+        'Dark Souls III',
+        'Sekiro: Shadows Die Twice',
+        'Elden Ring',
+        'Armored Core VI Fires of Rubicon',
+      ],
+      defaultValue: 2,
+      indentation: 2,
+      unselected: '[ ]',
+      selected: '[✓]',
+    })
+    game = games[Game[result.id].toLowerCase()]
+    console.log(`Selected: ${result.value}`)
+  } catch {
+    console.log('Canceled.')
+    return
+  }
+
+  const filePath = process.argv[2]
+  const content = await fs.readFile(filePath)
+
+  if (content.subarray(0, 4).equals(Buffer.from('FXR\0'))) {
+    const fxr = FXR.read(content, game)
+    await fs.writeFile(filePath + '.json', beautify({
+      version: `${name}@${version}`,
+      fxr
+    }, null, 2, 80))
+  } else {
+    const json = JSON.parse(await fs.readFile(filePath, 'utf-8'))
+    if (json.version !== `${name}@${version}`) {
+      console.warn(
+        `${path.basename(filePath)} was deserialized by a different version of ${name}, ` +
+        `which means that this version might fail to serialize it. To ensure that it works ` +
+        `correctly, please serialize it with ${json.version} instead.`
+      )
+    }
+    const fxr = FXR.fromJSON(json.fxr)
+    await fxr.saveAs(filePath.replace(/(?:(?:\.fxr)?\.json)?$/, '.fxr'), game)
+  }
+
+})()

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "fxrjson",
+  "version": "8.1.0",
+  "description": "Convert FXR files from Dark Souls 3, Sekiro, Elden Ring, and Armored Core 6 to and from JSON.",
+  "type": "module",
+  "bin": "fxrjson.js",
+  "author": "CCCode",
+  "license": "Unlicense",
+  "keywords": [
+    "json",
+    "souls",
+    "modding"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EvenTorset/fxrjson.git"
+  },
+  "bugs": {
+    "url": "https://github.com/EvenTorset/fxrjson/issues"
+  },
+  "dependencies": {
+    "@cccode/fxr": "^8.1.0",
+    "cli-select": "^1.1.2",
+    "json-beautify": "^1.1.1",
+    "rage-edit": "^1.2.0"
+  }
+}