From ed60b60dc876b926c495d5763f547e2e1170bc37 Mon Sep 17 00:00:00 2001 From: Relic Date: Fri, 3 Apr 2026 18:08:17 -0400 Subject: [PATCH] Readme Created Start of the Readme, documents what is required to start working on the project. --- Docs/Img/sandbox-add-picture.png | 3 + Docs/Img/visual-studio-gcm.png | 3 + Docs/Img/visual-studio-git-option.png | 3 + Docs/Img/visual-studio-git-options-window.png | 3 + Docs/Img/visual-studio-git-window.png | 3 + Docs/Img/visual-studio-project-selector.png | 3 + Docs/Img/visual-studio-remote-repo.png | 3 + Docs/Img/windows-vs-feature-selection.png | 3 + readme.md | 142 ++++++++++++++++++ 9 files changed, 166 insertions(+) create mode 100644 Docs/Img/sandbox-add-picture.png create mode 100644 Docs/Img/visual-studio-gcm.png create mode 100644 Docs/Img/visual-studio-git-option.png create mode 100644 Docs/Img/visual-studio-git-options-window.png create mode 100644 Docs/Img/visual-studio-git-window.png create mode 100644 Docs/Img/visual-studio-project-selector.png create mode 100644 Docs/Img/visual-studio-remote-repo.png create mode 100644 Docs/Img/windows-vs-feature-selection.png create mode 100644 readme.md diff --git a/Docs/Img/sandbox-add-picture.png b/Docs/Img/sandbox-add-picture.png new file mode 100644 index 0000000..69ab81c --- /dev/null +++ b/Docs/Img/sandbox-add-picture.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a07545eca52a23e6e115d06cd88bb06da316f0ca35ec480986d6dc4fe9afa7c3 +size 23827 diff --git a/Docs/Img/visual-studio-gcm.png b/Docs/Img/visual-studio-gcm.png new file mode 100644 index 0000000..d9771bd --- /dev/null +++ b/Docs/Img/visual-studio-gcm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5e605df3e07a6d7ae3d23420ac2d80f925606a9138bfa7745e202a3002be07c +size 61092 diff --git a/Docs/Img/visual-studio-git-option.png b/Docs/Img/visual-studio-git-option.png new file mode 100644 index 0000000..24965f4 --- /dev/null +++ b/Docs/Img/visual-studio-git-option.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99de2a3ca74b2def68fc3d2aa40f737b27bc2a5aa44133afa5b15dfdd4264f11 +size 84170 diff --git a/Docs/Img/visual-studio-git-options-window.png b/Docs/Img/visual-studio-git-options-window.png new file mode 100644 index 0000000..ac0ebe8 --- /dev/null +++ b/Docs/Img/visual-studio-git-options-window.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1675beb8b40f6c591c8daca7f8d74a0b0e33393368e6e41f847dead9c9c3e2f1 +size 37927 diff --git a/Docs/Img/visual-studio-git-window.png b/Docs/Img/visual-studio-git-window.png new file mode 100644 index 0000000..8d4b1f3 --- /dev/null +++ b/Docs/Img/visual-studio-git-window.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de16eabeb5c32746d5ba22342ef1e0d8e2549a22ad2faa9a6ce3cab12a309c49 +size 282014 diff --git a/Docs/Img/visual-studio-project-selector.png b/Docs/Img/visual-studio-project-selector.png new file mode 100644 index 0000000..571588a --- /dev/null +++ b/Docs/Img/visual-studio-project-selector.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b41bd45b974d946ea08d73f6862bd536106e7c712fa88da894ab5c2b05085b67 +size 28632 diff --git a/Docs/Img/visual-studio-remote-repo.png b/Docs/Img/visual-studio-remote-repo.png new file mode 100644 index 0000000..f3dd712 --- /dev/null +++ b/Docs/Img/visual-studio-remote-repo.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee22ccdeac0093b8c1c595e9f8db1e082555ed046b916939b30f67f3a9b37a9f +size 18523 diff --git a/Docs/Img/windows-vs-feature-selection.png b/Docs/Img/windows-vs-feature-selection.png new file mode 100644 index 0000000..3054788 --- /dev/null +++ b/Docs/Img/windows-vs-feature-selection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8367a691bb741bfb3b276a0ed3cd7a9d2778f025cf8174d3de3601296f85ac33 +size 80000 diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..cd0b0f9 --- /dev/null +++ b/readme.md @@ -0,0 +1,142 @@ +# Project Titan + +Index: + +- [Getting Started](#getting-started) +- [Visual Studio Configuration](#configuring-visual-studio) + +## Getting Started + +Working on this project requires some things that you need to install. Those being +Visual Studio, S&box, Git (LFS enabled). Among that you will need access to the +[Gitea](https://gitea.vps.collinssoft.com). You'll know who to reach out to +if you are lacking access. This will only target Windows development since +S&box only supports Windows, however, in the future they do plan to support +Linux. + +#### 1.) Installing Git and Git LFS + +This is realively simple to do, just go to [git's website](https://git-scm.com/) +and download the installer for Windows. All the default settings are acceptable, +but if you want to take a look at what they are and pick and choose feel free ;). + +In order to enable Git LFS you will have to open the terminal and run: + +```bash +git lfs install +``` + +#### 2.) Install S&Box + +Right now S&Box is only available through building it ourselves and Steam. This will +go over how to gain access through Steam. To get access you will have to go through +[this url](https://sbox.game/give-me-that). Once you have completed that, you will +have it in your Steam library. + +*NOTE: depending on how you chose to install S&Box will affect whether the S&Box +editor will work for you through Steam. If you try and it doesn't work, you can +access the locally installed files and `sbox-dev.exe` can be used.* + +When it releases in Steam on April 28th, 2026 the project will provide the funds +for all developers to gain access, and this documentation will be updated. + +#### 3.) Install Visual Studio + +Installing Visual Studio is a similar process to installing Git but with some UI +elements added. To start download the installer from [Microslop](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=learn.microsoft.com&utm_campaign=inline+link&0utm_content=download+vs2026+desktopguide+winforms). + +Once you run the installer, you should see something similar to this: + +![microslop-feature-selection](./Docs/Img/windows-vs-feature-selection.png) + +*NOTE: Do not feel the need to login or create an account, you can skip it* + +The only thing that needs to be selected is the `.NET Multiplatform App UI development`. +Feel free to choose what optional things you want in addition, as you can notice the picture +depicts the Copilot options being disabled. This install will take a few minutes, but once +complete you now have an IDE to do development with. + +#### 4.) Clone the Project + +Cloning is the process of creating a replica of the Git repository on your local file system. +To do this we will be using the terminal, however, you can setup Visual Studio to do the +same thing. If you would rather go down that route, there are plenty of tutorials on the subject +so feel free. + +Open a terminal and traverse to the directory that you wish the project to be cloned to. Once you +are there you can run the command: + +```bash +git clone https://gitea.vps.collinssoft.com/Relic/Titan.git +``` + +This will create a titan folder and download all the contents of the repository to that folder. + +#### 5.) Add the Project to S&Box + +Opening up S&Box you should see the project selector pop up. + +![sandbox-project-selector](./Docs/Img/sandbox-add-picture.png) + +In the picutre you can see an arrow pointing to a button, clicking +that button will open up the explorer. Traverse to the project root +and click Open. After that you should have the project appear as a +selectable option afterwards. Click that and it will open the S&Box editor and +now you can start working on the project. + +*NOTE: Make sure that you have started the project with S&Box it will +generate a slnx file that will be needed for Visual Studio in the next +step.* + +#### 6.) Add the Project to Visual Studio + +The last step is to configure Visual Studio. + +![visual-studio-project-selector](./Docs/Img/visual-studio-project-selector.png) + +Click on `Open a project or solution` will open the explorer window. Traversing +to the root of the project that was cloned and click the slnx file and it will +open the project. Next time you open Visual Studio it will be a selectable option. + +## Configuring Visual Studio + +Index: + +- [Git](#visual-studio-git) + +### Visual Studio Git + +We will be using Git for working together on this project, and Visual Studio being +a fully fledge IDE has support for that workflow. + +Up in the top left corner there is a Git tab, contained in that tab you should see +something similar to this -> + +![git-tab](./Docs/Img/visual-studio-git-option.png) + +As you can see we already have the local repository, the only other thing we need +to do is setup the remote. + +![git-remote-config](./Docs/Img/visual-studio-remote-repo.png) + +Once that is clicked you should see another window pop up. + +![git-remote-config-options](./Docs/Img/visual-studio-git-options-window.png) + +All that you need to confiure is the `User name` and the `Email` fields, these +should be the same as your Gitea user is configured with. + +Lastly you need to configure your authentication, in the same window you were just in +click on `Git Global Config` and you should see this window. + +![git-gcm](./Docs/Img/visual-studio-gcm.png) + +Validate that the setting `Credential Helper` is set to GCM. + +## Using Visual Studio to Push Code to Gitea + +![git-visual-studio-tab](./Docs/Img/visual-studio-git-window.png) + +Click the `Git Changes` tab in the bottom left will open the tab to a different window +where you can push your code. Contained in this Git window shows what branch you are +on, the changes that are present, a place to put commit messages and much more. \ No newline at end of file