Editing Module:ItemSources/doc

== Module:ItemSources ==

This module displays item drop sources from NPCs in a table format.

=== Basic Usage ===

<pre>
{{#invoke:ItemSources|list
|source1=NPC Name,Quantity,Rarity
|source2=NPC Name,Quantity,Rarity
}}
</pre>

=== Source Format ===

Each source uses the format:

<pre>
NPC Name,Quantity,Rarity
</pre>

* '''NPC Name''' - Required. The name of the NPC (used for sprite and link)
* '''Quantity''' - Optional. Amount dropped (default: 1). Can be a range like "2-4"
* '''Rarity''' - Optional. Drop rate like "1/50" or "Always"

=== Parameters ===

{| class="wikitable"
|-
! Parameter !! Required !! Description
|-
| source1, source2, etc. || Yes || Source entries in "NPC,Quantity,Rarity" format
|-
| s1, s2, etc. || No || Shorthand for source1, source2, etc.
|-
| title || No || Section title (default: "Item sources")
|-
| spriteSize || No || Size of NPC sprites in pixels (default: 24)
|}

=== Examples ===

==== Basic Drop Table ====

<pre>
{{#invoke:ItemSources|list
|source1=Goblin,1,1/50
|source2=Orc Warrior,2-4,1/100
|source3=Dragon,5,1/500
}}
</pre>

==== Without Rarity ====

If no sources have rarity specified, the Rarity column is automatically hidden:

<pre>
{{#invoke:ItemSources|list
|source1=Goblin,1
|source2=Orc Warrior,3
|source3=Chest,1
}}
</pre>

==== Mixed Rarity ====

Some sources can have rarity while others don't:

<pre>
{{#invoke:ItemSources|list
|source1=Goblin,1,1/50
|source2=Shop,1
|source3=Dragon,5,1/500
}}
</pre>

==== Using Shorthand ====

<pre>
{{#invoke:ItemSources|list
|s1=Goblin,1,1/50
|s2=Orc,2,1/100
}}
</pre>

==== Guaranteed Drops ====

<pre>
{{#invoke:ItemSources|list
|source1=Quest Reward,1,Always
|source2=Boss,1,100%
|source3=Chest,1-3,Always
}}
</pre>

==== Custom Sprite Size ====

<pre>
{{#invoke:ItemSources|list
|spriteSize=32
|source1=Dragon,1,1/1000
}}
</pre>

=== Table Columns ===

{| class="wikitable"
|-
! Column !! Description
|-
| (icon) || Sprite of the NPC
|-
| Source || Linked name of the NPC
|-
| Quantity || Amount dropped (can be range)
|-
| Rarity || Drop rate (only shown if any source has rarity)
|}

=== Notes ===

* The Rarity column only appears if at least one source has a rarity value
* NPC names are automatically linked using <nowiki>[[NPC Name]]</nowiki>
* Sprites are loaded using <nowiki>{{Sprite|NPC Name|size}}</nowiki>
* Quantity can be a single number or a range (e.g., "1-5", "2-4")

[[Category:Modules]]
[[Category:Item Templates]]