Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 5.42 KB

README.md

File metadata and controls

96 lines (66 loc) · 5.42 KB
Raw

Testing Package

Cyberpunk 2077 Support for Vortex Mod Manager

Installation

Install from the page on Nexus

Manual Installation (e.g. for a development version)

Prerequisite: You need either a packaged release from Nexus or Github, or you can build manually (see developer info below)

Then, in Vortex:

  1. Go to the 'Extensions' tab
  2. Find the Cyberpunk 2077 extension in the list
  3. Click on the 'Remove' button on the right side to uninstall it completely. (The button could be covered up by an info pane that pops out of the 4. right hand side. You can make that go away by double clicking on any entry in the list). This will NOT remove your game, mods, or profiles.
  4. Vortex will want to be restarted, so go ahead and do that.
  5. Now you will see that Cyberpunk does not show up as a game at all (but it's still there, don't worry)
  6. Go back to the 'Extensions' tab
  7. At the bottom either click where it says "Drop Files" and select the zipped release (or 7z, rar, whatever the package format is), or you can indeed drag-n-drop the zip from Explorer to that field.
  8. Vortex should prompt you to restart. If it doesn't, just close Vortex and restart it manually.
  9. On relaunch, select cyberpunk, and you will be ready to go.

Reporting Issues, Feature Requests etc.

If possible, make reports and requests on Github. You can also use Nexus bugs and Nexus posts.

To help us fix and add things, please:

  1. Make sure you've read the usage information on the our page on Nexus
  2. Make sure you've read any instructions that the mod you're trying to install comes with
  3. Try to reproduce the problem so that you can tell us how to reproduce it.

You can use the ISSUE_TEMPLATE to help us (you can copy it to Nexus too)

Developer Info

Prerequisites

  1. Check you can use the terminal either in your IDE, or PowerShell directly (cmd.exe is not ideal)
  2. Install nodejs 16
    • Alternatively install using a package manager
    • To check nodejs works and your path etc. are correct: node --version
  3. Install TypeScript
    • npm install -g typescript
    • To check TS works: tsc --version
  4. Install Vortex Mod Manager

Build & Install

  1. npm install
  2. npm run build
    • If you're on nodejs 17+ and get an OpenSSL error, use export NODE_OPTIONS=--openssl-legacy-provider
  3. Create a zip/rar/7z archive containing everything in .\dist\
  4. Open Vortex > Extensions
    1. Disable the Cyberpunk 2077 Support extension if enabled
    2. Drag & Drop or click to add the zipfile from step 3 to install/update the new extension
  5. Restart Vortex
  6. Try to install a mod to verify the extension works correctly

Running The Tests

There's a jest test suite in test/, and it's automatically run on pre-commit. You can also use npm run test and/or configure that in your IDE.

"Real" Test Suite

Vortex Extension Test Suite on Nexus contains a Collection that can be run to test live mods.

Reporting Bugs & Making Suggestions

Debugging Typescript is great, probably*, but just using tests and console.log works fine. Additionally, you can set the DEBUG env var to have all Vortex log calls logged to console during a test run.

In WSL/posix: $ DEBUG=1 npm run test In PSH: > $env:DEBUG=1; npm run test; Remove-Item Env:\DEBUG (Yes, really. Put it in a function. Reasonable envs might get added in next psh, or might not!)

* It's not that bad, really. If you run npm run test-debug, it'll print you instructions on how to debug using a chromium browser.

For VSCode, there are launch scripts in .vscode/. "Debug Jest Tests" will start jest right from VSCode, but the second is the more useful one: it attaches to any node process that is launched with the debug config.

Either way:

  1. Add debugger; statement in your code wherever you want to stop (or just set a breakpoint in the IDE)
  2. Use npm run test-debug to start jest and run all tests, BUT
  3. npm run test-debug -- -t 'somestringinyourtestname' will only run the matching tests. Very helpful.
  4. Once you kick off the tests, go to VSCode's debugger and launch |> using Attach to Node
  5. Have fun!

Sourcemaps should be getting generated so you should see correct lines in the debugger.