Currently, if tools like OGame Infinity or my OGame Tracker want to extract data from messages like expedition results, result of lifeform discovery missions, or desbris field harvest reports, they need to have a complete list of messages for each supported language and message.
This requires a lot of effort for the developer(s) and the community every time new messages are added. Even after few years, there are still several expedition messages missing in Infinity or the Tracker, and still a lot of messages for the relatively new lifeform discovery messages are not known to tools.
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
To allow for easier and language/localization independent tool development I propose the following API for messages:
I propose inline HTML attributes similar to the attributes for the buildings, ships, etc. which already provide information like technology ID, progress, passed and total building time, or the current level/amount.
These new attributes for the messages should include information like the date, type of the result, size of the result (if available/applicable), as well as the specific findings.
If possible, it would also be great to include the unscaled finding values for resources or ships found on expeditions,such that the unscaled values don't include factors like the resource-dependend scaling, the scaling depending on the best player's score, the Pathfinder, the player class, economy speed of the server, and the several bonuses from lifeform researches.
What could this API look like?
I will now give several examples for what this API could look like for several message types.
The individual used factors are:
- Pathfinder used (x2)
- Discoverer player class (x1.5)
- Economy speed (x8)
- 0.2% lifeform research bonus to resource, fleet, and dark matter findings (x1.002)
- best player >= 100 million points
The new attributes should both a available in both the message overview as well as the detailed message view (dialog).
1. Expeditions:
a) Small resource finding:
- <li class="msg"
- data-msg-id="123456789"
- data-msg-type="41" // currently already available in "more details"
- data-msg-date="1670586644" // unix timestamp
- data-expedition-coords="1:1:16"
- data-expedition-type="resources"
- data-expedition-size="1" // 1/2/3, only available for resources, dark matter, and fleet findings, maybe also including delays and early returns
- data-expedition-resource="deuterium" // will be omitted for non-resource findings
- data-expedition-resource-amount="9218400" // will be omitted for non-resource findings
- data-expedition-resource-amount-raw="1150000" // will be omitted for non-resource findings
- data-expedition-depletion-level="0" // will be omitted if no probe part of the expedition fleet
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Expedition Result <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=16" class="txt_link">[1:1:16]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">09.12.2022 12:50:44</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- Your expedition discovered a small asteroid from which some resources could be harvested.
- <br><br>
- Deuterium 9,218,400 have been captured.
- <br><br>
- Entry from the communications officers logbook: It seems that this part of the universe has not been explored yet.
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favorite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="Mehr Details">
- More Details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
b) Huge fleet finding:
- <li class="msg"
- data-msg-id="123456789"
- data-msg-type="41" // currently already available in "more details"
- data-msg-date="1670586644" // unix timestamp
- data-expedition-coords="1:1:16"
- data-expedition-type="fleet"
- data-expedition-size="3" // 1/2/3, only available for resources, dark matter, and fleet findings, maybe also including delays and early returns
- data-expedition-ships="{ "204": 1391, "205": 3934, "210": 5854, "219": 302 }" // HTML-escaped JSON-string containing the ship IDs and their amount, see alternative below
- // alternative for the line above
- data-expedition-ships-204="1391"
- data-expedition-ships-205="3934"
- data-expedition-ships-210="5854"
- data-expedition-ships-219="302"
- data-expedition-ships-raw="2500000"
- data-expedition-depletion-level="3" // will be omitted if no probe part of the expedition fleet
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Expedition Result <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=16" class="txt_link">[1:1:16]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">09.12.2022 12:50:44</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- We found an enormous spaceship graveyard. Some of the technicians from the expedition fleet were able to get some of the ships to work again.
- <br><br>
- The following ships are now part of the fleet:<br>
- Light Fighter: 1391<br>
- Heavy Fighter: 3934<br>
- Pathfinder: 302<br>
- Espionage Probe: 5854<br>
- <br>
- Entry from the communications officers logbook: If we felt in danger we could return with all the other expeditions flying around here.
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favorite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="Mehr Details">
- More Details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
c) Medium dark matter finding
- <li class="msg"
- data-msg-id="123456789"
- data-msg-type="41" // currently already available in "more details"
- data-msg-date="1670586644" // unix timestamp
- data-expedition-coords="1:1:16"
- data-expedition-type="dark-matter"
- data-expedition-dark-matter="6339" // 703 * 9 * 100.2%
- data-expedition-dark-matter-raw="703"
- data-expedition-size="2" // 1/2/3, only available for resources, dark matter, and fleet findings, maybe also including delays and early returns
- // no data-expedition-depletion-level because no probe was part of the expedition fleet
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Expedition Result <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=16" class="txt_link">[1:1:16]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">09.12.2022 12:50:44</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- Our expedition accomplished a unique experiment. They were able to harvest Dark Matter from a dying star.
- <br><br>
- Dark Matter 6339 have been captured.
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favorite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="Mehr Details">
- More Details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
2. Lifeform Discovery Missions
a) Exploration ship was lost
- <li class="msg "
- data-msg-id="123456789"
- data-msg-type="61" // currently already available in "more details"
- data-msg-date="1670484399" // unix timestamp
- data-lifeform-discovery-coords="1:1:1"
- data-lifeform-discovery-type="ship-lost"
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Lifeform Report <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link">[7:18:7]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">08.12.2022 08:26:39</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- Homeworld:
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link"><figure class="planetIcon planet tooltip js_hideTipOnMobile" title="Planet"></figure>Homeworld [1:1:1]</a>
- <br><br>
- The exploration fleet flew into an ambush laid by a belligerent alien species. They utterly pulverised the exploration ship before initial contact could even be established.
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favourite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://s801-en.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="More details">
- More details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
b) Lifeform found
- <li class="msg "
- data-msg-id="123456789"
- data-msg-type="61" // currently already available in "more details"
- data-msg-date="1670484399" // unix timestamp
- data-lifeform-discovery-coords="1:1:1"
- data-lifeform-discovery-type="lifeform-xp" // would be "lifeform-found" if it's the first time this lifeform was found
- data-lifeform-discovery-xp="4869" // amount of XP found
- data-lifeform-discovery-lifeform="2" // id of the found lifeform, alternatively non-localized name
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Lifeform Report <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link">[7:18:7]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">08.12.2022 08:26:39</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- Homeworld:
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link"><figure class="planetIcon planet tooltip js_hideTipOnMobile" title="Planet"></figure>Homeworld [1:1:1]</a>
- <br><br>
- An error by the navigator led to the exploration ship going completely off course and finding itself lost in the depths of space. However, a scouting party from another lifeform discovered them. The strangers gave the navigator the data needed to get back on course, before disappearing again. As this lifeform was already known to them, the crew did not try to make contact with them again, and instead returning directly back to their home planet.<br>The lifeform Rock’tal was discovered at the coordinates <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=1" class="txt_link">[1:1:1]</a> and added to the <a title="" href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=lfsettings" target="_self" class="bbcodeLink internal" style="">Lifeforms</a> menu.<br><br>We already knew about this lifeform. However, our envoys were able to improve our knowledge about them by 4869 XP.<br>(...text omitted)
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favourite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://s801-en.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="More details">
- More details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
c) Small finding of artifacts
- <li class="msg "
- data-msg-id="123456789"
- data-msg-type="61" // currently already available in "more details"
- data-msg-date="1670484399" // unix timestamp
- data-lifeform-discovery-coords="1:1:1"
- data-lifeform-discovery-type="artifacts"
- data-lifeform-discovery-artifacts="10"
- data-lifeform-discovery-size="1" // 1/2/3
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Lifeform Report <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link">[7:18:7]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">08.12.2022 08:26:39</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet Command</span>
- </div>
- <span class="msg_content">
- Homeworld:
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=18&position=1" class="txt_link"><figure class="planetIcon planet tooltip js_hideTipOnMobile" title="Planet"></figure>Homeworld [1:1:1]</a>
- <br><br>
- The Exploration Ship has found a small number of artefacts.
- <br><br>
- Artefacts found: 10
- </span>
- <div class="msg_actions clearfix">
- <a href="javascript: void(0);" class="icon_nf_link fleft">
- <span class="icon_nf tooltip js_hideTipOnMobile icon_not_favorited" title="mark as favourite"></span>
- </a>
- <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=shareReportOverlay&messageId=123456789" class="icon_nf_link fleft overlay tooltip js_hideTipOnMobile" data-overlay-title="share message" title="share message">
- <span class="icon_nf icon_share"></span>
- </a>
- <a class="fright txt_link msg_action_link overlay" href="https://s801-en.ogame.gameforge.com/game/index.php?page=messages&messageId=123456789&tabid=22&ajax=1" data-overlay-title="More details">
- More details
- </a>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>
3. Debris field harvest report
- <li class="msg "
- data-msg-id="123456789"
- data-msg-type="32" // currently not available in "more details" because there is no "more details"
- data-harvest-report-coords="1:1:1"
- data-harvest-report-metal="200000"
- data-harvest-report-crystal="100000"
- >
- <div class="msg_status"></div>
- <div class="msg_head">
- <span class="msg_title blue_txt">Harvesting report from DF on <a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=1" class="txt_link">[1:1:1]</a></span>
- <span class="fright">
- <a href="javascript: void(0);" class="fright">
- <span class="icon_nf icon_refuse js_actionKill tooltip js_hideTipOnMobile" title="delete"></span>
- </a>
- <span class="msg_date fright">09.12.2022 16:30:44</span>
- </span>
- <br>
- <span class="msg_sender_label">From:</span>
- <span class="msg_sender">Fleet</span>
- </div>
- <span class="msg_content">
- Your Recycler (100 ships) have a total storage capacity of 2,000,000. At the target <figure class="planetIcon tf tooltip js_hideTipOnMobile" title="debris field"></figure><a href="https://sXXX-LOCALE.ogame.gameforge.com/game/index.php?page=ingame&component=galaxy&galaxy=1&system=1&position=1" class="txt_link">[1:1:1]</a>, 200,000 Metal and 100,000 Crystal are floating in space. You have harvested 200,000 Metal and 100,000 Crystal.
- </span>
- <div class="msg_actions clearfix">
- <div class="icon_nf_link fleft">
- <span class="icon_nf icon_apikey tooltipCustom tooltip-width:400 fleft" title="This data can be entered into a compatible combat simulator:<br/><input value='rr-LOCALE-XXX-abcef124567890abcdef1234567890' readonly onclick='select()' style='width:360px'></input>"></span>
- </div>
- </div>
- <script type="text/javascript">
- initOverlays();
- </script>
- </li>