Skip to content

SETUP.md

Latest commit

 

History

History
118 lines (68 loc) · 4.23 KB

SETUP.md

File metadata and controls

118 lines (68 loc) · 4.23 KB
Raw

Development Quickstart Guide

Required Software

  • A way to use git such as Git Bash or the Windows-Linux Subsystem
  • Python 3.x
  • CMake 3.28+ and Ninja (included with Visual Studio's "C++ CMake tools for Windows" component)
  • Godot
  • A programming IDE such as Visual Studio Code

Software Installation

1. Git Bash

  • Leave settings as default

2. Python

  • Check "Add python.exe to PATH" and use the "Install Now" option

3. CMake and Ninja

  • Install CMake (3.28 or newer) and Ninja, or select the "C++ CMake tools for Windows" component in the Visual Studio Installer, which includes both
  • Verify with cmake --version and ninja --version in Powershell

4. Godot

  • Download Godot 4.7 The current version for the project will be on the main README page.

  • Unzip the Godot executable wherever you prefer to have it

5. Visual Studio Code (IDE)

  • For editing the C++ portion of the codebase, you may use any IDE that you are comfortable using
  • Visual Studio Code is a popular choice of IDE

Project Setup

  1. Go to the main repository page on Github

  2. Get the link to clone the repo

  1. Using Git, clone the repo: git clone https://github.com/OpenVicProject/OpenVic

  1. Move into the OpenVic directory: cd OpenVic

  2. Retrieve submodules: git submodule update --init --recursive

  1. Create and checkout a new git branch for your changes: git switch -c my-cool-branch
    • You should give your branch a descriptive name of the changes you intend to make

  1. Build the C++ portion of the project by running the following in a "x64 Native Tools Command Prompt for VS" (or any shell with the MSVC environment loaded):

    cmake --preset windows-x64-template_debug
cmake --build --preset windows-x64-template_debug
    • It will take a few minutes to initially compile (third-party dependencies are downloaded automatically during configure). Any future C++ changes only need to recompile the files that were changed and are much faster

  2. Run the Godot executable

  3. Select the 'Import' project button

  1. Navigate to the OpenVic/game/ directory and select the project.godot file

  1. Select "Import & Edit"

  1. This will open the Godot editor! Make your changes as desired and press the "Play" button in the top-right corner to run the game in-editor.

Contributing your changes!

Whenever you are ready to commit your changes follow this process:

  1. Run git status to show what files are new or changed

  1. Run git add ... for each of the modified files

  1. Run git commit -m "A descriptive commit message" to make a commit with your staged changes

  1. Run git push to upload your current commits to your working branch
    • If you're warned that your branch has no upstream branch, run git push --set-upstream origin my-cool-branch, replacing "my-cool-branch" with whatever your branch is named in Part 6 of Project Setup