Knuckle Cracker Wiki

User Tools

Site Tools

Trace:
web_apis

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
web_apis [2021/03/21 18:18] – Added how to parse objectives value Grabzweb_apis [2025/02/14 14:57] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +{{page>utils:top_links}}
 +<WRAP centeralign>
 ====== Web APIs ====== ====== Web APIs ======
 +</WRAP>
 +{{page>Utils:main_tabs}}
 +
 ===== Map Browser ===== ===== Map Browser =====
 Creeper World 1 and 2 do not have an easily readable map browser API and can only be accessed here: Creeper World 1 and 2 do not have an easily readable map browser API and can only be accessed here:
Line 20: Line 25:
   * ''h'' - ''int'' - Map height.   * ''h'' - ''int'' - Map height.
   * ''t'' - ''int'' - Map upload UNIX timestamp, divided by 1000.   * ''t'' - ''int'' - Map upload UNIX timestamp, divided by 1000.
 +  * ''p'' - ''int'' - Forum thread ID (can be used to build URL).
 +  * ''u'' - ''int'' - Thumbnail image size  (length).
 ==== CW4 values ==== ==== CW4 values ====
   * ''b'' - ''int'' - Current map thumbs count.   * ''b'' - ''int'' - Current map thumbs count.
   * ''s'' - ''string'' - Current map tags, delimited by commas.   * ''s'' - ''string'' - Current map tags, delimited by commas.
   * ''o'' - ''int'' - Map objectives. Base 10 representation of available objectives in binary format. See [[web_apis#parsing_the_cw4_objectives_value|Parsing the CW4 objectives value]] for more details.   * ''o'' - ''int'' - Map objectives. Base 10 representation of available objectives in binary format. See [[web_apis#parsing_the_cw4_objectives_value|Parsing the CW4 objectives value]] for more details.
 +  * ''v'' - ''int'' - Version number. Determines from which game version the map was uploaded. Presumably this is only incremented if an update with significant 4RPL additions is made, so older versions of the game cannot attempt to play them. Version 1.0 of the game did not have this system and will be able to play any map though.
 +  * ''z'' - ''string'' - Discord forum thread ID for the specified map, on the Knuckle Cracker Discord server.
 ==== CW3 and PF values ==== ==== CW3 and PF values ====
   * ''e'' - ''string'' - Map description.   * ''e'' - ''string'' - Map description.
Line 41: Line 50:
  
 Below is a list of available parameters to the score query APIs: Below is a list of available parameters to the score query APIs:
-  * ''userfilter'' - Filter by user name. Leave empty for no user filter.+  * ''userfilter'' - Filter by user name. Leave empty for no user filter. In Particle Fleet, filtering by user name still shows all scores, but highlights 
   * ''groupfilter'' - Filter by group name. Leave empty for no group filter.   * ''groupfilter'' - Filter by group name. Leave empty for no group filter.
 +  * ''timefilter'' 
 +    * CW3: 0, 1 or 2. 0 - All Time. 1 - 3 days. 2 - 1 week.
 +    * PF: 0 or 1. 0 - All. 1 - Month. 
 +  * ''sort'' - "score" or "time". Applicable to games that have a score. Sort by either best score or best time.
 The following arguments are exclusive, i.e. only use one of these at a time, as applicable: The following arguments are exclusive, i.e. only use one of these at a time, as applicable:
   * ''customID'' - Custom map ID. Needed to query non-DMD custom maps.   * ''customID'' - Custom map ID. Needed to query non-DMD custom maps.
Line 57: Line 70:
 let months = ["JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"]; let months = ["JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT", "NOV", "DEC"];
 let date = new Date(); let date = new Date();
-let str = `CHRONOM ${chronom_months[date.getMonth()]} ${date.getDate()}, ${date.getFullYear()}`;+let str = `CHRONOM ${months[date.getMonth()]} ${date.getDate()}, ${date.getFullYear()}`;
 let gameUID = Buffer.from(str).toString('base64'); let gameUID = Buffer.from(str).toString('base64');
 </code> </code>
Line 227: Line 240:
 Cubic              b8 Cubic              b8
 Abyss              b9 Abyss              b9
 +</code>
 +=== CW2: Academy ===
 +<code>
 +Legacy            z0
 +Basic Training    z1
 +Mind and Muscle   z2
 +Spelunking        z3
 +Engineering       z4
 +The Zoo           z5
 +Pressure          z6
 +Dimensions        z7
 +Accident          z8
 +Darkness Looms    z9
 +</code>
 +=== CW2: Credits ===
 +<code>
 +Credits         credits
 </code> </code>
  
 ===== Misc Info ===== ===== Misc Info =====
 ==== Parsing the CW4 objectives value ==== ==== Parsing the CW4 objectives value ====
-The objectives value from CW4 map data is a binary number saved in base 10 format, therefore to find which objectives exist on a map, we must look at each individual bit. There are 6 bits in total, as there are only 6 objectives. The objectives, starting from the bit at the end +The objectives value from CW4 map data is a binary number saved in base 10 format, therefore to find which objectives exist on a map, we must look at each individual bit. There are 6 bits in total, as there are only 6 objectives.
  
 Example JavaScript code for parsing the objectives value: Example JavaScript code for parsing the objectives value:
 <code JavaScript> <code JavaScript>
-let objectives = 7;+let o = 7;
  
-let Custom =  (b >> 5 & 1) != 0; //0 +let Custom =  (o >> 5 & 1) != 0; //false 
-let Collect = (b >> 4 & 1) != 0; //0 +let Collect = (o >> 4 & 1) != 0; //false 
-let Hold =    (b >> 3 & 1) != 0; //0 +let Hold =    (o >> 3 & 1) != 0; //false 
-let Reclaim = (b >> 2 & 1) != 0; //1 +let Reclaim = (o >> 2 & 1) != 0; //true 
-let Totems =  (b >> 1 & 1) != 0; //1 +let Totems =  (o >> 1 & 1) != 0; //true 
-let Nullify = (b >> 0 & 1) != 0; //1+let Nullify = (o >> 0 & 1) != 0; //true
  
 //Conclusion: Map has Nullify, Totems and Reclaim objectives //Conclusion: Map has Nullify, Totems and Reclaim objectives
 </code> </code>
web_apis.1616350707.txt.gz · Last modified: 2025/02/14 14:56 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki