SVS-SardineTail

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

SVS-SardineTail

★ 10 Open GitHub ↗

Fundamental plugin to develop soft mod for SamabakeScramble

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SVS-SardineTail

## Table of Contents

- [Prerequisites](#prerequisites)
  - [Aicomi](#aicomi)
  - [SamabakeScramble](#samabakescramble)
  - [DigitalCraft](#digitalcraft-standalone)
- [Installation](#installation)
- [Migration between versions](#migration-between-versions)
- [How to Use](#how-to-use)

Fundamental plugin to develop soft mod for Aicomi, SamabakeScramble and modification loader for DigitalCraft.

Sources include [LZMA SDK](https://www.7-zip.org/sdk.html) under public domain.

Binary releases contain required [K4os.Compression.LZ4](https://github.com/MiloszKrajewski/K4os.Compression.LZ4) distributed under MIT license.

## Prerequisites

### Aicomi

Confirmed working under Aicomi(with Night Tour) 2.0.3.

- [AC-HF_Patch](https://github.com/ManlyMarco/AC-HF_Patch)
  - Message Center
  - BepInEx.ConfigurationManager
  - SVS_BepisPlugins
- [Fishbone/CoastalSmell](https://github.com/MaybeSamigroup/SVS-Fishbone)
  - 4.1.0/2.1.0 or later

### SamabakeScramble

Confirmed working under SamabakeScramble 1.1.6

- [SVS-HF_Patch](https://github.com/ManlyMarco/SVS-HF_Patch)
  - Message Center
  - BepInEx.ConfigurationManager
  - SVS_BepisPlugins
- [Fishbone/CoastalSmell](https://github.com/MaybeSamigroup/SVS-Fishbone)
  - 4.1.0/2.1.0 or later

### DigitalCraft Standalone

Confirmed working under DigitalCraft 3.1.1.

- [BepInEx](https://github.com/BepInEx/BepInEx)
  - [Bleeding Edge (BE) build](https://builds.bepinex.dev/projects/bepinex_be) #752 or later
- [Fishbone/CoastalSmell](https://github.com/MaybeSamigroup/SVS-Fishbone)
  - 4.1.0/2.1.0 or later

## Installation

Extract the [latest release](https://github.com/MaybeSamigroup/SVS-SardineTail/releases/latest) to your game install directory.

## Migration between versions

### Migration from 1.0.0

Remove `SardineTail.dll` from BepinEx/plugins.

Plugin assembly names are now `SVS_SardineTail.dll` and `DC_SardineTail.dll`.

### Migration from 1.X.X to 2.X.X

These directories contained in previous releases are no longer used.
Please move it contents to new one and delete it.

- `UserData/plugins/SamabakeScramble.SardineTail`
  - New! `UserData/plugins/SardineTail`

## How to Use

**For mod users:**  
Acquire a SardineTail package from a trusted source and place it in the `sardines` directory in your game installation directory.

**For mod developers:**  
Refer to the [package specification](https://github.com/MaybeSamigroup/SVS-SardineTail/wiki).

External tool to make stp from development package is also [available](https://github.com/MaybeSamigroup/SVS-SardineTail/releases/download/2.1.5/StpBuilder.zip).

**For mod developers who are impatient:**
Refer to the [Tutorial](https://github.com/MaybeSamigroup/SVS-SardineTail/wiki/Quick-and-Rough-Modding-Tutorial-with-SardineTail)

## How to Use in DigitalCraft

Please follow the [installation instructions](https://github.com/MaybeSamigroup/SVS-Fishbone).

Mods for SamabakeScramble or Aicomi made characters are loaded from the `sardines` directory in the each game's installation directory.

Currently, the `sardines` directory under the DigitalCraft installation directory is not used.

## Hardmod Conversion Guide

1. Make a clean install of SamabakeScramble.
2. Back up the `abdata` directory as `abdata.soft`.
3. Install the latest [SVS-HF_Patch](https://github.com/ManlyMarco/SVS-HF_Patch) with the Hardmod pack option enabled.
4. Install the latest [Fishbone/CoastalSmell](https://github.com/MaybeSamigroup/SVS-Fishbone) and [SardineTail](https://github.com/MaybeSamigroup/SVS-SardineTail/releases/latest).
5. Start SamabakeScramble.
   1. Open the plugin settings and enable SardineTail's `Enable hardmod conversion at startup` option.
   2. Exit SamabakeScramble.
6. (Re)Start SamabakeScramble.
   1. Wait until the title scene appears.
   2. Exit SamabakeScramble.
7. Rename the `abdata` directory to `abdata.hard` and rename `abdata.soft` back to `abdata`.
8. Copy `abdata.hard/sardinetail.unity3d` to `abdata/sardinetail.unity3d`.
9. Move `UserData/Plugins/SardineTail/hardmods` to `sardines`.

### About the `invalids` Directory

Item data that references asset bundles not present in `abdata` will not be converted and will be reported in subdirectories under `UserData/Plugins/SardineTail/invalids`.

The directory name corresponds to the item category, and each report is named `(Item's hard id).json`.

The `Invalid` field in the report lists asset bundles that were not found in the `abdata` directory.

**Report example:**

```json
{
  "Id": 111001,
  "Category": 101,
  "Manifest": "abdata",
  "Bundles": [],
  "Invalid": [
    "chara/bo_hair_b_00.unity3d"
  ],
  "Values": {
    "Kind": "1",
    "Possess": "1",
    "MainManifest": "abdata",
    "MainAB": "chara/bo_hair_b_00.unity3d",
    "MainData": "p_cf_hair_b_20_00",
    "SetHair": "0",
    "ThumbAB": null,
    "ThumbTex": "",
    "Image": null,
    "Attribute": "",
    "Detail": "0/1/2/3/4/5"
  }
}
```

SVS-SardineTail

Today's picks

Was this content helpful?

Recent Feedback

SVS-SardineTail

Today's picks

Was this content helpful?

Recent Feedback

Download README