Exopandora / ShoulderSurfing

Shoulder Surfing Reloaded is a highly configurable third person camera mod for minecraft.
MIT License
48 stars 9 forks source link
fabric fabric-mod forge forge-mod java minecraft minecraft-forge minecraft-mod neoforge neoforge-mod neoforged

Shoulder Surfing Reloaded

CurseForge Downloads Modrinth Downloads GitHub License

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

Features

Installation

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

Forge

Prerequisites

  1. Make sure Minecraft Forge 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
  2. Make sure Forge Config API Port (CurseForge, Modrinth) 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: 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):

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

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

License

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