Plans configuration data schema

plans

This part of the configuration file is best left auto-generated by the Server Manager.

Your server installation includes the /ServerManager web application with which you use configuration files to generate game sessions to which your players/users can connect. After you've create a game session, you'll find an 'Export with Current Plans' button in the ServerManager when viewing that game session. Pressing this button will export all plans created on this game session in a new configuration file and offer that file for immediate download.

This page thus only serves as a reference / check for all the data that the Server Manager auto-generates.

"plans": [
     {
       "plan_id": 1,
       "plan_country_id": 1,
       "plan_name": "NS_ENERGY_STARTING_PLAN_GREEN",
       "plan_gametime": -1,
       "plan_type": "1,0,0",
       "plan_alters_energy_distribution": 0,
       "layers": [],
       "grids": [],
       "fishing": [],
       "messages": [],
       "restriction_settings": []
     }
]

Field	Type	Description
plan_id	int	Unique identifier of the plan
plan_country_id	int	Unique identifier of the country/team to which this plan belongs. 1 being the administrator user, 2 being the region manager user. See also the datamodel > countries documentation.
plan_name	string	Name of the plan, as shown in the game client's plan list.
plan_gametime	int	Simulated month set as this plan's implementation date. Setting this to -1 turns this plan into a so-called 'starting plan', i.e. a plan defined during the Setup state of the simulation, being basically the month before the official starting month/year as defined in datamodel.
plan_type	string	A comma-separated list of exactly three integer representations of booleans. The first integer/boolean represents whether or not this plan involves the CEL energy simulation. The second integer/boolean represents whether or not this plan involves the MEL ecosystem simulation, as it affects the fishing fleets' country effort divisions. The third integer/boolean represents whether or not this plan involves the SEL shipping simulation.
plan_alters_energy_distribution	int	An integer representation of a boolean to indicate whether the plan includes a change to country-specific energy expectancies, relevant to the CEL energy simulation.
layers	object[]	List of layers for which geometry was added, altered or removed, as part of this plan.
grids	object[]	List of energy grid (orchestrated by the CEL energy simulation) that were created, altered or removed, as part of this plan.
fishing	object[]	List of fishing fleets' country-specific effort divisions that were altered by this plan.
messages	object[]	List of messages specific to this plan that were sent around by different users.
restriction_settings	object[]

layers

    "layers": [
         {
           "layer_id": 89,
           "name": "NS_Wave_Farms",
           "layer_editing_type": "sourcepolygon",
           "geometry": [
             {
               "geometry_id": 9127,
               "FID": "08b3e76d-f60e-424a-af12-a82f343634b2",
               "geometry_persistent": 1682,
               "geometry": "[[3607758.75,4075406.75],[3609889.75,4075645.75],[3608873.25,4070194.0],[3606851.75,4070554.75]]",
               "data": {
                 "value": "0",
                 "Type_1": "Turbine 30 MW/km2",
                 "Name": "Wave farms",
                 "starttime": "2008",
                 "Title": "Wave farms"
               },
               "country": 3,
               "type": "0",
               "base_geometry_info": {
                 "geometry_id": 9127,
                 "geometry_mspid": 6647,
                 "geometry_persistent": 1682
               },
               "cable": {
                 "start": {
                   "geometry_id": 9136,
                   "geometry_persistent": 9136
                 },
                 "end": {
                   "geometry_id": 9180,
                   "geometry_persistent": 9180
                 },
                 "coordinates": "[4065.47,3439.221]"
               },
               "energy_output": [
                 {
                   "maxcapacity": 32265329,
                   "active": 1
                 }
               ]
             },
             ...
           ]
           "warnings": [],
           "deleted": [
             {
               "geometry_id": 8111,
               "geometry_mspid": 0,
               "base_geometry_info": {
                 "geometry_id": 8111,
                 "geometry_mspid": 17279,
                 "geometry_persistent": 8111
               }
             }
           ]
         },
         ...

Field	Type	Description
plan_id
plan_country_id
plan_name
plan_gametime
plan_type
plan_alters_energy_distribution

grids

    "grids": [
         {
           "grid_id": 1,
           "grid_persistent": 1,
           "name": "Red-Orange Inter 2",
           "active": 1,
           "energy": [
             {
               "country": 4,
               "expected": 0
             },
             {
               "country": 7,
               "expected": 0
             }
           ],
           "removed": [],
           "sockets": [
             {
               "geometry": {
                 "geometry_id": 9167,
                 "geometry_persistent": 9167
               }
             },
             {
               "geometry": {
                 "geometry_id": 9169,
                 "geometry_persistent": 9169
               }
             }
           ],
           "sources": [
             {
               "geometry": {
                 "geometry_id": 9129,
                 "geometry_persistent": 1684
               }
             }
           ]
         },
         ...
       ]

Field	Type	Description
plan_id
plan_country_id
plan_name
plan_gametime
plan_type
plan_alters_energy_distribution

fishing

"fishing":

Field	Type	Description
plan_id
plan_country_id
plan_name

messages

   "messages": [
         {
           "country_id": 1,
           "user_name": "Admin",
           "text": "Changed the plans status to: Design",
           "time": 1600163971.3005
         }
       ],

Field	Type	Description
plan_id
plan_country_id
plan_name
plan_gametime

restriction_settings

"restriction_settings":

Field	Type	Description
plan_id
plan_country_id
plan_name
plan_gametime

Back to the main configuration data schema page.