Code
- # ToolDev Submission — OGLight TR Analytics Companion
- Proposed forum title: **Submission: OGLight TR Analytics Companion 0.1.0-rc1** Forum section: **Submissions & API Requests** Forum label: **Script** Tool classification: **Userscript**
- ## Tool Information
- Tool Name: OGLight TR Analytics Companion Current Version: 0.1.0-rc1 Author / Team: TC vatan Website / Repository: Review package attached; no public distribution before toleration Support / Contact: TC vatan through the submitting Origin forum account License: MIT Download Link: Review source attachment only; no public download before toleration
- ## Tool Classification
- Userscript.
- This is an independent companion for the officially tolerated OGLight userscript. It does not modify or redistribute OGLight.
- ## Browser / Platform Compatibility
- Supported: Current Chrome, Edge and Firefox releases with Tampermonkey. Dependency: Current officially tolerated OGLight 5.3.3 or a later reviewed version with a compatible local data structure.
- ## Supported OGame Languages / Communities
- The companion interface supports Turkish and English. It does not parse language-specific game text or use translated labels as selectors, so the analytics functions are intended to work across OGame communities wherever OGLight exposes the same local data structure.
- ## Tool Description
- OGLight TR Analytics Companion is a read-only decision-support panel. After a direct user click, it reads account summaries and aggregated expedition statistics that OGLight has already stored locally in the same browser page. It calculates and displays summaries locally. It sends no game action and makes no network request.
- ## Complete Feature List
- ### 1. Launcher and panel
- - Adds one small round `TR` launcher button at the lower-right edge of the OGame page.
- - A direct user click opens a modal analytics panel.
- - The panel does not replace normal OGame navigation or gameplay screens.
- Data accessed: none until the launcher or refresh button is clicked. Data source: `window.ogl.db`, already present locally through OGLight. Background collection: none. External transmission: none. Automated actions/notifications: none. Workflow change: adds a read-only overlay only.
- ### 2. Turkish/English interface
- - Companion labels can be switched between Turkish and English.
- - The language setting is stored locally in `localStorage`.
- - The companion does not change OGame or OGLight's own translations.
- Data accessed: companion language preference only. External transmission: none.
- ### 3. Command Center
- - Shows planet count, moon count, total stored metal/crystal/deuterium and calculated MSU.
- - Shows hourly production calculated from OGLight's existing local values.
- - Shows the age of the last local planet/moon synchronization value.
- - Data is refreshed only by opening the panel or clicking the panel's Refresh Data button.
- Data accessed: local OGLight planet/moon resource and production summaries, local update timestamps. Background requests/polling: none. Automated actions: none.
- ### 4. Expedition Analytics
- - Aggregates OGLight's existing daily expedition counts and occurrence categories.
- - Calculates net metal, crystal, deuterium, MSU, average MSU and Dark Matter found.
- - Values found or lost as ships are converted using a static public ship-cost table.
- - Applies the expedition ship-value percentage and the existing ship-loss/fuel-ignore preferences already selected in OGLight.
- Data accessed: local aggregated OGLight statistics (`db.stats`) and the local OGLight MSU/ship-value/loss/fuel preferences. Message text or report API keys accessed: no. External transmission: none. Automated actions: none.
- ### 5. Resource Distribution Calculator
- - The user manually enters a target cost and reserve amounts.
- - The calculator reads locally stored planet resources and proposes how much each planet could contribute.
- - It has no fleet button, coordinate link, game endpoint, automatic navigation or send action.
- Data accessed: local planet resource summary plus direct user input. Background requests: none. Automated actions: none. Normal fleet workflow changed/shortcutted: no.
- ### 6. Mine ROI Calculator
- - The user selects a mine, current level and expected additional hourly production.
- - The calculator shows next-level resource cost and estimated MSU payback.
- - An optional user-clicked estimate uses the selected planet's local production and mine level.
- - It does not start, queue, select or navigate to a building.
- Data accessed: local mine level/production values and direct user input. Background requests: none. Automated actions: none. Premium queue imitation: none.
- ### 7. Local export/import
- - A direct user click can download companion settings as JSON.
- - A direct user click can download an aggregated numerical summary report.
- - The summary excludes messages, session data, targets and exact fleet composition.
- - A user-selected local JSON file can restore companion settings.
- Data accessed: companion settings and aggregated values described above. External transmission/telemetry: none. Storage: browser `localStorage` for companion settings only.
- ## API Usage
- The companion uses no OGame API, no in-game endpoint and no external endpoint.
- - `fetch`: not used.
- - `XMLHttpRequest`: not used.
- - `GM_xmlhttpRequest`: not used.
- - `accountInfo`: not used.
- - `cp` planet switching: not used.
- - Request frequency: zero.
- ## UI Modifications
- - Adds one 44 × 44 pixel launcher button at the lower-right edge of the page.
- - Adds a user-opened modal containing five read-only tabs.
- - Does not hide, move, resize, recolor or obstruct monetization, premium, legal or navigation content.
- - Does not replace fleet dispatch, building selection, login or any core gameplay interface.
- Screenshot: `screenshots/command-center.png` Offline working demo: `demo.html`
- ## Installation Instructions
- 1. Install the current officially tolerated OGLight from its official channel.
- 2. Install `OGLight-TR-Analytics-Companion.user.js` in Tampermonkey.
- 3. Open OGame normally.
- 4. Click the `TR` launcher.
- This release is provided for review and should not be publicly distributed before toleration.
- ## Data Handling / Privacy
- - Companion settings are stored locally in `localStorage`.
- - OGLight's already-local values are read only after a direct user click.
- - No data is sent to an external server or database.
- - No analytics, telemetry, advertising, fingerprinting, webhook, email or Discord integration exists.
- - Local downloads occur only after the user explicitly clicks an export button.
- ## Source Availability
- Open source. The submitted userscript is human-readable, unminified and unobfuscated. Tests, offline demo, changelog and compliance self-audit are included.
- ## Changelog
- Version 0.1.0-rc1
- Added:
- - Turkish/English read-only command center.
- - Local expedition analytics.
- - Manual resource distribution calculator.
- - Manual mine ROI calculator.
- - Explicit local settings and summary export.
- - Offline synthetic-data demo and compliance tests.
- Changed:
- - None; initial independent companion release.
- Fixed:
- - None; initial release.
- Removed:
- - No features removed. Forbidden automation, polling, alarms and direct game actions were intentionally never implemented.
- ## Compliance Declaration
- I confirm that this tool:
- - Does not automate gameplay.
- - Does not provide forbidden functionality.
- - Does not exceed permitted API usage; it makes no API or game request.
- - Complies with the current OGame Origin tool guidelines to the best of the author's knowledge.
- - Is submitted for ToolDev review before public distribution or live-account use.
