Map Sync

Overview

The Map Sync feature of Co-op Helper is a tool intended to ease the process of creating co-op maps by propagating changes made by one person out to everyone else in real time.

This feature may also be useful for making updates to a non-co-op map during playtesting so the playtester can receive those changes immediately.

How To

1. Create a backup of your map file. I have done my best to ensure this feature is bug-free and doesn't corrupt files, but nobody is perfect and mistakes happen. I'd hate to be the reason anyone loses a bunch of work, so make a backup.
2. Send the receiver the mod you're editing.
3. If you send a .zip, have them extract it to their mods folder so their copy is a folder, not a .zip file.
4. Sender and receiver both start the game and load into the map
5. Both of you connect to Celestenet and join a private Celestenet channel.
6. Go to Mod Options -> Co-op Helper -> Map Sync and change it to "Send" or "Receive"

Congrats! Now, when the sender saves changes to the map in loenn, the receiver should automatically get the changes.

The map will also be sent when the sender reloads the map by pressing F5.

Troubleshooting

If the issue crashes your game or causes you to disconnect from CelesteNet, ping @corkr900 in the Mt Celeste Climbing Association discord server and explain the issue.

If the receiver doesn't get the changes and the issue is not a crash:

• Make sure the receiver does not have Loenn open
• Make sure you're in the same private Celestenet channel and can see each other in the game.
• Make sure you have the mod option set to "send" and "receive" as appropriate. Note that it turns itself off when you close and reopen the game.
• Make sure you both have a folder version of the map - not a floating bin file, and not a zip file. If you are editing a floating bin file, put it into the appropriate folder structure first.
• Make sure everyone has the most up-to-date version of Co-op Helper

If these fail, check the log.txt file for any messages that might indicate what's happening.

Requirements and Limitations

• Map Sync is one-directional. You have a sender and one or more receivers. This feature does not support concurrent editing.
• This feature only syncs changes to the map .bin file. If you make changes to dialog, sprites, xml files, yaml files, or anything else that isn't part of the map's .bin file, those changes will not be sent. As a general rule of thumb, anything you do in Loenn will get sent except for the dependencies window.
• Receivers may not have Loenn open. Loenn locks all mod files, so it will prevent the game from writing the updated file.
• This feature can only be used in private CelesteNet channels. Since map files can be quite large, and the server will send the map file to everyone else in the channel, this requirement was added to prevent overloading the CelesteNet server or any other player's network connection.
• This feature requires both the sender and receiver are using a folder-based mod/map. It will not work if either the sender or the receiver has the map in a .zip file.
• You may not be able to use this feature for extremely large maps. To prevent bombarding the server with data, co-op helper will not attempt to send a map that takes more than 200 packets to send to the receiver. If you think you are encountering this, check your log.txt file for messages about it.