-
Notifications
You must be signed in to change notification settings - Fork 4
Adding or updating a created map in the game
This documentation provides a guide to adding or updating an existing map (for which an sd7 file is already prepared) in the game so that players can use it. Guides and checklists on how to create a map are not covered here.
You can upload the map file to https://springfiles.springrts.com/. It makes it available across all Recoil/Spring Engine games.
Alternatively, you can upload the file directly to BAR CDN, skipping SpringFiles. To do so, upload the map file to the Google Cloud Storage Bucket bar-springfiles-syncer_assets-upload from where it will be transferred directly to our CDN. All members of the BAR’s Google Group (that included contributors) have permission to do this.
Sign in to our Rowy instance: https://rowy.beyondallreason.dev/. By default you will only have a viewer role. You need to ask Marek, Nikuksis, Beherith or IceXuick to get an editor role.
In the Maps table: If you are adding an entirely new map, click “Add row”. If you are updating the map, locate it on the list and modify its details.
-
Start with the “spring name” column. When you fill it in, the “Parse” column will show text “Parsing…”. Once parsing is successful it will change to “Done” and automatically fill in a few of the fields.
💡Tip: If “Parsing…” doesn’t change to “Done” after quite a bit of waiting (more than a minute), you can change the spring name column to something different e.g. add some random characters: “All That Glitters v2.1xxx”, the field will switch to “Map not found”, and then you can change it back to the correct spring name to retrigger parsing.
-
Fill in the “Author” column.
-
Upload the map screenshot from the previous step to the “Photo” column.
-
Populate the other fields with the relevant details.
See the Rowy Maps fields legend documentation page for the description of all of the fields.
Click the “Open PR 🔀” button located in the last column of the row you added to Rowy. This will after a moment generate a new GitHub pull request in the maps-metadata repository containing your changes. See this example merged pull request.
A map curator will review the pull request and merge it if there are no issues. If problems exist, they will connect with you via Discord to address them.
You can update the open pull request with new changes by clicking the “Open PR 🔀” button again.
ℹInfo: If you forget to click the button, every 24 hours automation creates a pull request with all changes in Rowy to keep the repository and Rowy in sync.
💡Tip: You can trigger syncing for all maps manually by starting the Sync Map GitHub workflow in the repository. It’s useful for big changes that are touching many maps, e.g. adding a new column filled in for many maps.
After your pull request gets merged, there is nothing more to do, the automation takes over and pushes the map automatically to all the places it's supposed to be in. You game will be available in game within a few minutes.