1b200fb20b
* Add cccharles world to AP > The logic has been tested, the game can be completed > The logic is simple and it does not take into account options ! The documentations are a work in progress * Update documentations > Redacted French and English Setup Guides > Redacted French and English Game Pages * Handling PR#5287 remarks > Revert unexpected changes on .run\Archipelago Unittests.run.xml (base Archipelago file) > Fixed typo "querty" -> "qwerty" in fr and eng Game Pages > Adding "Game page in other languages" section to eng Game Page documentation > Improved Steam path in fr and eng Setup Guides * Handled PR remarks + fixes > Added get_filler_item_name() to remove warnings > Fixed irrelevant links for documentations > Used the Player Options page instead of the default YAML on GitHub > Reworded all locations to make them simple and clear > Split some locations that can be linked with an entrance rule > Reworked all options > Updated regions according to locations > Replaced unnecessary rules by rules on entrances * Empty Options.py Only the base options are handled yet, "work in progress" features removed. * Handled PR remark > Fixed specific UT name * Handled PR remarks > UT updated by replacing depreciated features * Add start_inventory_from_pool as option This start_inventory_from_pool option is like regular start inventory but it takes items from the pool and replaces them with fillers Co-authored-by: Scipio Wright <scipiowright@gmail.com> * Handled PR remarks > Mainly fixed editorial and minor issues without impact on UT results (still passed) * Update the guides according to releases > Updated the depreciated guides because the may to release the Mod has been changed > Removed the fixed issues from 'Known Issues' > Add the "Mod Download" section to simplify the others sections. * Handled PR remark > base_id reduced to ensure it fits to signed int (32 bits) in case of future AP improvements * Handled PR remarks > Set topology_present to False because unnecessary > Added an exception in case of unknown item instead of using filler classification > Fixed an issue that caused the "Bug Spray" to be considered as filler > Reworked the test_claire_breakers() test to ensure the lighthouse mission can only be finished if at least 4 breakers are collected * Added Choo-Choo Charles to README.md * CCCharles: Added rules to win > The victory could be accessed from sphere 1, this is now fixed by adding the following items as requirements: - Temple Key - Green Egg - Blue Egg - Red Egg --------- Co-authored-by: Scipio Wright <scipiowright@gmail.com>
3.6 KiB
3.6 KiB
Choo-Choo Charles MultiWorld Setup Guide
This page is a simplified guide of the Choo-Choo Charles Multiworld Randomizer Mod page.
Requirements and Required Softwares
- A computer running Windows (the Mod is not handled by Linux or Mac)
- Archipelago
- A legal copy of the Choo-Choo Charles original game (can be found on Steam)
Mod Installation for playing
Mod Download
All the required files of the Mod can be found in the Releases. To use the Mod, download and unzip CCCharles_Random.zip somewhere safe, then follow the instructions in the next sections of this guide. This archive contains:
- The Obscure/ folder loading the Mod itself, it runs the code handling all the randomized elements
- The cccharles.apworld file containing the randomization logic, used by the host to generate a random seed with the others games
Game Setup
The Mod can be installed and played by following these steps (see the Mod Download section to get CCCharles_Random.zip):
- Copy the Obscure/ folder from CCCharles_Random.zip to <GameFolder> (where the Obscure/ folder and Obscure.exe are placed)
- Launch the game, if "OFFLINE" is visible in the upper-right corner of the screen, the Mod is working
Create a Config (.yaml) File
The purpose of a YAML file is described in the Basic Multiworld Setup Guide.
The Player Options page allows to configure personal options and export a config YAML file.
Joining a MultiWorld Game
Before playing, it is highly recommended to check out the Known Issues section
- The game console must be opened to type Archipelago commands, press "F10" key or "`" (or "~") key in querty ("²" key in azerty)
- Type
/connect <IP> <PlayerName>with <IP> and <PlayerName> found on the hosting Archipelago web page in the formarchipelago.gg:XXXXXandCCCharles - Disconnection is automatic at game closure but can be manually done with
/disconnect
Hosting a MultiWorld or Single-Player Game
See the Mod Download section to get the cccharles.apworld file.
In this section, Archipelago/ refers to the path where Archipelago is installed locally.
Follow these steps to host a remote multiplayer or a local single-player session:
- Double-click the cccharles.apworld to automatically install the world randomization logic
- Put the CCCharles.yaml to Archipelago/Players/ with the YAML of each player to host
- Launch the Archipelago launcher and click "Generate" to configure a game with the YAMLs in Archipelago/output/
- For a multiplayer session, go to the Archipelago HOST GAME page
- Click "Upload File" and select the generated AP_<seed>.zip in Archipelago/output/
- Send the generated room page to each player
For a local single-player session, click "Host" in the Archipelago launcher by using the generated AP_<seed>.zip in Archipelago/output/
Known Issues
Major issues
No major issue found.
Minor issues
- The current version of the command parser does not accept console commands with a player names containing whitespaces. It is recommended to use underscores "_" instead, for instance: CCCharles_Player_1.