Building.md

Build process

• Build process
  • Manual build process
    • Requirements
    • Building the application manually
    • Building the setup manually
  • Use my build script pack_tool.py (recommended)
    • Requirements
    • Running the script
      • Debug build
      • Arguments
  • Updating other files...
    • Updating Additional files/autocomplete.txt
    • Updating "What's new"

Manual build process

Requirements

• Windows 10 or later
• Visual Studio 2022 Community edition
  • ".NET Desktop Development" workload installed
• Inno Setup (optional, needed to build the installer)

Building the application manually

1. Open the solution Fallout76-QuickConfiguration\Fo76ini\Fo76ini.sln in Visual Studio 2022.
2. Set the build target to "Release", "Any CPU", and "Fo76ini_Updater"
3. Click Build → Build Solution (F6)
4. Copy (and replace) the content of Fallout76-QuickConfiguration\Fo76ini_Updater\bin\Release\ into Fallout76-QuickConfiguration\Fo76ini\bin\Release\. (Create the latter directory, if it does not exist)
5. Next, set the build target to "Release", "Any CPU", and "Fo76ini"
6. Once again, click Build → Build Solution (F6)
7. Copy the content of Fallout76-QuickConfiguration\Additional files\ into Fallout76-QuickConfiguration\Fo76ini\bin\Release\
8. Done.

Building the setup manually

1. Open Fallout76-QuickConfiguration\setup.iss in Inno Setup Compiler.
2. Edit the first few lines, such as ProjectVersion and ProjectGitDir
3. You'll probably also need to edit these lines:

   [Files]
   Source: "{#ProjectGitDir}\Publish\v{#ProjectVersion}\Fo76ini.exe"; DestDir: "{app}"; Flags: ignoreversion
   Source: "{#ProjectGitDir}\Publish\v{#ProjectVersion}\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
   ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
   

   to something like this:

   [Files]
   Source: "{#ProjectGitDir}\Fo76ini\bin\Release\Fo76ini.exe"; DestDir: "{app}"; Flags: ignoreversion
   Source: "{#ProjectGitDir}\Fo76ini\bin\Release\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
   ; NOTE: Don't use "Flags: ignoreversion" on any shared system files
   

4. Build the setup.

Use my build script pack_tool.py (recommended)

Requirements

First, install all requirements from the "Manual build process" section.

Next, install these additional requirements for this build script:

• Python 3.3 or newer
  • colorama
• rcedit
• 7-Zip
• Pandoc
• NuGet

I recommend installing these using scoop and pip:

# First, install scoop:
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex
# Add the 'extras' bucket to scoop:
scoop bucket add extras
# Install all requirements:
scoop install 7zip python rcedit inno-setup nuget pandoc
python -m pip install colorama

(Paste this line by line into a PowerShell window)

Running the script

When you open a terminal in the folder containing the script and run python pack_tool.py, you should see something like this:

From here, you can simply build the app and it should put the result into the folder Publish.

The script has an interactive mode (which you can see in the screenshot) that starts when no command line arguments are supplied.

If you want to build the app for release quickly, enter this: python pack_tool.py -r -b -p -s
This will build the app, pack it into a zip, and build the setup.

Debug build

You can also run python pack_tool.py --build-debug to make a debug build.

Arguments

$ python pack_tool.py --help
usage: pack_tool.py [-h] [-v] [-r] [-b] [-d] [-p] [-s] [-w]

Helper script for building Fallout 76 Quick Configuration

options:
  -h, --help         show this help message and exit
  -v, --set-version  set the current version
  -r, --restore      restore nuget packages
  -b, --build        build the app and updater
  -d, --build-debug  build the app and updater (Debug configuration)
  -p, --pack         pack the app into a zip archive
  -s, --build-setup  build the setup
  -w, --whatsnew     update the "What's new?" files

Updating other files...

Updating Additional files/autocomplete.txt

See Updating the "autocomplete.txt"

Updating "What's new"

Run python pack_tool.py --whatsnew and commit the changes.

Or, if you want to do it manually with pandoc:

pandoc --standalone -f gfm "What's new.md" -o "whatsnew.html" --css=Pandoc/pandoc-style.css -H Pandoc/pandoc-header.html
pandoc --standalone -f gfm "What's new.md" -o "whatsnewdark.html" --css=Pandoc/pandoc-style-dark.css -H Pandoc/pandoc-header.html
pandoc --standalone "What's new.md" -o "What's new.rtf"

The GitHub action should do the rest... It copies the files into felisdiligens.github.io/Fo76ini/, therefore making it public to all users.