Skip to content

[dev] Set up Pycharm for wrye bash

Jump to bottom
Infernio edited this page Jun 13, 2023 · 9 revisions

Intro

Pycharm is the recommended way of developing Wrye Bash. This way we can have common code formatting, warnings, run/debug configurations etc - plus Wrye Bash being a rather big project really needs the support an IDE can offer (as in you introduce bugs if not using an IDE).

Setup

  1. Right click in a folder where you want to place the WB folder and click 'Git Bash Here'.

  2. If you have permissions for the main repo, clone it:

    git clone https://github.com/wrye-bash/wrye-bash.git

  3. Otherwise, fork the repo and clone your fork:

    git clone https://github.com/YOUR_USERNAME_HERE/wrye-bash.git

  4. You should now have a wrye-bash folder containing your local copy of the repo. Do not launch PyCharm yet! If you already have, delete the .idea folder it created inside your wrye-bash folder.

  5. Download our shared .idea folder and place it in your wrye-bash folder. You can also try cloning the repo, but I found that that breaks once you build WB. (TODO: maybe just include it as a submodule?)

  6. Now you can launch PyCharm. You should have the correct inspection settings, code style, launch configurations, etc.

Tips

It's a good idea to backup your Pycharm settings too - used to be done with IntelliJ Configuration Server Plugin but this is deprecated in favor of Settings Repository. End result is a repository with your IDE settings - mine is at https://github.com/Utumno/pycharm-settings.

Clone this wiki locally