Skip to content

Latest commit

 

History

History
138 lines (112 loc) · 6.57 KB

README.md

File metadata and controls

138 lines (112 loc) · 6.57 KB
Raw

Shoulder Surfing Reloaded

CurseForge Downloads Modrinth Downloads GitHub License

Shoulder Surfing Reloaded is a highly configurable third person camera mod for minecraft.

Features

  • Over-the-shoulder camera - see what you are interacting with in 3rd person
  • Decoupled camera - walk left and right without turning your mouse
  • Free look (default: left alt) - keep walking in a direction while looking in a different one
  • Hotkeys to move the camera (default: arrow keys, page up and page down, o to switch shoulders)
  • Corrective cross-hair positioning when using adaptive or dynamic crosshair
  • Adaptive player transparency - fades the player model to transparent when view is obstructed
  • Highly configurable - customize your 3rd person experience with many configuration options
  • Client side only - no server mods required

Installation

Download Shoulder Surfing Reloaded from CurseForge or Modrinth or build from source.

Forge

Prerequisites

  1. Make sure Minecraft Forge is installed
  2. Make sure Forge Config API Port (CurseForge, Modrinth) is installed

Manual

  1. Navigate to .minecraft/mods
  2. Move ShoulderSurfing-Forge-[VERSION].jar into the folder
  3. Follow the steps below

Launcher Settings

  1. Select Forge as your profile
  2. Launch Minecraft
  3. Join a world or server
  4. Use arrow keys, page up and page down to adjust the perspective, o to switch shoulders

Fabric

Prerequisites

  1. Make sure Fabric is installed
  2. Make sure Fabric API (CurseForge, Modrinth) is installed
  3. Make sure Forge Config API Port (CurseForge, Modrinth) is installed

Manual

  1. Navigate to .minecraft/mods
  2. Move ShoulderSurfing-Fabric-[VERSION].jar into the folder
  3. Follow the steps below

Launcher Settings

  1. Select Fabric as your profile
  2. Launch Minecraft
  3. Join a world or server
  4. Use arrow keys, page up and page down to adjust the perspective, o to switch shoulders

NeoForge

Prerequisites

  1. Make sure NeoForge is installed

Manual

  1. Navigate to .minecraft/mods
  2. Move ShoulderSurfing-NeoForge-[VERSION].jar into the folder
  3. Follow the steps below

Launcher Settings

  1. Select NeoForge as your profile
  2. Launch Minecraft
  3. Join a world or server
  4. Use arrow keys, page up and page down to adjust the perspective, o to switch shoulders

Configuration

Version 3.0.0 and later

Manual: .minecraft/config/shouldersurfing-client.toml
Ingame: Install Forge Config Screens (CurseForge, Modrinth)

Version 2.9.7 and older

≥ 1.13: Manual: .minecraft/config/shouldersurfing.toml
≤ 1.12: Ingame: Mods → ShoulderSurfing → Config (Manual: .minecraft/config/shouldersurfing.cfg)

API Documentation

The API Documentation can be found in the wiki. It currently allows other mod developers to define custom rules for when and what items should have adaptive crosshair functionality.

Building From Source

Clone the repository and run the following command in the root directory of this repository:

gradlew build

The binaries for each platform can be found in the following directories:

Platform Path
Forge ShoulderSurfing/forge/build/libs
Fabric ShoulderSurfing/fabric/build/libs
NeoForge ShoulderSurfing/neoforge/build/libs

FAQ

Q: Why is the player not looking at the position of the crosshair when holding item x?
A: This needs to be configured using the config options adaptive_crosshair_hold_items or adaptive_crosshair_use_items.

Q: Why is the player not render correctly when using shader pack x?
A: This is caused by player transparency effects of Shoulder Surfing Reloaded. Either disable them in the config (adjust_player_transparency) and restart your game or report this to the authors of the shader pack.

Q: Can you port feature x to version y?
A: No.

Q: Can you port this to quilt, liteloader, rift, etc.?
A: No.

Q: Can I add this to my mod pack?
A: Yes.

Compatibility

Shoulder Surfing Reloaded is designed to work with the following mods (a-z):

  • 3D Skin Layers
  • Create
  • Entity Model Features
  • Iris
  • Oculus
  • OptiFine
  • Sodium

Shoulder Surfing Reloaded is known to be incompatible with the following mods (a-z):

  • Better Third Person
  • Camera Utils
  • Nimble
  • Valkyrien Skies
  • YDM's Custom Camera View

Shoulder Surfing Reloaded is known to have minor incompatibility issues with the following mods (a-z):

  • Clutter (hats do not render transparent)
  • Epic Fight (player does not render transparent in battle mode, player keeps punching in the same direction)
  • EssentialClient (player look script hooks do not work)
  • Inmis (backpack does not render transparent)
  • MedievalWeapons (player is permanently in aiming mode)
    • Workaround: Remove minecraft:throwing from adaptive_crosshair_use_item_properties in the config
  • MrCrayfish's Gun Mod (crosshair does not render when using ads, fov does not update when using ads)
  • Tweakeroo (freecam movement)
  • YDM's Weapon Master (weapons do not render transparent)

License

MIT License, Original project by Sabar: Minecraft Forum, GitHub