Skip to content

Latest commit

 

History

History
190 lines (146 loc) · 6.08 KB

Contributing.md

File metadata and controls

190 lines (146 loc) · 6.08 KB
Raw

Contributing Guide

As mentioned in the ReadMe, the framework used is ArcGIS, here's some info on it:

Here's a general rundown:

Updating layer data

The current approach for getting data from the game onto the map is as follows.

1. Install CoordinateViewer

This entails installing the Unity mod manager, SailwindModdingHelper and the mod itself. The latter two can be found on the Sailwind Discord.

2. Change settings

Set the viewer settings to max frequency and percision. This is typically capped at 8 decimals and 5 Hz, though more would be better since we can easily remove points later.

<?xml version="1.0" encoding="utf-8"?>
<CoordinateViewerSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DecimalPrecision>8</DecimalPrecision>
  <RecordTimer>5</RecordTimer>
  <coordinateKey>
    <keyCode>I</keyCode>
    <modifiers>0</modifiers>
  </coordinateKey>
  <recordKey>
    <keyCode>N</keyCode>
    <modifiers>0</modifiers>
  </recordKey>
</CoordinateViewerSettings>

3. Record data

Create the island shape by walking around it while coordinate recording is enabled. This should generate a file that looks roughly like so:

28.1286563873 3.0316991806 15.974 332.9382
28.1307353973 3.0300571918 16.01409 332.9251
28.131778717 3.0269908905 16.05412 332.9241
28.1348724365 3.0267660618 16.09426 332.924
28.136882782 3.0233945847 16.13429 332.924
28.1391849518 3.0216836929 16.17444 326.8558

Recordings of current islands can be found in raw_coords. I would suggest including yours as well so they can be re-imported in the future if anything needs changing at some future date.

4. Import Coords

Find the coords_0.txt file in C:\Program Files (x86)\Steam\steamapps\common\Sailwind\Mods\CoordinateViewer and import it onto the web map.

Note that doing multiple recordings in a row will just concat data to the same file, so this is a good time to rename it to something else.

5. Edit the path

Remove any points on straight sections to reduce point count and fix any other issues, note that the first and last point will connect together to form a polygon.

After you're done, open the console with F12 and run pathToData(). This should spit out the coordinates formatted properly for addition:

[
    [
        -0.25970255636522,
        33.14784326860706
    ],
    [
        1.00000000000000,
        34.90667325296604
    ],
    [
        -0.99650971197506,
        34.83536933468122
    ],
    [
        -1.56694105825365,
        33.71827461488565
    ]
]

6. Open polygon_definitions.js

Regular data should be added to the geoJson var, and secrets to secretJson.

"properties": {
    "Region": "Emerald Archipelago",
    "Name": "Sage Hils",
    "SHAPE_Area": 0.00107592977215,
    "Latitude": 30.893699645996094,
    "Longitude": 4.472690105438232
}

Region can be one of either: "Emerald Archipelago", "Al'Ankh", "Happy Bay", "Fire Fish Lagoon", "Aestrin", "City", or "Rock". These are set in main.js as different rendering styles, but as of now all regions render in the same orange colour, City renders as red and Rock/Sand renders as gray.

Name refers to the actual label that will be rendered above the polygon, can be left as empty string if the island doesn't have a name.

SHAPE_Area, Latitude, and Longitude are unused legacy params and can be left at whatever.

The features can be either a single Polygon or a MultiPolygon array of them. The latter is presumably more preformant with only one draw call and it's probably best to merge together all unnamed islands and rocks in the same region.

Here's an example of both options:

"type": "Feature",
"geometry": {
    "type": "Polygon",
    "coordinates": [
        [
            [
                4.75075891704177,
                31.35304322705834
            ],
            [
                4.75067758560000,
                31.35126113890000
            ],
            [
                4.74902057650000,
                31.35179901120000
            ]
        ]
}

Make sure the brackets are right, otherwise the map will fail at loading the file.

"type": "MultiPolygon",
"coordinates": [
    [
        [
            [
                4.75075891704177,
                31.35304322705834
            ],
            [
                4.75067758560000,
                31.35126113890000
            ],
            [
                4.74902057650000,
                31.35179901120000
            ]
        ]
    ],
    [
        [
            [
                4.78302669530000,
                31.30674934390000
            ],
            [
                4.78072166440000,
                31.31055641170000
            ],
            [
                4.78203344350000,
                31.31355285640000
            ]
        ]
    ]

The labelled islands are easy enough to find by name, but the rest have no labels and could be anything, so deducing what is what often requires looking up the coordinate points of a polygon on the map. This could use a major refactor (probably by script to group together areas into separate files), but for now at it's at least good practice to keep the same general area polygons consecutive to each other.