Skip to content

Modding

Jump to bottom
Ulvin edited this page May 22, 2023 · 1 revision

bb backrooms wiki modding banner

About this section

This section should mostly cover everything about the game's open-source stuff, how to use it, modify and so on.

Well, the game is open source so you're free to see what's hiding behind the blueprint stuff by downloading the project (not the binary release).

I hope you'll learn something and do something better for this game or, of your own game.

❓ Prerequisites

  • Good PC running Windows.
  • Make sure you have UE 4.27.2 installed, I cannot help you if you have UE 5 because I NEVER USED IT.
  • Basic knowledge of Unreal Engine.
  • Basic Brain processing power.
    • Concentrated and calm behavior is recommended.

📁 Setting up the Project

  • ⚠ If you're encountering errors or having difficulties, attempt to make an issue and we could see how to fix. This guide is meant to me as simple, not foolproof. Make sure you have everything in order before attempting this

  1. Download / Clone the project using Git or any other preferred method. (git is required to be up to date with the source code)

  2. Did you get the game's splash screen?

    • Yes

      • You are done, modify the heck of it (the game).

    • No

      • Backtrace your problem, see what went wrong.
      • Revert some steps?
      • Still not working?

❔ FAQ (Frequently Asked Questions)

  • What font do you use?

  • Which icons do you use for the UI?

    • Material Icons (not symbols) that are also available on the Google Fonts website.

  • Music?

    • Level 0 uses the song "Key" made by C418 (sorry C418, I was too scared to email you).

  • TODO: add folder paths here for easier access

📝 Pull Request Bare Minimum

What's this?

Well let's say this is a quick guide on how to get accepted when making contributions to this game.

What do I need?

Well, to be honest with you. I accept everything that goes on with the game. UI, Features, Gamemodes, Maps.

  • UI's bare acceptance minimum

    • If using icons, they should be the Material Icons using Two-Tone Style on white.
    • Text should use Rubik font, make it so it looks good on both small and big screens (even though im incapable to do so).
    • Other, that means blur, transparency, boxes, dialogues or other screens
      • Please at least inspire from existing widgets and try to copy their style.

  • Features

    uhhhhhhhh

  • AI

    • It should be good enough, and have a good mechanism.
      • I don't know how to do good AI too so my bad why am I writing this :(

  • Gamemodes & Maps

    • Gamemodes

      • Existing Gamemode contributions (ex: working on unavailable or existing gamemodes.)

        • Should be what the Gamemode's title inquires.
        • Improvements and modifications should be explained in the Pull Request's description.

      • New Gamemode? uhhhhhhhhhhhhh no Idea

    • Maps

      • Should use the same "realistic but not so" style like the other levels. A puzzle or mechanism is optional, please also provide infos.

🔧 Notice about Game Mods or Modpacks

This is if you want to do your own set of modifications, without touching or wanting to contribute to this repository.

The name of Modpacks for this game usually refers to do your own set of custom maps and stuff from your existent knowledge, and modify the game to your liking. Have fun because I'm not sure I can give support so mark them as unofficial please :)

Before that,

It's recommended to:

  • Clone the repository locally, good luck uploading it because git-lfs declines me.

  • Do your own stuff, it's your modpack anyways.

Clone this wiki locally