Jak 1: WebWorld setup, some documentation.

This commit is contained in:
massimilianodelliubaldini
2024-04-23 23:36:22 -04:00
parent c497188beb
commit 7f8a41f0a6
3 changed files with 128 additions and 2 deletions

View File

@@ -1,4 +1,4 @@
from BaseClasses import Item, ItemClassification
from BaseClasses import Item, ItemClassification, Tutorial
from .GameID import jak1_id, jak1_name
from .Options import JakAndDaxterOptions
from .Items import JakAndDaxterItem
@@ -6,17 +6,36 @@ from .Locations import JakAndDaxterLocation, location_table as item_table
from .locs import CellLocations as Cells, ScoutLocations as Scouts, OrbLocations as Orbs
from .Regions import create_regions
from .Rules import set_rules
from ..AutoWorld import World
from ..AutoWorld import World, WebWorld
class JakAndDaxterWebWorld(WebWorld):
setup_en = Tutorial(
"Multiworld Setup Guide",
"A guide to setting up ArchipelaGOAL (Archipelago on OpenGOAL).",
"English",
"setup_en.md",
"setup/en",
["markustulliuscicero"]
)
tutorials = [setup_en]
class JakAndDaxterWorld(World):
# ID, name, version
game: str = jak1_name
data_version = 1
required_client_version = (0, 4, 5)
# Options
options_dataclass = JakAndDaxterOptions
options: JakAndDaxterOptions
# Web world
web = JakAndDaxterWebWorld()
# Items and Locations
# Stored as {ID: Name} pairs, these must now be swapped to {Name: ID} pairs.
# Remember, the game ID and various offsets for each item type have already been calculated.
item_name_to_id = {item_table[k]: k for k in item_table}

View File

@@ -0,0 +1,68 @@
# Jak And Daxter (ArchipelaGOAL)
## Where is the options page?
The [Player Options Page](../player-options) for this game contains
all the options you need to configure and export a config file.
At this time, Scout Flies are always randomized despite the option setting... this is a work in progress.
## What does randomization do to this game?
All 101 Power Cells and 112 Scout Flies are now Location Checks
and may contain Items for different games as well as different Items from within Jak and Daxter.
## What is the goal of the game once randomized?
To complete the game, you must defeat the Gol and Maia and stop them from opening the Dark Eco silo.
In order to reach them, you will need at least 72 Power Cells to cross the Lava Tube. In addition, you will need
the four specific Power Cells obtained by freeing the Red, Blue, Yellow, and Green Sages.
## What happens when I pick up an item in the game?
Jak and Daxter will perform their victory animation, if applicable, but you will not necessarily receive the item
you just picked up. The Power Cell count will not change, nor the Scout Fly count, unless you picked up a randomized
Item that just happens to belong to the game. You will however see a message saying what you did find and who it
belongs to.
## How do I get more items to progress in the game?
You can progress by performing the tasks and completing the challenges that would normally give you Power Cells
and Scout Flies in the game. Other players may also find Power Cells and Scout Flies in their games, and those Items
will be automatically sent to your game. When you receive an Item, a Message will pop up to inform you where you
received the Item from, and which one it is. Your Item count for that type of Item will also tick up.
If you have completed all possible tasks available to you but still cannot progress, you may have to wait for another
player to find enough of your game's Items to allow you to progress.
## I can't reach a certain area within an accessible region, how do I get there?
Some areas are locked behind ownership of specific Power Cells. For example, you cannot access Misty Island until you
have the "Catch 200 Pounds of Fish" Power Cell. Keep in mind, your access to Misty Island is determined
_through ownership of this specific Power Cell only,_ **not** _by you completing the Fishing minigame._
## I got soft-locked and can't leave, how do I get out of here?
As stated before, some areas are locked behind ownership of specific Power Cells. But you may already be
past a point-of-no-return preventing you from backtracking. One example is the Forbidden Jungle temple,
where the elevator is locked at the bottom, and if you haven't unlocked the Blue Eco Switch,
you cannot access the Plant Boss's room and escape.
In this scenario, you will need to open your menu and find the "Teleport Home" option. Selecting this option will
instantly teleport you to the nearest Sage's Hut in the last hub area you were in... or always the Green Sage's Hut,
depending on the feasibility of the former option. As stated before... it's a work in progress.
## I think I found a bug, where should I report it?
Depending on the nature of the bug, there are a couple of different options.
* If you found a logical error in the randomizer, please create a new Issue
[here.](https://github.com/ArchipelaGOAL/Archipelago/issues)
* Use this page if:
* For example, you are stuck on Geyser Rock because one of the four Geyser Rock Power Cells is not on Geyser Rock.
* The randomizer did not respect one of the Options you chose.
* You see a mistake, typo, etc. on this webpage.
* Please upload your config file and spoiler log file in the Issue, so we can troubleshoot the problem.
* If you encountered an error in OpenGOAL, please create a new Issue
[here.](https://github.com/ArchipelaGOAL/ArchipelaGOAL/issues)
* Use this page if:
* You encounter a crash, freeze, reset, etc.
* You fail to send Items you find in the game to the Archipelago server.
* You fail to receive Items the server sends to you.
* Your game disconnects from the server and cannot reconnect.
* Please upload any log files that may have been generated.

View File

@@ -0,0 +1,39 @@
# Jak And Daxter (ArchipelaGOAL) Setup Guide
## Required Software
- A legally purchased copy of *Jak And Daxter: The Precursor Legacy.*
## Installation
### Installation via OpenGOAL Mod Launcher
***Windows Preparations***
***Linux Preparations***
***Using the Launcher***
### Manual Compilation (Linux/Windows)
***Windows Preparations***
***Linux Preparations***
***Compiling***
## Starting a Game
### Joining a MultiWorld Game
### Playing Offline
## Installation and Setup Troubleshooting
### Compilation Failures
### Runtime Failures
## Gameplay Troubleshooting
### Known Issues