Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/silasary/linklink


https://github.com/silasary/linklink

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README 

        
# LinkLink - A Cross-game Item Link



This is a manual designed to emulate itemlinks across games.  It creates its own progression items and locations, and is designed to be as easy to use as possible.



## How to use



There are three key things to be aware of:



The first is item declarations.  Add new items to [items.json](data/items.json), adding games and their associated items to the `linklink` dictionary. Everything in a list will be made progressive, even if the original items weren't.



The second knob is a technical limitation.  The [Data Hooks](hooks/Data.py) contains a constant (`MAX_PLAYERS`) with the Maximum number of players that can be added to an itemlink.  There is no penalty for having extras other than some ID bloat, but we'd rather not have it too much higher than needed.



Note:  This is the maximum number of players in a link, not the total number of players in the multiworld.  If you have an 8 player multiworld, with Four players with Swords, and three players with Bicycles, you can safely have MAX_PLAYERS at 4.



Third, is a yaml setting `victims`.  You can leave this empty, and it will plando every valid player in the multiworld.  But if you only want to affect a subset of players, put their names in here.



Note:  Unlike normal itemlinks, which are conservative with the pool, linklink is greedy.  If one player has 3 swords and another player has five, LinkLink will take as many as possible from each player.  You DO NOT need to worry about yaml settings affecting the numbers of items in the pool.



You DO NOT need to hand-define plando, or even have plando enabled in host.yaml.  The LinkLink world will force placement of the items it wants to steal automatically.



## Item Definitions



This is an extension of the standard Manual item definition.

```json

    {

        "count": 6,  // Maximum in pool.  Any above this number won't be plando'd

        "name": "Shield", // Name of the item as it appears in the client and other players.

        "progression": true,

        "linklink": {  // This is the important part:

            "Links Awakening DX": ["Progressive Shield"],  // Progressive items are pulled multiple times.  We'll pull all three Progressive Shields.

            "Tunic": ["Shield"],                           // Tunic only has one shield.  Nothing will happen when the link recieves shields 2 and 3.

            "A Link to the Past": ["Blue Shield", "Red Shield", "Mirror Shield"], // LttP has three separate shields.  This will progressify them.

            "Ocarina of Time": ["Progressive Shield", "Deku Shield", "Hylian Shield", "Mirror Shield"], // If a game has the option to be progressive or not, this uses progressives if it can find any, then the individuals afterwards.

            "Factorio": ["progressive-armor", "progressive-energy-shield"],  // You can even progressify progressives!  This'll give all four Armor upgrades, then the two Energy Shield modules.

            "The Legend of Zelda": ["Magical Shield"],

            "SMZ3": ["ProgressiveShield"],

            "Wind Waker": ["Progressive Shield"],

        }

    }

```



## How does this work?



Locations are automatically created by [after_load_location_file](hooks/Data.py), and item placement and culling is done in [after_generate_basic](hooks/World.py).  Distribution is done by hand, using the Manual Client.