Skip to content

Base of documentation for builders#131

Open
coverprice wants to merge 1 commit into
SupraGamesCommunity:mainfrom
coverprice:build_docs
Open

Base of documentation for builders#131
coverprice wants to merge 1 commit into
SupraGamesCommunity:mainfrom
coverprice:build_docs

Conversation

@coverprice
Copy link
Copy Markdown
Collaborator

Added the beginnings of a usage doc for Build Mode users, based on testing plan docs from #93 . This can be the foundation for a more sophisticated user guide.

@coverprice coverprice requested a review from jules43 April 30, 2026 04:54
@jules43
Copy link
Copy Markdown
Collaborator

jules43 commented Apr 30, 2026

Makes sense. Worth noting that I have some ideas on how to improve build mode (and custom pins) to make it a bit more user friendly (and consistent) partly based on how Animal Well does it.

Custom pins bit:
#113

With the custom pins done updating Build Mode would hopefully be pretty easy:
#112 (contains multiple child tasks)

The work flow would still be to make changes that are kept in a change list in local storage and then export them via a text file or the clipboard to get them into the base map data.

Copy link
Copy Markdown
Collaborator

@jules43 jules43 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should distinguish between custom map pins (a normal user-centric feature) and build mode (specifically aimed at adding UGC changes to the map.

Custom map pins is aimed at having the map running along side the game and dropping map pins on to the map as notes to yourself. Ideally you'd be able to change the appearance of a custom pin and add a title/note, and then save/load your custom pins.

At the moment if you want to add a new UGC feature to the base map you can use custom pins to help you do that but its a hack.

  1. Place a custom pin where you want it
  2. Copy custom pins to clipboard
  3. Paste custom pins to a file
  4. Add a set of area:name:type:lat:lng:alt blanks to custom json
  5. Copy your custom pin positions and reformat as lat/lng/alt in custom json
  6. Customise the blanks
  7. Reload the map

As mentioned in my comment I have a set of proposals that might be fairly quick to do to make this much easier.

Copy link
Copy Markdown
Collaborator

@jules43 jules43 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comments on the discussion thread but no reason not to merge it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants