Campaign Creation Documentation

Use this page to navigate the Campaign Creation Documentation. It's not expected that you read all of this to create a campaign - Instead, use this as a reference during campaign creation, whenever you need to use a specific event.






These pages are being restructured and may not be complete!

You can find the older version of this page here.

eventsJSON

Description

Your events.json file contains a list of all map events for your campaign.




All Events can have these attributes

LinkNameData TypeDescriptionNotes
LINKtitleStringText that appears in the event's text box.
LINKmiconImageURLThe Map Icon image for an area event, from /banckground/
LINKiconSizeIntSize of the map icon (defaults to 50px).
LINKiconAnimStringMakes the icon play a specific animation
LINKcoord[Int, Int]The x,y coordinates of the icon on the map.This can also be a String of the same data (eg "[50,50]" instead of [50,50])
LINKinvisibleTextBooleanIf true, text and name box are hidden.
LINKskippableBooleanA 'Skip' Button will appear on the event.Some events, such as text, have this on by default.
LINKimageImageURLThe background image of the event.Files pulled from /background/
LINKvideoVideoURLThe video to play before the event.Files pulled from /video/
LINKaudioAudioURLThe background music for the event.Files pulled from /audio/
LINKchainevent:IDChain to the next event.
LINKsplit[ { Object } ]Conditionally chain to another event.This largely replaces the need for fork events.
LINKvars{ Object }Variables to set after the event.There are 2 different syntaxes for this. The link shows the modern (better) one.
LINKmakes[ { Object } ]Used to generate events from a template.



Event Structure

"eventType": {
    "eventName": {
        "attributeName1": "someValue",
        "attributeName2": "someValue"
    }
}



title




micon




iconSize




iconAnim




coord




invisibleText




skippable




image




video




audio




chain




split




vars




makes