- Download the apworld
- Be sure to download the yaml from the release page, as not all the options in the apworld are implemented
- Generate a game and host
- Download and install the app (.apk only for now, Google Play soon, iOS later)
- Open the app and connect using your connection info
- The initial connection message from the server does not show up in the chat. If you see the chat screen, you are connected!
- Wait for the app to generate locations and start playing
Settings can be found and changed in the settings screen (duh). Pressing the ? icon next to the settings name will give a short description of the setting. Bellow is a list of the settings with a longer description.
| Name | Description |
|---|---|
| Automatic reconnection | Determines if the app reconnects to archipelago automatically or not. e.g. if the connection to the archipelago server is lost, should connection be retriedf automatically Default value is on. If you know that you will have a very weak and spotty connection or no connection at all, you should toggle this off. |
| Reconnect attempt amount | Determines how many times the app will try to reconnect to the archipelago server, if connection is lost. If the amount is reached (or is set to 0), the user is told that they have disconnected and be taken back to the connection screen. Defaults to 5. Can't be less than 0. Recommended range: 3 - 10 Note: This setting is ignored if automatic reconnection is turned off. |
| Allow multiple locations on the same road | If enabled, a road can have multiple locations. For example, imagine a road that has three buildings, Building 1, Building 2 and Building 3. If this setting is disabled, only a single location will be on the road, located usually at the middle point of the road. If enabled, all three buildings can be locations separately. Default is off. Should be turned on, if playing in an area with few roads or with many locations to speed up generation. Note: The location generation will selectively act like this setting is enabled, if location a single location takes too many attempts. |
| Location radius | Determines the distance from which a location can be collected (in meters). Because of the variance in locations, you should determine the best value for your area. Allowed values are 10 - 100. Default is 20. |
When a connection is successfully made to an archipelago server, the app asks if you want to save that connection.
Once a connection is saved, it can be found in the Saved Connections screen. The two buttons can be used to edit a saved connection or to delete it.
The list of generated locations is kept with this information, so if you delete or overwrite it, new locations will be generated on connection.
If a location is hinted and it contains either a progression item or an useful item, the marker will be different
By tapping on a marker, a callout will be shown displaying that location's archipelago name.
If this callout is pressed a pop up will open.
If the location is hinted, the hint information will be shown
If not, hint information will be shown, along with a hint button if enough hint points are available.
If the location is locked, displayed with a greyed out icon, the pop up will show similar hint information for a key
If keys have been hinted, the hints will be shown. The hint key button will be hidden, if enough keys have been hinted
The pop up also contains a button than can be used to re-roll the location. This does have a cooldown, currently set to 2 minutes.
If a location is inaccessible, see A location is in an inaccessible area
| Feature | Status |
|---|---|
| Saving and loading connection info | ✔️ |
| Editing saved connections | ✔️ |
| Showing connection / other errors to the user | ✔️ |
| Receiving and sending messages | ✔️ |
| Handling poor connection situations | ❓1 |
| Showing hinted items, e.g. Text clients hints tab | ❌ |
| 1. The app has not been tested in low connectivity situations |
| Feature | Status |
|---|---|
| Generating random coordinates | ✔️ |
| Making sure said coordinates are reachable | ❓2 |
| Saving generated coordinates, so they stay the save between sessions | ✔️ |
| Ability to replace generated coordinates | ✔️ |
| Checking locations and sending them to the server | ✔️ |
| Receiving items from the server | ✔️ |
| Handling items received while not connected | ✔️ |
| Not allowing the player to send a location, if it is locked | ✔️ |
| Showing checkable locations differently from uncheckable locations | ✔️ |
| Handling goal | ✔️/❌3 |
| Prompting the player to release and/or collect on reaching goal | ✔️ |
| Saving starting location and making the player return there between trips | ❌ |
| Scouting nearby locations | ❌ |
| 2. Works in theory, but has not been tested extensively | |
3. One Hard Travelgoal has not yet been implemented |
| Item | Status |
|---|---|
| Progressive Key | ✔️ 4 |
| Macguffins | ✔️ |
| Distance Reductions | ❌ |
| Scouting Distance | ❌ |
| Traps | ❌5 |
| 4. Both short and long macguffin hunts | |
| 5. Traps do nothing functionality, but the player is notified when they are received |
If a generated location is inaccessible for some reason, e.g. forbidden area or not walkable, it can be re-rolled from the location info pop up. Before doing this, please make note of the place ID displayed in the pop up. This is the Open Street Map ID of that location. This ID can be used to get the info of that location and may help in preventing some inaccessible locations in the future.
If you are comfortable with sharing this ID, which can be used to find the location on a map, please send it me over discord directly (@aki665) or in the future-games-design thread
If you are not comfortable with sharing info that may reveal your location, you can still help. By going to https://nominatim.openstreetmap.org/ui/details.html and putting the id there, you can find the information I'm looking for by yourself. I'm mainly interested in the type and extra tags fields, as those seem to hold the most relevant information for exclusion. Please send this information to me over discord directly (@aki665) or in the future-games-design thread
The location generation is not perfect. If there are only a few location that satisfy the maximum and minimum distance, it might take a few tries to find a suitable location. Additionally, the app tries to make non duplicate locations. If either of these take too many tries, the location will eventually be accepted.
Post in the future-games-design thread or open an issue here on github and I'll take a look. If possible, please attach screenshots.