Dev Utilities for Dummies

Install & Use Dev utilities for dummies

Not everyone is familiar with the software setup, in order to accommodate more casual users here is a more detailed setup and explicit setup guide.

What You Need Before Starting

1. Python Software: This is a programming language that our software needs to run.
2. The Software Files: You'll need a copy of our software on your computer, either by 'cloning' or downloading it.

What is Python?

Python is a programming language that's widely used for all sorts of applications, from web development to data analysis. Our software is written in Python, so you'll need it on your computer to run the software. It's free to download and install!

What Does 'Cloning' Mean?

In the software world, 'cloning' means making an identical copy of a set of files. For our purposes, it means getting a copy of this software from its online storage space, known as a repository, onto your computer. You can also download a ZIP file if 'cloning' sounds too technical. Both methods will give you the files you need.

Step-by-Step Guide

Step 1: Check if Python is Installed

1. Windows: Open the Command Prompt by searching for "cmd" in the Start Menu.
2. Mac/Linux: Open the Terminal from your Applications or Utilities folder.

Type the following and hit Enter:

python --version

If you see a message like "Python 3.7.x" or higher, you're all set! If not, you'll need to download Python.

Step 2: Download the Software Files (Cloning or ZIP)

Option 1: Download ZIP

1. Visit the GitHub page where the software is stored.
2. Look for a button that says "Code" and click on it.
3. Click on "Download ZIP."
4. Once the ZIP file is downloaded, find it in your Downloads folder and unzip it.

Option 2: Cloning (Advanced)

If you're comfortable using git commands, you can clone the repository. This is more advanced and not necessary if you've downloaded the ZIP.

Step 3: Navigate to the Software Folder

Open your Command Prompt or Terminal and navigate to the folder where you unzipped or cloned the software. For example:

cd path/to/your/Victoria-3-dev-utilities

Step 4: Install Required Packages

Type this command and hit Enter:

python -m pip install -r requirements.txt

Step 5: Start the Software

Type this command and hit Enter:

python index.py

Step 6: Open the Website

A message will appear (in the terminal) telling you to visit a website, usually http://127.0.0.1:8050/. Open this address in your web browser.

You're All Set!

Congratulations, you've installed and started the software! If you find any issues, please report them on the GitHub page.