Fork me on GitHub

Documentation for the Maniaplanet game operating system

Introduction

A Title Pack is a set of elements "combined" together to create a new experience. By using a Title Pack, you will have access to several dedicated tools to really customize the environment. With it you can use the following features:

Create a title pack offers also several features which are very helpful to control the experience:

Here is few examples of Title Packs:

As you can understand now, a Title Pack can be equivalent to a little game when you use all the features (use of the item, new art design, use of the bots, creation of weapons), it can be totally different to ShootMania (a bit less for TrackMania for the moment as it has less possibilities than ShootMania).


Create a Title Pack

Description of the ManiaPlanetTitle.xml file format.

Where?

In the main menu with the stations, in the "options" tab, Click on "Edit packs".

In the title menu, you can either "create a new pack", or update an existing one by clicking on it's name. (when you edit an existing one, the people that already unlocked a previous version by paying you planets will not have to do it again for the update)

At this point you can just put together some of your creations in a pack - like a vehicle, or tracks... (as before Maniaplanet 2)
You can set a pretty pack name, some description, the price. And you can define a link.
This should be a link of a page describing the title and how to get it, as this is the link that will be given to the players when they don't have the title, or it is outdated.

Or you can also include title informations to create a title pack, by clicking on the title button.

The first time you click on the title button, you'll be requested to enter the identifier of the title, which is used to make the unique identifier of the title (in the form title@yourlogin). You can't alter it once it's created.

Title creation infos

At this point a form is diplayed to select the title creation infos.

As a general rules all fields are optional. Only fill in the ones you need to use.

Title

Menu

Editor:

Solo

Here you can create a simple/classic campaign, or you can further customise with a custom script. (caveat: it doesn't work in SM yet, although it should be possible to create timeattack-like campaigns once I fix it)

..../My campaign/01-myfirst group/01-myfirstmap
..../My campaign/01-myfirst group/02-mysecondmap
..../My campaign/02-mysecond group/01-myfirstmap

point it to the .../My campagin folder. The maps and groups are sorted in alphabetical order of the file names, so prefixing with a number is a good idea.. * Medals: the total number of medals that the player can win in the campaign. (that's usually 4 x number of maps, but if it's a custom mode the number may be different. for instance in the platform title only 3 medals per map are earnable) --> that's used for the medal rankings. * Playlist: if you don't want to use the classic campaign menu and make advanced scripting, that's the way to input the list of maps to use. (But otherwise leave it empty.)

Network

Extra contents

You can also add extra contents in the pack, to make it available to the player when he is in the title. Click on contents, an you'll see all data automatically included for the title description.

You can click on "add" to add extra contents.

That's where, for instance, you can include playlists to make them available when creating a server, but not enforce to use them or extra maps, and so on...

Dependencies

If you add a playlist.txt, it will automatically include all the maps from it.
And if you have custom data (mods, images, ...) in the maps they'll also be included.
or if a map includes a MT that uses a image, they'll also be included.
or if you add a script, all it's #include are included.

What's known not to work at this point:

Credits

People need to unlock the pack to use it.

At this point you can either specify a number of planets to pay. (you can change it when you update the pack, people that already payed don't need to pay again, and the price isn't tied to a specific update)

You can also generate one shot unlock keys to give the pack to specific people, in the player.maniaplanet.com page. (advanced/maniacredits)

caveat: Still missing is the UI to have multiple beneficiaries of the planets, and to deprecate old revisions of the packs.

As well as the audience statistics to know who installed your title, and so on.

Building the title case and station

The title cases and stations are built from a image and some logos.

There is also ManiaplanetTile.xml in the folder, which contains the data from the title form.
You shouldn't modify it if you're not an advanced user.

However, advanced users can edit it to change data which is not exposed in the menu. But be careful - the game overwrites it quite often while you're editing the pack in the menu and may not reload your changes. It's best to leave the editing of the title in the game when you want to edit this file.

Logos Legend

Manialink

If you make a custom manialink for the menu, there are some specific actions available to redirect back to the usual menus.

Those actions are available in the documentation.

Example:

<label posn="-130 -80" halign="center" style="CardButtonMedium" text="Close" action="quit"/>

If you want to include data in the pack, you can put your files in My Documents/Maniaplanet/Media/... and then use the url file://Media/... to use it.

(note: Media/ is mandatory, you cannot put the files in another root folder)

Caveat: as the automatic extration of data from manialinks doesn't work yet, you also have to explicitly include the data in the pack.

Create a weapon

As noted above, you can create a weapon for your title pack. To learn more about that, just follow the tutorial.