Skip to content

Latest commit

 

History

History
123 lines (110 loc) · 5.43 KB

README.md

File metadata and controls

123 lines (110 loc) · 5.43 KB
Raw

Vortex Development Package

Automatic Dependency Installation

Windows

  • Download bootstrap.ps1 and run as a powershell script
    • In the dialog that shows up, select a build directory (should be a clean/new one)
    • This script will try to download and install all dependencies, then check out and build vortex
    • The dependencies are not installed headless so you have to click through the dialogs but it's only guaranteed to work if you keep the defaults

Linux

Arch

sudo pacman -Syu base-devel git npm nodejs node-gyp cmake zlib lz4 zip flatpak-builder

Debian

(incomplete, PRs welcome)

sudo apt install zlib1g-dev liblz4-dev

Fedora

(incomplete, PRs welcome)

sudo dnf install zlib-devel lz4-devel

Other

(PRs welcome)

this is a template

Manual Dependency Installation

  • If automatic installation of any dependency fails use the instructions provided for each dependency below.
  • If any of the provided link is no longer valid
    • Try searching the web or use your package manager.
    • Make a PR with updated links.

Node.js

  • Download and run the installer from nodejs.org
  • Version should not matter; the latest and/or LTS version are both fine
  • Verify that Node was installed successfully by running node --version in your cmd or terminal

pnpm

  • Node has started shipping corepack, a new method for directly installing package managers.
  • Update to the latest version of NodeJS or a version which supports corepack.
  • Run the following commands:
    • corepack enable && corepack prepare pnpm@latest --activate
  • Verify that pnpm was installed successfully with:
    • pnpm --version.
    • Note:
      • Running pnpm -v from the cloned Vortex repo will list the version of the packageManager specified in package.json.
        • Complex semver ranges don't appear to be supported (yet?)

Python

  • Many node modules require node-gyp, which requires python.
  • Download and run the installer (64-bit) from python.org.
  • When installing, make sure to tick the box which adds python to the PATH.
  • Verify that Python was installed successfully by running python --version in your cmd or terminal

Git

  • Download and run the installer from git-scm.com
  • Verify that Git was installed successfully by running git --version in your cmd or terminal

CMake

  • Download and run the installer from cmake.org
  • Verify that CMake was installed successfully by running cmake --version in your cmd or terminal

C++ Tools

Visual C++ Build Tools 2022 or Visual Studio 2022 (Community Edition)

  • Download and run the installer from visualstudio.microsoft.com
    • You may have to search Microsoft's website as their sitemap changes frequently.
    • When installing, make sure you enable the build tools, latest windows SDK and ATL headers. Other components are optional.

Cloning and Installing Sources

Create and cd to an appropriate directory (i.e. C:\GitHub\Nexus-Mods\, /GitHub/Nexus-Mods) then run the following commands

git clone --recursive https://github.com/NicBOMB/Vortex.git
cd Vortex

Running the following commands will build Vortex, its extensions, and start the app using those builds.

pnpm install
pnpm start

Further Information

User Guides

Developer Guides

  • For development
  • For production

Reporting bugs

Please report issues to the issue tracker on github. Please always include at the very least the following information:

  • The exact version of Vortex you're using
  • Your operating system
  • What you were doing when the bug happened
  • What exactly the bug is (crash? error messages? unexpected behaviour?)
  • If you get any error message, include the full and exact error message. Do not paraphrase, do not leave out information that looks cryptic or unimportant to you
  • The log file (see below)
  • Ideally also the application state (see below)

All data the client generates (including settings and logs) are stored at the following filepaths:

Windows

C:\Users\<username>\AppData\Roaming\Vortex (releases)

or

C:\Users\<username>\AppData\Roaming\vortex-devel (development build)

Linux

/home/<username>/.config/Vortex (releases)

or

/home/<username>/.config/vortex-devel (development build)

or

TBA (flatpak build)

If you need to report a bug, the following files inside Vortex's directory may be useful in addition to the error message displayed on screen:

  • vortex.log (logs are rotated at a certain size, this is the latest one)
  • state\* except global_account which contains sensitive information like keys and passwords
  • <game>\state\* (if the bug pertains to a specific game)