Modding: Difference between revisions

''Downwell'' is a GameMaker game, and nearly everything about it — sprites, code, sounds — lives in a single <code>data.win</code> file that can be edited with '''UndertaleModTool'''. This page is adapted from [https://docs.google.com/document/d/1bjOP715lMkC5dbPnMfEyhSGs4RvKaqw-OcRUvz6Co_8/ VirtuaVirtue's Downwell Modding Documentation], with additions from this wiki's own decompilation notes.

* '''[https://github.com/UnderminersTeam/UndertaleModTool UndertaleModTool]''' — the only tool you strictly need. Download a ''Stable'' release ("Bleeding Edge" is newer but less stable).

* '''Any pixel-precise image editor''' — Paint.NET, Aseprite, even MS Paint.

'''Make a backup of <code>data.win</code> before editing — you are modifying the game itself.'''

* '''Frame 0''' — the selection icon shown on the end-of-level choice screen. 24×24 pixels.

* '''Frame 1''' — the inventory icon shown in the corner once taken. 12×12 pixels.

# Find your sprite in the ''Sprites'' section and check its properties — most importantly the '''origin must be 12×12''' so the icons align in the menu and inventory.

All of the game's text lives in <code>language.ini</code> next to <code>data.win</code>. Add your upgrade's name to the <code>ugName</code> section — the last vanilla entry is <code>ugName22</code>. Entries for the other languages are optional, but without them those languages show a blank name and description.

| <code>ug[i][1]</code> || Copies currently owned — the game resets it; leave at 0

| <code>ug[i][4]</code> || Maximum copies obtainable. The pickers only offer an upgrade while <code>ug[i][1] < ug[i][4]</code> — vanilla entries with 0 here (Dumbbell, Super Charge, Sudden Fortune) are cut content that can never appear. Leave at 1

| <code>ug[i][5]</code> || Price in gems — '''only read for the shop consumables''' (indexes 100–105); dead data for regular upgrades. Leave at 200

Import exactly as in the upgrade tutorial, then check the sprite properties — here the '''origin must be 6×6'''.

Add the style's name to the <code>styleName</code> section — the last vanilla entry is <code>styleName4</code>.

# <code>gml_GlobalScript_styleInit</code> — declares each style's name and animation sprite indexes (index variable <code>s</code>, incremented per style like the upgrade table). Point the animation fields at your imported sprite indexes (double-click a sprite; its index is shown at the bottom right).

# <code>gml_GlobalScript_styleUpdate</code> — runs when a style is selected and sets the player's stats. Copy an existing <code>case</code> to the end and adjust. Vanilla <code>gunType</code> values are 0–6 (see the [[#Reference: weapon stats|weapon table]]).

# <code>gml_GlobalScript_styleSet</code> — declares the animations again; possibly never called, but add your style for good practice.

# <code>gml_Object_PlayMenu_Create_0</code> (search ''playmenu'') — increment <code>styleMax</code> by 1 so the menu shows your style.

* add it to the unlock tables — an entry in <code>gml_GlobalScript_unlockGoalNum</code> (shifting the later indexes) and a <code>case</code> in <code>gml_GlobalScript_unlockNotice</code> — or

| <code>bStatName</code> || Pickup name, quoted, usually capitalised — e.g. <code>"NOPPY"</code>

| <code>bStatObject</code> || Bullet object index — 261 for MACHINEGUN/SHOTGUN/TRIPLE/PUNCHER/BURST/NOPPY, 260 for LASER

| <code>bStatRof</code> || Rate of fire — lower is faster; negatives appear to disable it

| <code>bStatBurstRate</code> || Delay between burst bullets — lower is faster

| <code>bStatExplode</code> || Unused by vanilla — set 1 and every bullet explodes; balance accordingly

| <code>bStatAimAngleAccl</code> / <code>Dccl</code> / <code>Limit</code> || Aim rotation speed/deceleration/max angle — only NOPPY aims (limit 25)