docs: add comprehensive README for mod-superapix#45
Merged
Conversation
Copilot
AI
changed the title
[WIP] Add README following existing module templates
docs: add comprehensive README for mod-superapix
Jun 11, 2026
darknoon29
approved these changes
Jun 11, 2026
|
darknoon29
marked this pull request as ready for review
June 11, 2026 19:58
There was a problem hiding this comment.
Pull request overview
This PR replaces the stub README with a comprehensive French README for the mod-superapix OGSpy module, describing prerequisites, features, installation/configuration, contact info, licensing, and version history.
Changes:
- Added detailed module description, prerequisites (OGSpy/Xtense), and a full features list (API XML collection, rankings, Xtense callbacks, progress/debug).
- Documented installation via OGSpy module manager and configuration parameters (universe/country, request limits, throttle, callbacks toggles).
- Added contact links, GPL-2.0-only license note, and a version history (0.1.0 → 0.4.8).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,4 +1,66 @@ | |||
| # mod-superapix | |||
| ## Module OGSpy SuperApix | |||
| Module de récuperation des informations de l'API du jeu via votre navigateur | ||
| Ce module permet de collecter automatiquement les données du jeu OGame via son API XML publique et de les importer dans OGSpy. | ||
|
|
||
| ### Pré Requis ### |
| ### Pré Requis ### | ||
|
|
||
| * Nécessite OGSpy >= 3.3.9 — [Dépôt OGSpy](https://github.com/ogsteam/ogspy) | ||
| * Modules OGspy requis : Xtense |
| * **Nombre de requêtes max** : limite du nombre d'appels API par session (recommandé : 500) | ||
| * **Temporisation API** : délai entre deux appels API, de 1 à 3 secondes | ||
| * **Mode développeur** : active la journalisation détaillée des actions du module | ||
| * **Options CallBacks Xtense** : active ou désactive les remontées automatiques depuis l'extension navigateur Xtense (espionnages, messages, expéditions, bâtiments, recherches, flottes, défenses) |
|
|
||
| ### Licence ### | ||
|
|
||
| GPL-2.0-only — voir [GNU General Public License](http://opensource.org/licenses/gpl-license.php) |
This file contains hidden or 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.
The README was a stub (title + one line). This adds a full README following the standard OGSteam mod template (mod-cdr, mod-attaques, mod-expedition).
Changes
install.phphandles DB tables