Add 'Project Setup Guide - Project: Serenity'

Project-Setup-Guide---Project%3A-Serenity.md

@@ -0,0 +1,124 @@
+Welcome to the Forgeworks Interactive development team! This guide will walk you through setting up your development environment and cloning the Project: Serenity repository from our private Gitea server.
+
+# Required Software (installation defaults for all)
+
+**Unreal Engine 5.4.4** - Main engine used for development - https://store.epicgames.com/en-US/download
+
+**Visual Studio 2022** - Required IDE for C++/Unreal - https://visualstudio.microsoft.com/vs/community/
+
+**Git Bash** - Terminal for Git commands on Windows - https://git-scm.com/downloads
+
+**SourceTree** *optional, but recommended* - Visual Git GUI - https://www.sourcetreeapp.com/ - *Skip BitBucket step in installation*
+
+# Visual Studio Setup
+
+Make sure the following **workloads** are selected during installation or via the **Visual Studio Installer**:
+
+* .NET Desktop Development
+* Desktop Development with C++
+* Game Development with C++
+
+### How to install:
+
+1. Open **Visual Studio**, and click **Continue without code** at the bottom right.
+2. Click **Tools** at the top, and then **Get Tools & Features**.
+3. Select the workloads above.
+4. Click **Modify** to apply.
+
+# Connecting to Gitea via SSH (Windows)
+
+To access our private Git server securely, you'll need to set up an SSH key and add it to your Gitea account. If you're seeing this wiki, congrats, you have a Gitea account!
+
+### 1. Generate an SSH Key (if you don't have one)
+
+Open **Git Bash** and run (include the quotations, but change the email to your own):
+
+`ssh-keygen -t ed25519 -C "your_email@example.com"`
+
+* Press Enter to accept the default location (/C/Users/YourName/.ssh/id_ed25519)
+* It will ask you to set a password, but it is optional. You can simply press Enter again to skip.
+
+This generates:
+* id_ed25519 (your private key - **keep this safe**)
+* id_ed25519.pub (your public key)
+
+### 2. Copy Your Public Key
+
+Run this to copy the public key to your clipboard:
+
+`clip < ~/.ssh/id_ed25519.pub`
+
+*If clip doesn't work, use `cat ~/.ssh/id_ed25519.pub` and copy it manually*
+
+### 3. Add the Key to Your Gitea Account
+
+1. Go to https://repo.forgeworksinteractive.com/ in your browser.
+2. Log in to your Gitea account.
+3. Click your **avatar** -> **Settings** -> **SSH / GPG Keys**
+4. Click **Add Key**
+5. Add your public key
+6. Give it a name (e.g. Cow's Potato Dev Machine) and click **Add Key**
+
+### 4. Test the SSH Connection
+
+Back in **Git Bash**, run:
+
+`ssh -T git@66.85.76.122`
+
+You should see something like:
+
+`Hi <your username>! You've successfully authenticated, but Gitea does not provide shell access.`
+
+If you see a warning about an unknown host, type yes to continue and trust the server.
+
+### 5. Clone the Project
+
+Now you're ready to clone the repository:
+
+1. Open File Explorer and navigate to a memorable location on your fastest hard drive.
+2. Create a **New Folder**, and name it "Repositories" or something similar.
+3. Open the folder, right click in the empty space, and click **Git Bash here** (on Win11, you may need to click 'Show more options')
+4. Now you're ready to clone the repository:
+
+`git clone git@66.85.76.122:Forgeworks_Interactive/ProjectSerenity.git`
+
+This will download the full project into the local folder you created in a new folder named 'ProjectSerenity'.
+
+### Notes
+
+* Do not share your SSH key with anyone, ever. Not even teammates.
+* If using multiple devices, generate and register a new key on each.
+* If something doesn't work, trust that it isn't your fault! Reach out to Math or Cow and we'll help you through it.
+
+# Add the Repository to SourceTree
+
+Once you've cloned the repo via SSH, you can manage it more easily using SourceTree:
+
+### Step-by-Step Guide
+
+1. **Open SourceTree**.
+2. Click **"Add"** in the top menu.
+3. In the **Add Working Copy** tab:	
+	* **Working Copy Path:**
+    Browse to your cloned project folder (e.g., C:\Repositories\ProjectSerenity)
+    * **Repository Type:**
+    Git (should be selected by default)
+    * **Name:**
+    Give it a custom name (e.g., Project Serenity)
+    * **Bookmark Group** (optional):
+    You can leave this empty or organize your repos if you have several    
+4. Click **"Add"**
+
+### Now you're good to go!
+
+From SourceTree, you can:
+* View and switch branches
+* Stage and commit files
+* Push and pull changes
+* View commit history and diffs
+
+### Note:
+
+If SourceTree prompts you to authenticate again, make sure it's using SSH and not HTTPS. You can check this in:
+Repository Settings -> Remotes -> make sure the URL is
+`git@66.85.76.122:Forgeworks_Interactive/ProjectSerenity.git`