New Weapons
A new weapon is an entry in the mod's balance/weapons.synx, a line in balance/loadout.synx, an icon and texts. The game's
code is closed, so your weapon borrows the body of a game weapon: how it is held, how it strikes, its clips and cards. The
numbers, icon and names are yours.
1. Three required steps
1. The weapon entry — balance/weapons.synx:
weapons
karambit
look_as knife
kind melee
damage 13
cooldown_sec 0.2
range_m 1.8
arc_deg 80
projectile_speed_mps 0
level_damage_step 0.2
draw_sec 0
min_draw_sec 0
damage_type physical
crit_chance 0.45
crit_damage 0.35
kill_souls_share 0.1
alt
kind hurl
damage_mult 1.33
windup_sec 0.1
cooldown_sec 0.35
range_m 22
arc_deg 0
speed_mps 30
return_speed_mps 0
radius_m 0.15
count 1
spread_deg 0
recipe
- knife
- bent_blade
recipe_souls 302. It is a weapon — balance/loadout.synx. Without this line it can be crafted but never equipped:
items
karambit weapon3. Icon and texts — assets/items/karambit.png (16×16) and the strings weapon_karambit, sum_karambit, desc_karambit,
fx_karambit_main, fx_karambit_alt_label, fx_karambit_alt — see Images, Textures & Text.
2. look_as and kind — body and behaviour
look_as— the id of the game weapon whose body yours takes: hands, grip, attack clips, the model in hand (with your image) and the cards it grows with.kind— how the left-click attack works;alt.kind— what the right click does.
The safest way is to copy a game weapon's whole entry from the game's balance/weapons.synx, rename the key, set look_as to
that weapon and change the numbers. Special kinds (tome, harp, lash, summon…) have their own required blocks — they come
along with the entry.
Game weapon (look_as) | kind | alt.kind | Special blocks |
|---|---|---|---|
sword, katana | melee | wave | — |
knife, long_knife | melee | hurl | — |
scythe | melee | throw | — |
spear | melee | javelin | — |
salmon | melee | slap | — |
bow, composite_bow | ranged | volley | — |
hunter_bow | ranged | volley | far |
staff | homing | salvo | homing |
pizza | toss | boomerang | — |
rifle, long_rifle | rifle | buckshot | magazine |
holy_hammer | smash | spin | knockback, spin |
spellbook | tome | beam | series, beam |
heaven_staff, hell_staff | summon | summon | fall, retinue |
harp | harp | heal_note | homing, harp, heal_note |
nunchaku | lash | mill | lash, mill |
angel_kunai | melee | halo | halo, bane |
demon_dagger | melee | siphon | siphon, bane |
Legendary and mythic weapons (the Scythe of Lucifer, the Spear of Death, the Spear of Longinus and others) can be a base too — they have more special blocks, all visible in the game's file.
3. Left-click attack
| Field | What it does |
|---|---|
damage | Damage of one hit before modifiers and cards |
cooldown_sec | Seconds between attacks: 0.2 — five a second. attack_speed from items makes it faster |
range_m | Reach of a swing or shot, metres |
arc_deg | Width of a swing, degrees; 0 for shots |
projectile_speed_mps | Projectile speed, m/s; 0 for melee |
level_damage_step | Damage added per weapon level, a share of damage |
draw_sec, min_draw_sec | Bows only: full draw and the shortest draw that still fires. 0 for the rest |
damage_type | physical or magic: which modifiers raise it and which defences cut it |
crit_chance, crit_damage | Crit chance 0…1 and the extra damage of a crit (0.35 — +35%) |
kill_souls_share | Share of the victim's souls on top: 0.1 — +10% |
can_crit | false — no crits at all, not even from items. true by default |
side | saint or demon — whose weapon it is by legend. Without its own bane it hits enemies of the opposite side harder. None — neutral |
4. Right-click mode — the alt block
Right-click damage is the weapon's damage × damage_mult. Fields a kind does not need are zeros.
| Field | What it does |
|---|---|
kind | The kind: wave, hurl, throw, javelin, slap, volley, salvo, boomerang, buckshot, spin, beam, summon, heal_note, mill, halo, siphon and the special kinds of legendary weapons |
damage_mult | Damage as a multiple of the weapon's damage |
windup_sec | Delay from the press to the strike |
cooldown_sec | Right-click cooldown; it does not block the left click |
range_m, arc_deg | Reach and width |
speed_mps | Speed of what is thrown or fired |
return_speed_mps | Return speed (scythe, pizza); 0 — does not come back |
radius_m | Hit radius of a projectile or an area |
count, spread_deg | How many projectiles at once and the fan they spread in |
5. The smith's recipe
| Field | What it does |
|---|---|
recipe | Ids the smith takes: weapons and items |
recipe_keeps | What you must have, but the smith does not use up |
recipe_souls | Souls on top |
Without recipe the weapon cannot be forged, only found. To make it drop, add it to the loot — see
Items, Armour & Drops.
6. Change a game weapon
Name the game weapon with the same key and only the fields you change:
weapons
bow
damage 40
alt
count 7All fields and special blocks are in the reference.