-
Notifications
You must be signed in to change notification settings - Fork 2
getting setup
We use git for source control solution, make sure you install the 64bit version.
Git LFS is used to configure how GIT handles storing large files. We use it to avoid bloating the amount and time it takes to sync the repository.
Git can be used entirely through the command line, but it tends not to be very user-friendly for those who have not used it before.
We recommend you use a frontend UI for it to make the development experience nicer. If you've used perforce in the past one of the closest options is GitHub Desktop, and its the one most people will be using for this project.
Visual studio 2022 Professional as our IDE we use.
As we use cmake to generate our projects files you are can use other IDE's if desired, but visual studio is what will be tested against for CI so please ensure your work compiles in it.
When installing visual studio ensure you install with the following ticked:
- "Desktop Development with C++" in the workloads tab
- "Windows 10 SDK (10.0.20348.0)" in the individual component tab.
We use cmake to generate our project files, this allows us to setup our project in a flexible and platform agnostic way.
This documentation assumes the use of GitHub Desktop, if you are using an alternative frontend or the command line, please read its respective documentation.
Once you've installed github desktop, and logged in, you should be able to open it and click File->Clone Repository. From there find the project under the list of repositories you have access to, it will be called tleonarduk/workshop. Just select a path you want to store the project in and hit clone. After a few minutes you should have a fresh version of the engine ready for use.
Ensure you read Submission Workflow before making any changes to the code at this point to avoid shooting yourself in the foot.
There is a batch file here for generating the project files: engine/tools/scripts/generate_vs2022.bat
When run this will generate a visual studio solution file you can open at: intermediate/vs2022/workshop.sln
If you wish to generate for a new IDE you can also use the cmake-gui to setup your build environment directly. If you do this, ensure that you build your binaries and files to the intermediate/ folder so they are not accidently checked into the repository.
Introduction
Standards
Architecture
- Code Structure
- Build Configurations
- Engine Structure
- Virtual File System
- Entity Component System
- Renderer
- Assets
Helpful Notes