Skip to content

MaybeSamigroup/SVS-SardineTail

Repository files navigation

SVS-SardineTail

Table of Contents

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

Sources include LZMA SDK under public domain.

Binary releases contain required K4os.Compression.LZ4 distributed under MIT license.

Prerequisites

Aicomi

Confirmed working under Aicomi 1.0.7.

SamabakeScramble

Confirmed working under SamabakeScramble 1.1.6

DigitalCraft Standalone

Confirmed working under DigitalCraft 3.0.0.

Installation

Extract the latest release 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.

External tool to make stp from development package is also available.

For mod developers who are impatient: Refer to the Tutorial

How to Use in DigitalCraft

Please follow the installation instructions.

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 with the Hardmod pack option enabled.
  4. Install the latest Fishbone/CoastalSmell and SardineTail.
  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:

{
  "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"
  }
}

About

Fundamental plugin to develop soft mod for SamabakeScramble

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages