Skip to main content

Welcome (Read this, please !)

Here's our official documentation for Vestige Unreal Engine 5 project.

Getting Started​

You can easily navigate trough documentation with the sidebar you can see on your left.

Each section is named clearly so on-boarding is easier for you.

What you'll need​

  • Unreal Engine 5 version 5.4:

    • It is important you keep the version 5.4 for now, we will probably upgrade the project in a near future, but for now, 5.4 is advised.

  • Visual Studio 2022:

    • When installing, you will need to check the following:
      • C++ Desktop Development
      • .NET Desktop Development
      • C++ Game Development

  • Gitlab access to the repository

  • A SSH Key

Project Structure​

Below is described the current project structure we're using, again, it's subject to change, but for now, we have this one:

  • Assets:
    • We have all of our Static Mesh assets, as well as some Materials that are applied to them.
      warning

      The materials need to be moved from here to the Materials folder.

  • Audio:
    • All sounds related to the game will be there.
  • Footage:
    • The Level Sequences, basically cinematics are located there
      warning

      No sub-structure is currently present, this will need to change once we have some more Level Sequences

  • Gameplay:
    • Programming related - Where most of our Blueprints are located:
      • Behaviour:
        • The behaviour scripts, small components that can be used and reused to alter gameplay.
      • Props:
        • Custom props that contain scripting for them to work, mostly interacteable objects.
      warning

      Some of the Blueprints are in the root, they will need to be moved to a corresponding folder

    • We also have a debug Level that can be accessed to test gameplay functionalities
  • Levels:
    • We have in there, the Level of the game itself. Those are prod ready and shall not be used to debug things. If needed, please create a folder with the level name prefixed with D, for instance: DL_Denial.
  • Materials:
    • All the materials used are here.
    warning

    Materials needs to be restructured in order to maintain a clear structure.

  • Splash:
    • Unrelevant for development, it contains the Project Splash art.
  • Starter Content:
    • An UE5 folder that gives out a few scripts and materials, don't touch it !
  • Story Framework:
    • The folder structure of Story Framework, will be documented in some time.
  • Vestige Content:
    • An old folder that needs to be deleted. Due to UE5 constraints don't erase it yourself !!
    danger

    Don't delete the folder, even if empty, it will break the project ! It will be deleted later on by Lead Developer

Contributing to the documentation​

As a developer, you will need to document your changes each time you do so, for everyone to able to keep track with them, below is a link on how to do it: Documentation Repository