[2021] [ModsAPI_v2.0] User manual

Organizational part

Mod development

All API_v2 modifications are developed on a specially dedicated account and an issued mod developer key. To get an account and a key for a mod developer, you must submit an application with a personal message to the Modder curator - MatroseFuchs.

Mod publishing

The prototype of the mod should be submitted to the curator for review before publishing. After checking and approving the publication of the mod, the curator transfers the compiled and signed mod to the mod developer, which should not be changed, but must be published in the form that it received from the curator. The transferred mod will be valid for 30 days from the date of transfer to the mod developer. If necessary, the validity period of the mod can be extended, for this you need to contact the curator of the Modders.

Technical part

1. Resources.

For API_v2 mods, import of game client modules is available, the use of non-fuscible objects, game engine methods and Python modules/libraries used by the client.

For convenience, methods similar to API_v1.0 have been added:

events.onFlashReady(func)


events.onSFMEvent(func)


events.onReceiveShellInfo(func)


events.onBattleStart(func)


events.onBattleEnd(func)


events.onBattleQuit(func)


events.onKeyEvent(func)


events.onMouseEvent(func)


events.onGotRibbon(func)


events.onAchievementEarned(func)


events.onBattleStatsReceived(func)


events.onMarkupLoaded(func)

All other methods are available by regular import from ModsShell.

2. Preparation

Mod download directory:

World_of_Warships\bin\\res_mods\PnFMods\

Main.py

The main mod file must contain the constant "API_VERSION = 'API_v2.0'" and the individual signature of the mod developer (signature will be issued with the mod developer account).

import os
import ModsShell

API_VERSION = 'API_v2.0'
SIGNATURE = 'pNfJDPyi4&79_uiwpjeJwBKQHW/nt0CwAAAGNpcGhlcl90ZXh0cwABAABD/...'

3. Mod development

The mod is developed using the available resources of the client

Main.py

Main.swf

No changes, works the same as in API_v1.0.

Test mod attached:

TestMod1.zip

Attention!

This manual will be relevant starting from version 0.10.4, but applications can be submitted now.