[API] Implement Zone Sidecar #3635
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements what I call "zone sidecar". It's purpose is to serve as a local (not exposed to the outside world) web API to answer questions only the zone process can reliably answer. It does not serve player traffic, does not start a port as a zone. It starts a "shell" of a zone and boots up the bare minimum so it can answer simple questions.
Initial Use Cases
Loot simulation of drop rates
To display in an editor to show a user how many times items actually drop out of 100 deaths/drops of an NPC GET
/api/v1/loot-simulateExample Request
This will simulate loot 100x iterations on NPC (Lord Nagafen) using Lord Nagafen's loot table
Response
{ "data": { "iterations": 100, "loottable_id": 4027, "npc_id": 32040, "npc_name": "Lord Nagafen", "rolled_items_count": 687, "time": 0.003345852 }, "lootdrops": [ { "droplimit": 4, "drops": [ { "chance": "12.00", "item_id": 11621, "item_name": "Cloak of Flames", "simulate_rolled_count": 34, "simulate_rolled_percentage": "34.00", "slot": 0 }, { "chance": "14.00", "item_id": 11622, "item_name": "Red Dragon Scales", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 1 }, { "chance": "12.00", "item_id": 11624, "item_name": "Gauntlets of Fiery Might", "simulate_rolled_count": 35, "simulate_rolled_percentage": "35.00", "slot": 2 }, { "chance": "12.00", "item_id": 11625, "item_name": "Orb of Tishan", "simulate_rolled_count": 22, "simulate_rolled_percentage": "22.00", "slot": 3 }, { "chance": "12.00", "item_id": 11626, "item_name": "Selo`s Drums of the March", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 4 }, { "chance": "13.00", "item_id": 11628, "item_name": "Blight, Hammer of the Scourge", "simulate_rolled_count": 41, "simulate_rolled_percentage": "41.00", "slot": 5 }, { "chance": "13.00", "item_id": 11629, "item_name": "Hierophant`s Crook", "simulate_rolled_count": 43, "simulate_rolled_percentage": "43.00", "slot": 6 }, { "chance": "13.00", "item_id": 11630, "item_name": "Gold Plated Koshigatana", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 7 }, { "chance": "14.00", "item_id": 11631, "item_name": "Prayers of Life", "simulate_rolled_count": 42, "simulate_rolled_percentage": "42.00", "slot": 8 }, { "chance": "13.00", "item_id": 11632, "item_name": "Bladestopper", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 9 }, { "chance": "15.00", "item_id": 17702, "item_name": "Treasure Hunter`s Satchel", "simulate_rolled_count": 48, "simulate_rolled_percentage": "48.00", "slot": 10 }, { "chance": "15.00", "item_id": 19071, "item_name": "Torn, Burnt Book", "simulate_rolled_count": 60, "simulate_rolled_percentage": "60.00", "slot": 11 } ], "lootdrop_id": 7725, "mindrop": 4, "multiplier": 1, "probability": 100 }, { "droplimit": 2, "drops": [ { "chance": "20.00", "item_id": 10036, "item_name": "Black Sapphire", "simulate_rolled_count": 58, "simulate_rolled_percentage": "58.00", "slot": 0 }, { "chance": "20.00", "item_id": 10051, "item_name": "Ruby Crown", "simulate_rolled_count": 52, "simulate_rolled_percentage": "52.00", "slot": 1 }, { "chance": "1.00", "item_id": 11880, "item_name": "Rune of Frost", "simulate_rolled_count": 2, "simulate_rolled_percentage": "2.00", "slot": 2 }, { "chance": "1.00", "item_id": 11881, "item_name": "Rune of the Astral", "simulate_rolled_count": 4, "simulate_rolled_percentage": "4.00", "slot": 3 }, { "chance": "10.00", "item_id": 16976, "item_name": "Crystallized Sulfur", "simulate_rolled_count": 21, "simulate_rolled_percentage": "21.00", "slot": 4 }, { "chance": "20.00", "item_id": 22503, "item_name": "Blue Diamond", "simulate_rolled_count": 63, "simulate_rolled_percentage": "63.00", "slot": 5 } ], "lootdrop_id": 7726, "mindrop": 2, "multiplier": 1, "probability": 100 }, { "droplimit": 1, "drops": [ { "chance": "12.00", "item_id": 11621, "item_name": "Cloak of Flames", "simulate_rolled_count": 34, "simulate_rolled_percentage": "34.00", "slot": 0 }, { "chance": "14.00", "item_id": 11622, "item_name": "Red Dragon Scales", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 1 }, { "chance": "12.00", "item_id": 11624, "item_name": "Gauntlets of Fiery Might", "simulate_rolled_count": 35, "simulate_rolled_percentage": "35.00", "slot": 2 }, { "chance": "12.00", "item_id": 11625, "item_name": "Orb of Tishan", "simulate_rolled_count": 22, "simulate_rolled_percentage": "22.00", "slot": 3 }, { "chance": "12.00", "item_id": 11626, "item_name": "Selo`s Drums of the March", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 4 }, { "chance": "13.00", "item_id": 11628, "item_name": "Blight, Hammer of the Scourge", "simulate_rolled_count": 41, "simulate_rolled_percentage": "41.00", "slot": 5 }, { "chance": "13.00", "item_id": 11629, "item_name": "Hierophant`s Crook", "simulate_rolled_count": 43, "simulate_rolled_percentage": "43.00", "slot": 6 }, { "chance": "13.00", "item_id": 11630, "item_name": "Gold Plated Koshigatana", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 7 }, { "chance": "14.00", "item_id": 11631, "item_name": "Prayers of Life", "simulate_rolled_count": 42, "simulate_rolled_percentage": "42.00", "slot": 8 }, { "chance": "13.00", "item_id": 11632, "item_name": "Bladestopper", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 9 }, { "chance": "15.00", "item_id": 17702, "item_name": "Treasure Hunter`s Satchel", "simulate_rolled_count": 48, "simulate_rolled_percentage": "48.00", "slot": 10 }, { "chance": "15.00", "item_id": 19071, "item_name": "Torn, Burnt Book", "simulate_rolled_count": 60, "simulate_rolled_percentage": "60.00", "slot": 11 } ], "lootdrop_id": 175041, "mindrop": 0, "multiplier": 1, "probability": 80 }, { "droplimit": 1, "drops": [ { "chance": "12.00", "item_id": 11621, "item_name": "Cloak of Flames", "simulate_rolled_count": 34, "simulate_rolled_percentage": "34.00", "slot": 0 }, { "chance": "14.00", "item_id": 11622, "item_name": "Red Dragon Scales", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 1 }, { "chance": "12.00", "item_id": 11624, "item_name": "Gauntlets of Fiery Might", "simulate_rolled_count": 35, "simulate_rolled_percentage": "35.00", "slot": 2 }, { "chance": "12.00", "item_id": 11625, "item_name": "Orb of Tishan", "simulate_rolled_count": 22, "simulate_rolled_percentage": "22.00", "slot": 3 }, { "chance": "12.00", "item_id": 11626, "item_name": "Selo`s Drums of the March", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 4 }, { "chance": "13.00", "item_id": 11628, "item_name": "Blight, Hammer of the Scourge", "simulate_rolled_count": 41, "simulate_rolled_percentage": "41.00", "slot": 5 }, { "chance": "13.00", "item_id": 11629, "item_name": "Hierophant`s Crook", "simulate_rolled_count": 43, "simulate_rolled_percentage": "43.00", "slot": 6 }, { "chance": "13.00", "item_id": 11630, "item_name": "Gold Plated Koshigatana", "simulate_rolled_count": 45, "simulate_rolled_percentage": "45.00", "slot": 7 }, { "chance": "14.00", "item_id": 11631, "item_name": "Prayers of Life", "simulate_rolled_count": 42, "simulate_rolled_percentage": "42.00", "slot": 8 }, { "chance": "13.00", "item_id": 11632, "item_name": "Bladestopper", "simulate_rolled_count": 36, "simulate_rolled_percentage": "36.00", "slot": 9 }, { "chance": "15.00", "item_id": 17702, "item_name": "Treasure Hunter`s Satchel", "simulate_rolled_count": 48, "simulate_rolled_percentage": "48.00", "slot": 10 }, { "chance": "15.00", "item_id": 19071, "item_name": "Torn, Burnt Book", "simulate_rolled_count": 60, "simulate_rolled_percentage": "60.00", "slot": 11 } ], "lootdrop_id": 175042, "mindrop": 0, "multiplier": 1, "probability": 30 } ] }There are also plans to answer BestZ for use of placement on a 2D map editor.
Booting Sidecar
Booting is done from the brand new Zone CLI.
CLI
./bin/zone sidecar:serve-http --port=9000(optional) --key=authkey(optional)Example Sidecar HTTP Response Logs