pyplanet / pyplanet

:rocket: PyPlanet is the next-gen Server Controller for ManiaPlanet (v4+) and Trackmania. Using Python3 and AsyncIO.

PyPlanet

This repo contains the PyPlanet package.

For installation, configuration and development instructions head towards our website: http://pypla.net/

Git Structure

Master is always the latest development environment. We develop features in different branches feature/* or bugfix/* appending with the issue key of GitHub.

Crafting releases is done at the release/1.1.x branches. The branch is created from the master at the moment the freeze moment goes in. Only bug fixes are accepted to be merged into the release/* or master branches (and merged into release again), name these branches bugfix/ISSUE-ID.

After releasing (from the release branch) it gets a version tag. From this point there is no way back, new bug releases will be crafted from the release branch (release/0.1.x for example).

Visualization of our current release schedule can be found here: Release Schedule

Versioning

All PyPlanet versions bellow 1.0.0 are not using semantic versioning. After 1.0.0, there is a strict semantic versioning (v2) versioning policy in use.

Contributions

Pull requests and issues are more then welcome. Please open a ticket before a pull request if you are not yet sure how to solve or want opinions before your implementation. (optional).

pyplanet's Issues

Apps: move logic to view classes (such as title and data)

Move logic to views. Example: karma and karma list. Logic for determinating title for example.

Core: GBX File parser.

We should get ourselfs a file parser for GBX. I've already made one in NodeJS earlier, I can pickup this.
Maybe something that @TheMaximum wants to do too?

Some useful tools/modules to use:

• Pythons build-in struct package.
• Pythons build-in string methods (encode/decode)

Some parts are pretty hard to do, as it's using a repeated string referencing algorithm.
See: https://github.com/ManiaJS/gbxparser

As usual, it's better to create/test/optimize before inserting it inside the core.

Core: Enable scripted callbacks on start. Only when currently using scripts (need to adjust script options for this).

Apps: Create admin contrib app.

Documentation: Create introduction text, including requirements and setup environment.

Core: Provide global and app settings management, managed by core.

Tests: Write tests for core components.

Tests: Write tests for configuration management.

Views: Add generic listview with non-db source.

Storage: Implement storage driver architecture.

Implement storage architecture into pyplanet.storage module(s).

Suggestions welcome for syntax etc.

Contrib: Create player manager, containing information about current online players and all players ever visited.

Documentation: Create installation and setup howto. (single dedicated and multi dedicated)

Documentation: Describe the apps lifecycle.

Views: Create abstract views for lists

Contrib: Create maps manager, containing and providing information about current and all maps on the current maplist.

Details will follow.

Implement Dynamic UI updating via Maniascript and data pushing (override setattr).

Implementing XML-RPC callback abstracting (Shootmania Base)

Implementing the XML-RPC callback abstracting for Shootmania core app.

Release 0.0.1 on PyPi.

Tests: Write tests for instance/processing management.

Contrib: Command manager + admin commands

Tests: Add dedicated to travis for testing.

Documentation: Create a tutorial for creating an App.

Apps: optimize local + dedi (db + gather) operations.

Apps: Create sector time app. Compare sector times with local/dedi record.

Perhaps you can port this plugin to Pyplanet http://plugins.xaseco.org/info.php?id=101

EDIT: See comment

CLI: Setup a local setup with pyplanet downloaded from pip.

Contrib: Command manager with parameter parsing etc.

Something like the build-in argparse module would be great.

DB: Make migrations work.

Views: Create abstract views for dialogs

Reworking GBX client to support asyncio.

Reworking GBX client to support asyncio.

Storage: Implement simple local filesystem storage driver.

This driver works with the python local file methods. Abstract this into the LocalFileSystem driver.

Utils: Time utils, converting time to time strings, etc.

Convert the maniaplanet defined timeings in seconds/miliseconds into string format with padding on left/right:
03:30
03:30.300
00:03:30.300

Views: Create settings view for apps.

CLI: Add CLI like Django has, for managing/generating a local installation.

Core: Marshall and unmarshall scripted methods/callbacks. Hold the response ids as response futures. (like gbx does).

Designing (functionalities mostly) the best UI managing possibility. (static via templates and pushing)

We should create the best UI manager possible.
I need input before developing it! @TheMaximum

Documentation: Update/create diagrams for describing architecture and flow.

Utils: Maniaplanet style parser/stripper

We should be able to do the following things:

• Strip nickname to nickname without any colors and styles
• Strip nickname from colors
• Strip nickname from font styles.
• Normalize (remove $> $< and that sort of stuff).
• Formatter maybe, so we could easily format nicknames inside a string (maybe even style formatter).
  See python format for this, see: https://pyformat.info/ (new styles).

Contrib: Fill in the contrib packages with most used, but not always stable (or changing much) parts of apps.

Documentation: Create pages for describing the public API for App components (using auto generated by docblocks).

Contrib: Implement /help in the command manager.

/help = shows list
/help [cmd] = shows usage
//help = /help for admins

Views: Create App settings dialog.

TODO

• Create overview view.
• Create edit view.
• Create Maniascript for adding lists items.

Core: Permissions and groups.

Apps: Implement the lifecycle control of an app.

Apps: FAST-style live checkpoints-timer

Low quality image to explain:

Implementing XML-RPC callback abstracting (Trackmania)

Implementing the XML-RPC callback abstracting for Trackmania core app.

Implementing XML-RPC callback abstracting (Maniaplanet)

Implementing the XML-RPC callback abstracting for Maniaplanet core app.

Chosing the right callbacks to abstract (chose between scripted and normal callbacks).

We should cover all things, but we need to make a choice between some of the both existing callbacks. Some callbacks are better because they contain more information, but we should be careful with too much info that we already know for example.

@TheMaximum, can you please check more about the exact information some plugins in xaseco/maniacontrol are using when using the callback endmap for example. (and others).
We should make choices asap, so we can fill the abstracted callbacks.

Tests: Write a XML-RPC dummy server for testing basic Gbx operations.

Storage: Implement simple storage driver via local paths (for reading/writing maps etc).

Documentation: Describe the architecture.