Vortex Development
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Nov 6, 2018
.vscode bumped version May 28, 2018
__mocks__ fixed unit tests Oct 10, 2018
__tests__ fixed unit tests Oct 10, 2018
api @ 03b2164 fixes to api exports Jan 10, 2019
app warn if reinitializing staging folder fails Jan 15, 2019
assets outline for the start button in the top left Jan 14, 2019
build update exe icon Jan 19, 2018
extensions allow closing dialogs programatically Jan 17, 2019
icons/custom changed the spinner to be animated through css instead of an svg anim… Aug 30, 2018
locales added some more translations Oct 30, 2018
samples/sample-extension cleanup Jun 20, 2018
src add option to filter mods with no category set Jan 18, 2019
tools outline for the start button in the top left Jan 14, 2019
typings.custom updated dependencies Aug 17, 2018
.babelrc cleanup&fixes Sep 7, 2016
.eslintignore minor stuff Feb 3, 2017
.eslintrc heavily reworked buildsystem Feb 16, 2017
.gitignore updated electron Oct 30, 2018
.gitmodules updated submodules Nov 16, 2018
.npmrc specified build architecture for npm Jun 5, 2018
BuildSubprojects.js enabled parallel building again Aug 31, 2018
BuildSubprojects.json Moving gist-dashlet into the core application Jan 11, 2019
InstallAssets.js fixed installassets script ended prematurely Jul 31, 2017
InstallAssets.json allow redux development tool to work again Jun 29, 2018
LICENSE.md [#140759123] polished about dialog and its code Mar 1, 2017
README.md Fixed some typos in README.md Apr 7, 2018
appveyor.yml small stuff Jan 14, 2019
bootstrap.ps1 Support TLS 1.2 in bootstrap.ps1 Apr 7, 2018
dev-app-update.yml fixed: errors from downloading an update weren't caught correctly May 4, 2018
electron-builder-advanced.json removed version number from the string that shows up in the uninstaller Jul 31, 2018
electron-builder-ci.json fixed: ci builds not runnable? Nov 14, 2018
electron-builder-oneclick.json removed version number from the string that shows up in the uninstaller Jul 31, 2018
electron-builder-web.json dependency cleanup Jun 27, 2018
jsconfig.json initial commit Sep 6, 2016
licenseFormat.json updated and reviewed dependencies Jun 1, 2017
package.json updated to electron 2.0.16 Jan 7, 2019
setupTests.js further fixes to unit tests May 2, 2018
structure.md large build system cleanup Jan 8, 2018
tsconfig.json fixed source map support in development May 16, 2018
tslint.json bugfix: error in stop-folder regex could break output filenames Oct 26, 2017
updateLicenses.js updated modmeta library Jul 2, 2018
versions.json prevent outdated versions from reporting errors and feedback Aug 22, 2018
webpack.main.config.js disable name mangling in production for now Jun 5, 2018
webpack.renderer.config.js disable name mangling in production for now Jun 5, 2018
yarn.lock warn if reinitializing staging folder fails Jan 15, 2019

README.md

Usage

To build from source you have two choices.

Automatic (mostly):

  • 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

Manual:

  • Before you can build vortex you need to download and install a couple of dependencies.
    • node.js
      • download installer from https://nodejs.org and run
      • version doesn't matter much, latest lts should be fine
    • yarn
      • install through npm "npm install --global yarn"
    • git
    • python 2.7
    • c++ build tools 2015
    • Call "yarn config set msvs_version 2015 --global"
      • This sets up yarn to use the c++ build tools we just installed
      • If you downloaded a newer version, change the version accordingly
  • Check out the repository
    • create and cd to an appropriate directory (i.e. c:\projects)
    • git clone https://github.com/Nexus-Mods/Vortex.git vortex
      • this creates a new directory vortex below the current working directory
    • cd vortex
  • Switch to the appropriate branch if necessary
    • git checkout somebranch
  • For development
    • "yarn install" followed by "yarn run build" to build
    • "yarn run start" to run
  • For production
    • "yarn dist" to build (this will take a while)
    • Find the installer and an alread unpacked version in dist

If something goes wrong:

The build tools are unfortunately not particularly stable or robust, so the build may break for various reasons (i.e. network problems, dependencies that changed remotely, ...) and leave the checkout in an inconsistent state. In that case you will have to see if the error is something that needs to be fixed, then restart from the last step that failed.

The automatic variant will skip dependency download and install if the download was installed previously. If a dependency install failed for some reason or you cancelled it, you will have to manually install that package (see the downloads directory).

Further Information

  • see structure.md for an overview of how the project is organized
  • see the wiki for a description of the extension api
  • run "yarn run doc" the create an html page from code documentation

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

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

or

C:\Users\<username>\AppData\Roaming\vortex_devel (development build)

If you need to report a bug, the following files inside that 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 (that one contains keys and passwords so sensitive information)
  • <game>\state* (if the bug pertains to a specific game)