Skip to content

Latest commit

 

History

History
117 lines (65 loc) · 3.74 KB

contribution-quickstart-guide.md

File metadata and controls

117 lines (65 loc) · 3.74 KB
Raw

Contributor Quickstart Guide

Required Software

  • A way to use git such as Git Bash or the Windows-Linux Subsystem
  • Python 3.x
  • Scons
  • 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. Scons

  • Open Windows Powershell and run the command pip install scons==4.7.0

4. Godot

  • Download Godot 4.2.2 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 scons in Powershell
    • It will take a minute to initially compile. Any future C++ changes only need to recompile the files that were changed and are much faster

  1. Run the Godot executable

  2. 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