mirror/Archipelago
1
0
Fork 1
mirror of https://github.com/ArchipelagoMW/Archipelago.git synced 2026-03-25 02:23:37 -07:00
Code Issues Packages Projects Releases Wiki Activity

Jak 1: Update Documentation.

Browse Source
This commit is contained in:
massimilianodelliubaldini
2024-05-09 12:48:33 -04:00
parent f4a51a8f4a
commit 6637452b64
2 changed files with 72 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
worlds/jakanddaxter/docs/en_Jak and Daxter The Precursor Legacy.md
View File

@@ -5,7 +5,8 @@
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.
At this time, these options don't do anything. Scout Flies are always randomized, and Precursor Orbs
are never randomized.
## What does randomization do to this game?
All 101 Power Cells and 112 Scout Flies are now Location Checks
@@ -14,38 +15,44 @@ and may contain Items for different games as well as different Items from within
## 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.
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 progress through the game?
You can progress by performing tasks and completing the challenges that would normally give you Power Cells and
Scout Flies in the game. If you are playing with others, those players may find Power Cells and Scout Flies
in their games, and those Items will be automatically sent to your game.
## 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. If that does not apply,
double check your spoiler log to make sure you have all the items you should have. If you don't,
you may have encountered a bug. Please see the options for bug reporting below.
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.
## What happens when I pick up an item?
Jak and Daxter will perform their victory animation, if applicable. You will not receive that item, and
the Item count for that item will not change. The pause menu will say "Task Completed" below the
picked-up Power Cell, but the icon will remain "dormant." You will see a message in your text client saying
what you found and who it belongs to.
## What happens when I receive an item?
Jak and Daxter won't perform their victory animation, and gameplay will continue as normal. Your text client will
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. The pause menu will not say "Task Completed" below the selected Power Cell, but the icon will be "activated."
## 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
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.
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.
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 to
the Green Sage's Hut, depending on the feasibility of the former option. This feature is 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.

42
worlds/jakanddaxter/docs/setup_en.md
View File

@@ -3,11 +3,15 @@
## Required Software
- A legally purchased copy of *Jak And Daxter: The Precursor Legacy.*
- Python version 3.10 or higher. Make sure this is added to your PATH environment variable.
- [Task](https://taskfile.dev/installation/) (This makes it easier to run commands.)
## Installation
### Installation via OpenGOAL Mod Launcher
At this time, the only supported method of setup is through Manual Compilation. Aside from the legal copy of the game, all tools required to do this are free.
***Windows Preparations***
***Linux Preparations***
@@ -18,22 +22,58 @@
***Windows Preparations***
- Dump your copy of the game as an ISO file to your PC.
- Download a zipped up copy of the Archipelago Server and Client [here.](https://github.com/ArchipelaGOAL/Archipelago)
- Download a zipped up copy of the modded OpenGOAL game [here.](https://github.com/ArchipelaGOAL/ArchipelaGOAL)
- Unzip the two projects into easily accessible directories.
***Linux Preparations***
***Compiling***
## Starting a Game
- Open 3 Powershell windows. If you have VSCode, you can run 3 terminals to consolidate this process.
- In the first window, navigate to the Archipelago folder using `cd` and run `python ./Launcher.py`.
- In the second window, navigate to the ArchipelaGOAL folder and run `task extract`. This will prompt you to tell the mod where to find your ISO file to dump its cotnents. When that is done, run `task repl`.
- In the third window, navigate to the ArchipelaGOAL folder and run `task boot-game`. At this point, Jak should be standing outside Samos's hut.
- In the Launcher, click Generate to create a new random seed. Save the resulting zip file.
- In the Launcher, click Host to host the Archipelago server. It will prompt you for the location of that zip file.
- Once the server is running, in the Launcher, find the Jak and Daxter Client and click it. You should see the `task repl` window begin to compile the game.
- When it completes, you should hear the menu closing sound effect, and the Client window should appear.
- Connect the client to the Archipelago server and enter your slot name. Once this is done, the game should be ready to play. Talk to Samos to trigger the cutscene where he sends you to Geyser Rock, and off you go!
Once you complete the setup steps, you need to repeat most of them in order to launch a new game. You can skip a few steps:
- You never need to download the zip copies of the projects again (unless there are updates).
- You never need to dump your ISO again.
- You never need to extract the ISO assets again.
### Joining a MultiWorld Game
MultiWorld games are untested at this time.
### Playing Offline
Offline play is untested at this time.
## Installation and Setup Troubleshooting
### Compilation Failures
### Runtime Failures
- If the client window appears but no sound plays, you will need to enter the repl commands into the client to connect it to the game. These are, in order:
- `/repl connect 127.0.0.1 8181`
- `/repl listen`
- `/repl compile`
- Once these are done, you can enter `/repl verify` and you should hear the menu sound again.
## Gameplay Troubleshooting
### Known Issues
### Known Issues
- Needing to open so many windows to play the game is a massive pain, and I hope to streamline this process in the future.
- The game needs to run in debug mode in order to allow the repl to connect to it. At some point I want to make sure it can run in retail mode, or at least hide the debug text on screen and play the game's introductory cutscenes properly.
- The client is currently not very robust and doesn't handle failures gracefully. This may result in items not being delivered to the game, or location checks not being delivered to the server.
- The game relates tasks and power cells closely but separately. Some issues may result from having to tell the game to check for the power cells you own, rather than the tasks you completed.