SamSwat-AnimeSight-4.0/README.md

SamSWAT's Anime Iron Sight 4.0 Port

This mods adds new Rear Iron Sights with anime art at the back, so you can fulfill your dream to raid with your Waifu.

Features

• Adds 24 rear sights with anime girls on them. 8 for MCX and 16 for MBUS weapons.
• Rear sights are sold by the Mechanic and on the Flea Market
• Easily add new and edit current iron sights by editing JSON files (guide below)

Known Issues

• Added sights does not spawn in raids
• Internationalization support not working

Installation

1. Download the latest versions on the Releases page
2. Extract the downloaded ZIP file on the root of your SPT Installation
3. Start up the server

How to add new sights or edit them

This mod has a small JSON interpreter that allows you to add and edit new back iron sights into the game.

items.jsonc

All you have to do is open db/items.jsonc with your preferred text editor and add the follow structure for your iron sight:

{
  "id": "YOUR_ITEM_MONGOID",
  "clone_from_tpl": "ITEM_TO_CLONE_FROM_MONGOID",
  "bundle_path": "path/to/your/bundle.bundle",
  "price": 4000, // Item price. This will be used on Handbook and Mechanic
  "ergonomics": 3 // Ergo boost. You can set this to any value, but play nice ;) (or dont, I'm not the SPT police)
}

Locales

Then, you need to add the Name, ShortName and Description of your item, otherwise it will have a weird name.
To do that, open db/locales/en.json with your preferred text editor and add the follow structure:

"YOUR_ITEM_MONGOID": {
    "name": "Your beautiful item name",
    "short_name": "Short name",
    "description": "Very detailed and incredible item description that will give the player a lot of information and totally not be useless"
}

Contribuiting

(WIP)
To contribuite to this project, please follow good coding standards. Make sure your commits follow Conventional Commits and that all PRs are done to the develop branch

Credits

• Rexana - For giving the idea.
• GrooveyPenguinX - For making WTT-BundleMaster, used to fix the original bundles
• SamSWAT - For making the original mod and bundles
• ApertureAwesome - Girls Frontline M4 SOPMOD II.
• ApertureAwesome - Ram & Rem
• Farengar, tac.error, Rymd - Ai Fuyuumi
• Sumerikan - Art for Anti 1 & 2
• And one more unknown artist...