Skip to content

Latest commit

 

History

History
81 lines (65 loc) · 3.99 KB

README.md

File metadata and controls

81 lines (65 loc) · 3.99 KB
Raw

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. If any of the download links is no longer valid, try google or a search engine of your choice.
    • 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 2017
    • Call "yarn config set msvs_version 2017 --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
  • 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)