Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssjshields/zs-modding
Documentation and resources for modding the video game ZERO Sievert.
https://github.com/ssjshields/zs-modding
game-maker zero-sievert
Last synced: about 2 months ago
JSON representation
Documentation and resources for modding the video game ZERO Sievert.
- Host: GitHub
- URL: https://github.com/ssjshields/zs-modding
- Owner: ssjshields
- Created: 2023-08-08T05:33:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T18:32:33.000Z (over 1 year ago)
- Last Synced: 2024-10-12T20:45:04.102Z (3 months ago)
- Topics: game-maker, zero-sievert
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[ZS Official Discord](https://discord.gg/sievert)
[ZS Nexus Mods](https://www.nexusmods.com/zerosievert)
[ZS Modding Wiki](https://zero-sievert.fandom.com/wiki/Modding)
## Mod managers
**Recommended:** [ModOrganizer2](https://github.com/ModOrganizer2/modorganizer) & [MO2 ZS plugin](https://www.nexusmods.com/site/mods/617?tab=description)
**Alternative:** [Vortex](https://www.nexusmods.com/about/vortex/)
> While installing mods refer to the author's instructions
## File directories
**Assets**: `ZERO Sievert\data.win`
> Fonts, scripts, sounds, sprites and strings
**Gamedata**: `ZERO Sievert\ZS_vanilla`
> Load order, values and descriptions for weapons, items, npcs
**Savedata:** `%localappdata%\ZERO_Sievert`
> Save slots, game settings and backups
## Debug Mode
`ctrl` + `alt` + `p`
> Spawn items and enemies, adjust weather, teleport
## Editing resources
**Audio:** [Audacity](https://www.audacityteam.org/) & [Foobar](https://www.foobar2000.org/)
**Coding:** [Notepad++](https://notepad-plus-plus.org/) & [Visual Studio Code](https://code.visualstudio.com/)
**Fonts:** [FontForge](https://fontforge.org/en-US/) & [Google Fonts](https://fonts.google.com/)
> ZERO Sievert uses [Munro](https://www.fontspace.com/munro-font-f14903)
**Sprites:** [Photopea](https://www.photopea.com/), [Gimp](https://www.gimp.org/) or [Aseprite](https://www.aseprite.org)
## Creating data.win mods
**Required:** [UndertaleModTool](https://github.com/krzys-h/UndertaleModTool)
**1.** Open `data.win` with UMT and make desired changes
> Associate UMT with the `.win` filetype for ease of access
> For texture mods- export content and utilize [Custom Sprite Framework](https://www.nexusmods.com/zerosievert/mods/16)
> Do not redistribute `data.win` files, instead create XDelta patches
## Creating XDelta patches
**Required:** [DeltaPatcher](https://github.com/marco-calautti/DeltaPatcher)
**1.** Set "Original file" path to a clean `data.win`
**2.** Set "Modified file" path to the modded `data.win`
**3.** Set "XDelta patch" path to the desired output location
> It is recommended to add comments to the patch description
## Applying XDelta patches
**Required:** [DeltaPatcher](https://github.com/marco-calautti/DeltaPatcher)
**1.** Set "Original file" path to a clean `data.win`
**2.** Set "XDelta patch" path as the `.xdelta` (mod)
> Patches can only be applied **once**
> Do not load more than one modified `data.win` file at a time
## Creating JSON mods
**1.** Modify `.json` files using desired text editor
**2.** Create a new folder with your mod name as the title `ModName\ZS_vanilla\gamedata`
**3.** Add modified `.json` files to the mod's `gamedata` folder
[Packaged folder structure example](https://github.com/ssjshields/zs-modding/blob/main/example_json_mod.zip)
## Merging JSON mods
**Required:** [WinMerge](https://winmerge.org/?lang=en) or similar difference check software
**1.** Compare up to three `.json` files (left, middle and right view.)
**2.** Right-click the highlighted difference and copy the code into the desired file
> Repeat this process for each desired difference, merging all desired changes into a single file
> Due to current limitations, ZERO Siervert can only load one of each `.json` at a time
**3.** Save and overwrite original files in desired mod