Mods and Resources: Difference between revisions

From Straftat Wiki
No edit summary
 
Line 3: Line 3:


== How to install Mods ==
== How to install Mods ==
Using [https://thunderstore.io/ Thunderstore Mod Manager] or [https://github.com/ebkr/r2modmanPlus r2modman], using their platform to browse mode.
Using [https://github.com/ebkr/r2modmanPlus r2modman] or [https://thunderstore.io/ Thunderstore Mod Manager], using their platform to browse mods.


== Recommended Mods ==
== Recommended Mods ==

Latest revision as of 20:20, 25 April 2025

Brief Description

This page is for the resources of Game Mods as well as some potentially recommended Quality of Life Mods.

How to install Mods

Using r2modman or Thunderstore Mod Manager, using their platform to browse mods.

Recommended Mods

BepInExPack
Straftat Stream Safety
Custom Game Music
Crosshair Overlay
Example

Modding Resources

This is where people smarter than me can talk about things that can help others!

Community Map Creation Guide

The following guide is made under the premise of at least being somewhat familiar with Blender or another 3D Modeling software on a baseline level, if not then there are plenty of tutorials on YouTube.

Important Details

  • Blocking and transfering your idea to something more tangible is important; not only does it help you focus on the fun part more but it also helps you give a reference to work from since things like weapon choice and lighting can affect how a map is ultimately played.
  • Keep in mind that Straftat is more akin to that of Classic Quake Deathmatch rather than a traditional First Person Shooter such as Counter Strike or Call of Duty; players typically focus on pathfinding, understanding options and fast movement.
  • Make sure to establish the size and scale of the player, it's important to remember that the player model is roughly 2 meters high and 1 meter in width. For crawl spaces, keep it to around 1.5 meters so that players can slide with it being 1 meter wide also.

Map Creators Onboarding Process

  • Send Léonard a blender file of your map sketch. He will review it and give feedback.
  • If the map has potential to work in game, you will be added to the Git organization.
  • Make your map fully playable in unity editor.

Getting Started for Git Users

Ask Leonard for git access. Once you are a member of the git organization, please follow these steps :

  1. Fork the git
  2. Clone you fork to your local machine
  3. Create your branch
  4. Checkout your branch
  5. Open the project
  6. Make your own content folder inside : Assets\Environment\Levels\YourName\YourMap (this folder will contain your geometry, textures, materials)
  7. Make your own scenes folder in : Assets\Scenes\YourName
  8. Make your own artsource folder containing Blender files in : STRAFTAT\Straftat_git_Artsource\Environment\Levels\YourName\YourMap


PULL REQUEST

  • When your content is ready to be implemented in Main branch, please make a pull request.
  • When making a pull request, please ONLY INCLUDE the files you intend to send to main.
  • (sometimes some files get in the changelist out of nowhere. Please exlude them from your commits. Discard these changes if necessary)

Pull Request steps :

  1. Create your commit from your branch, name it something with your name
  2. Push your commit
  3. Create pull request for your commit

Create Your Map : Practical Guide

- Blender file of your map required (in artsource folder)
- Nvidia GPU required for baking lights with Bakery plugin. Do not attempt to bake lights without nvidia GPUs. Devs will take care of your lighting.
- Test your map often. Run around in your map and get familiar with the metrics

How to set up your unity scene :
1 - Duplicate one of our working unity scenes (example: Arena_00) to use as a template.
2 - Rename the scene and place in your own scenes folder
3 - Replace scene's geometry with your own
4 - Change weapon spawners with weapons of your choice from the weapon prefabs folder
5 - Move player spawn points to desired location with desired orientation
6 - Change the lighting. Refer to bakery documentation. Keep our bakery setting in the baking window. Set Texel resolution to 1 or 2 for quick preview bake. Set to 10 max for final quality bake
7 - Place light probes where needed
8 - Englobe your level inside reflection probe bounds