From 97c313c1c4ed7fc889ce7ab074d0312b0f5829f8 Mon Sep 17 00:00:00 2001 From: Emily <35015090+EmilyV99@users.noreply.github.com> Date: Thu, 29 Aug 2024 02:12:58 -0400 Subject: [PATCH] APSudoku: Update setup guide, remove extraneous options page link (#3849) * APSudoku: Update setup guide, remove extraneous options page link * Apply suggestions from code review Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> * clean up instructions * IP -> address --------- Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --- worlds/apsudoku/__init__.py | 2 +- worlds/apsudoku/docs/setup_en.md | 36 +++++++++++++++++++------------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/worlds/apsudoku/__init__.py b/worlds/apsudoku/__init__.py index c6bd02bd..04422ddb 100644 --- a/worlds/apsudoku/__init__.py +++ b/worlds/apsudoku/__init__.py @@ -4,7 +4,7 @@ from BaseClasses import Tutorial from ..AutoWorld import WebWorld, World class AP_SudokuWebWorld(WebWorld): - options_page = "games/Sudoku/info/en" + options_page = False theme = 'partyTime' setup_en = Tutorial( diff --git a/worlds/apsudoku/docs/setup_en.md b/worlds/apsudoku/docs/setup_en.md index cf2c755b..ef5a87e0 100644 --- a/worlds/apsudoku/docs/setup_en.md +++ b/worlds/apsudoku/docs/setup_en.md @@ -1,9 +1,7 @@ # APSudoku Setup Guide ## Required Software -- [APSudoku](https://github.com/EmilyV99/APSudoku) -- Windows (most tested on Win10) -- Other platforms might be able to build from source themselves; and may be included in the future. +- [APSudoku](https://github.com/APSudoku/APSudoku) ## General Concept @@ -13,25 +11,33 @@ Does not need to be added at the start of a seed, as it does not create any slot ## Installation Procedures -Go to the latest release from the [APSudoku Releases page](https://github.com/EmilyV99/APSudoku/releases). Download and extract the `APSudoku.zip` file. +Go to the latest release from the [APSudoku Releases page](https://github.com/APSudoku/APSudoku/releases/latest). Download and extract the appropriate file for your platform. ## Joining a MultiWorld Game -1. Run APSudoku.exe -2. Under the 'Archipelago' tab at the top-right: - - Enter the server url & port number +1. Run the APSudoku executable. +2. Under `Settings` → `Connection` at the top-right: + - Enter the server address and port number - Enter the name of the slot you wish to connect to - Enter the room password (optional) - Select DeathLink related settings (optional) - - Press connect -3. Go back to the 'Sudoku' tab - - Click the various '?' buttons for information on how to play / control -4. Choose puzzle difficulty -5. Try to solve the Sudoku. Click 'Check' when done. + - Press `Connect` +4. Under the `Sudoku` tab + - Choose puzzle difficulty + - Click `Start` to generate a puzzle +5. Try to solve the Sudoku. Click `Check` when done + - A correct solution rewards you with 1 hint for a location in the world you are connected to + - An incorrect solution has no penalty, unless DeathLink is enabled (see below) +Info: +- You can set various settings under `Settings` → `Sudoku`, and can change the colors used under `Settings` → `Theme`. +- While connected, you can view the `Console` and `Hints` tabs for standard TextClient-like features +- You can also use the `Tracking` tab to view either a basic tracker or a valid [GodotAP tracker pack](https://github.com/EmilyV99/GodotAP/blob/main/tracker_packs/GET_PACKS.md) +- While connected, the number of "unhinted" locations for your slot is shown in the upper-left of the the `Sudoku` tab. (If this reads 0, no further hints can be earned for this slot, as every locations is already hinted) +- Click the various `?` buttons for information on controls/how to play ## DeathLink Support -If 'DeathLink' is enabled when you click 'Connect': -- Lose a life if you check an incorrect puzzle (not an _incomplete_ puzzle- if any cells are empty, you get off with a warning), or quit a puzzle without solving it (including disconnecting). -- Life count customizable (default 0). Dying with 0 lives left kills linked players AND resets your puzzle. +If `DeathLink` is enabled when you click `Connect`: +- Lose a life if you check an incorrect puzzle (not an _incomplete_ puzzle- if any cells are empty, you get off with a warning), or if you quit a puzzle without solving it (including disconnecting). +- Your life count is customizable (default 0). Dying with 0 lives left kills linked players AND resets your puzzle. - On receiving a DeathLink from another player, your puzzle resets.