Compare commits
6 Commits
feat/3-cic
...
0227b7d83c
| Author | SHA1 | Date | |
|---|---|---|---|
| 0227b7d83c | |||
| 490d2c1860 | |||
| 28f978b10e | |||
| f15c20affd | |||
| ed60b60dc8 | |||
| eeac1ebaf6 |
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -2,3 +2,5 @@
|
||||
*.png filter=lfs diff=lfs merge=lfs -text
|
||||
*.spp filter=lfs diff=lfs merge=lfs -text
|
||||
*.assbin filter=lfs diff=lfs merge=lfs -text
|
||||
*.vmat filter=lfs diff=lfs merge=lfs -text
|
||||
*.vmdl filter=lfs diff=lfs merge=lfs -text
|
||||
|
||||
BIN
Assets/models/glock/glock.vmat
LFS
Normal file
BIN
Assets/models/glock/glock.vmat
LFS
Normal file
Binary file not shown.
BIN
Assets/models/glock/glock.vmdl
LFS
Normal file
BIN
Assets/models/glock/glock.vmdl
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/create-model-import-model.png
LFS
Normal file
BIN
Docs/Img/create-model-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/mat-creation-import-model.png
LFS
Normal file
BIN
Docs/Img/mat-creation-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/model-doc-import-model.png
LFS
Normal file
BIN
Docs/Img/model-doc-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/model-doc-mag-glass-import-model.png
LFS
Normal file
BIN
Docs/Img/model-doc-mag-glass-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/model-doc-material-import-model.png
LFS
Normal file
BIN
Docs/Img/model-doc-material-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/sandbox-add-picture.png
LFS
Normal file
BIN
Docs/Img/sandbox-add-picture.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/texture-creation-import-model.png
LFS
Normal file
BIN
Docs/Img/texture-creation-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/texture-recompile-import-model.png
LFS
Normal file
BIN
Docs/Img/texture-recompile-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/texture-suffix-import-model.png
LFS
Normal file
BIN
Docs/Img/texture-suffix-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/vdml-file-import-model.png
LFS
Normal file
BIN
Docs/Img/vdml-file-import-model.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-gcm.png
LFS
Normal file
BIN
Docs/Img/visual-studio-gcm.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-git-option.png
LFS
Normal file
BIN
Docs/Img/visual-studio-git-option.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-git-options-window.png
LFS
Normal file
BIN
Docs/Img/visual-studio-git-options-window.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-git-window.png
LFS
Normal file
BIN
Docs/Img/visual-studio-git-window.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-project-selector.png
LFS
Normal file
BIN
Docs/Img/visual-studio-project-selector.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/visual-studio-remote-repo.png
LFS
Normal file
BIN
Docs/Img/visual-studio-remote-repo.png
LFS
Normal file
Binary file not shown.
BIN
Docs/Img/windows-vs-feature-selection.png
LFS
Normal file
BIN
Docs/Img/windows-vs-feature-selection.png
LFS
Normal file
Binary file not shown.
82
Docs/model-import-process.md
Normal file
82
Docs/model-import-process.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Model Import Process
|
||||
|
||||
The goal of this documentation is to go through what it takes to import a model into
|
||||
S&box.
|
||||
|
||||
This documentation is based of [this](https://www.youtube.com/watch?v=1-L8BvNAbjQ) guide.
|
||||
|
||||
## Process
|
||||
|
||||
To start you will need the model that you wish to import into S&Box, and the textures
|
||||
and the associated textures. The model can contain other things like animations, however,
|
||||
those are only added if the model is non-static. A static element could be a picture, where
|
||||
a non-static object could be something like a player model.
|
||||
|
||||
### Create the VDML Model
|
||||
|
||||
To start you can create the VDML model by right clicking the model in S&Box and then clicking
|
||||
`Create model...`.
|
||||
|
||||

|
||||
|
||||
Once that is clicked an explorer window will appear and you will choose where you want the
|
||||
vdml file to be saved. You will want the vdml file to be saved within the same folder as the
|
||||
model.
|
||||
|
||||

|
||||
|
||||
Double clicking the VDML file will open a program called ModelDoc. ModelDoc is the program that
|
||||
ties the animcation, the model, and the textures together to make a fully realized VDML file.
|
||||
|
||||

|
||||
|
||||
#### Create the .mat File and Attach it to the Model
|
||||
|
||||
In order to assoicate the textures with the model we need to create a .mat file. The .mat file
|
||||
contains all the textures that will be used on the model. To create a .mat file, right click it
|
||||
one of the textures and click `Create Material`.
|
||||
|
||||

|
||||
|
||||
This will open the material creation window, and depending on the naming scheme of all the textures
|
||||
some fields (or all) will have the texture automatically applied. Below contains all the suffixs that
|
||||
are reconized by S&Box.
|
||||
|
||||

|
||||
|
||||
Once `Create Material` has been click an explorer window will open. Make sure to save the .mat file in
|
||||
the same folder as all the other resources realted to the model. Once that is completed you should see
|
||||
the material editor pop up.
|
||||
|
||||

|
||||
|
||||
*NOTE: Make sure that `specular` and `metalness texture` are checkmarked, this will enable PBR materials.*
|
||||
|
||||
Go ahead and save the material if everything looks good, and now we can go back to ModelDoc.
|
||||
|
||||
#### Associate the .mat File to the Model
|
||||
|
||||
Once you are back to the ModelDoc program, located at the left of the application is the `MaterialGroupList`
|
||||
and the `RenderMeshList`. What we care about is adding our material we just created to the
|
||||
`DefaultMaterialGroup`.
|
||||
|
||||

|
||||
|
||||
Clicking on the `DefaultMaterialGroup` will open the `Node Editor`, and clicking the magnifying glass the explorer
|
||||
will pop up for us to choose our new material.
|
||||
|
||||

|
||||
|
||||
Traverse to the file that we created and double click it. That will assign the material to the model. You will need
|
||||
to go ahead and recompile, after recompiling you should see the texture applied in ModelDoc.
|
||||
|
||||

|
||||
|
||||
If everything looks good, go ahead and save the model in ModelDoc. If there are no animations associated with the
|
||||
model, then your done. You can use the VMDL file as is in the project. If there are assoicated models, then go
|
||||
to the [Assoicate Animations](#assoicate-animations) section.
|
||||
|
||||
#### Assoicate Animations
|
||||
|
||||
TODO: Lots to learn on how to even create the animations, once those animations are created, I'll go ahead
|
||||
and update this doc on how to do this.
|
||||
146
readme.md
Normal file
146
readme.md
Normal file
@@ -0,0 +1,146 @@
|
||||
# Project Titan
|
||||
|
||||
Index:
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Visual Studio Configuration](#configuring-visual-studio)
|
||||
|
||||
Links to Other Docs:
|
||||
|
||||
- [Importing a Model](./Docs/model-import-process.md)
|
||||
|
||||
## 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:
|
||||
|
||||

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

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

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

|
||||
|
||||
As you can see we already have the local repository, the only other thing we need
|
||||
to do is setup the remote.
|
||||
|
||||

|
||||
|
||||
Once that is clicked you should see another window pop up.
|
||||
|
||||

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

|
||||
|
||||
Validate that the setting `Credential Helper` is set to GCM.
|
||||
|
||||
## Using Visual Studio to Push Code to Gitea
|
||||
|
||||

|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user