Skip to content

Commit

Permalink
Docs, Starcraft 2: Add French documentation for setup and game page (#…
Browse files Browse the repository at this point in the history
…3031)

* Started to create the french doc

* First version of sc2 setup in french finish, created the file for the introduction of the game in french

* French-fy upgrade in setup, continue translation of game description

* Finish writing FR game page, added a link to it on the english game page. Re-read and corrected both the game page and setup page.

* Corrected a sentence in the SC2 English setup guide.

* Applied 120 carac limits for french part, applied modification for consistency.

* Added reference to website yaml checker, applied several wording correction/suggestions

* Modified link to AP page to be in relative (fr/en), uniformed SC2 and random writing (fr), applied some suggestons in writing quality(fr), added a mention to the datapackage (fr/en), enhanced prog balancing recommendation (fr)

* Correction of some grammar issues

* Removed name correction for english part since done in other PR; added mention to hotkey and language restriction

* Applied suggestions of peer review

* Applied mofications proposed by reviewer about the external website

---------

Co-authored-by: neocerber <[email protected]>
  • Loading branch information
neocerber and neocerber authored May 29, 2024
1 parent 649ee11 commit 5275593
Show file tree
Hide file tree
Showing 5 changed files with 339 additions and 10 deletions.
13 changes: 11 additions & 2 deletions worlds/sc2/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@


class Starcraft2WebWorld(WebWorld):
setup = Tutorial(
setup_en = Tutorial(
"Multiworld Setup Guide",
"A guide to setting up the Starcraft 2 randomizer connected to an Archipelago Multiworld",
"English",
Expand All @@ -31,7 +31,16 @@ class Starcraft2WebWorld(WebWorld):
["TheCondor", "Phaneros"]
)

tutorials = [setup]
setup_fr = Tutorial(
setup_en.tutorial_name,
setup_en.description,
"Français",
"setup_fr.md",
"setup/fr",
["Neocerber"]
)

tutorials = [setup_en, setup_fr]


class SC2World(World):
Expand Down
5 changes: 4 additions & 1 deletion worlds/sc2/docs/en_Starcraft 2.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Starcraft 2

## Game page in other languages:
* [Français](/games/Starcraft%202/info/fr)

## What does randomization do to this game?

The following unlocks are randomized as items:
Expand Down Expand Up @@ -39,7 +42,7 @@ The goal is to beat the final mission in the mission order. The yaml configurati
## Which of my items can be in another player's world?

By default, any of StarCraft 2's items (specified above) can be in another player's world. See the
[Advanced YAML Guide](https://archipelago.gg/tutorial/Archipelago/advanced_settings/en)
[Advanced YAML Guide](/tutorial/Archipelago/advanced_settings/en)
for more information on how to change this.

## Unique Local Commands
Expand Down
95 changes: 95 additions & 0 deletions worlds/sc2/docs/fr_Starcraft 2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# *StarCraft 2*

## Quel est l'effet de la *randomization* sur ce jeu ?

Les éléments qui suivent sont les *items* qui sont *randomized* et qui doivent être débloqués pour être utilisés dans
le jeu:
1. La capacité de produire des unités, excepté les drones/probes/scv.
2. Des améliorations spécifiques à certaines unités incluant quelques combinaisons qui ne sont pas disponibles dans les
campagnes génériques, comme le fait d'avoir les deux types d'évolution en même temps pour une unité *Zerg* et toutes
les améliorations de la *Spear of Adun* simultanément pour les *Protoss*.
3. L'accès aux améliorations génériques des unités, e.g. les améliorations d'attaque et d'armure.
4. D'autres améliorations diverses telles que les améliorations de laboratoire et les mercenaires pour les *Terran*,
les niveaux et les améliorations de Kerrigan pour les *Zerg*, et les améliorations de la *Spear of Adun* pour les
*Protoss*.
5. Avoir des *minerals*, du *vespene gas*, et du *supply* au début de chaque mission.

Les *items* sont trouvés en accomplissant du progrès dans les catégories suivantes:
* Terminer des missions
* Réussir des objectifs supplémentaires (e.g., récolter le matériel pour les recherches dans *Wings of Liberty*)
* Atteindre des étapes importantes dans la mission, e.g. réussir des sous-objectifs
* Réussir des défis basés sur les succès du jeu de base, e.g. éliminer tous les *Zerg* dans la mission
*Devil's Playground*

Ces catégories, outre la première, peuvent être désactivées dans les options du jeu.
Par exemple, vous pouvez désactiver le fait d'obtenir des *items* lorsque des étapes importantes d'une mission sont
accomplies.

Quand vous recevez un *item*, il devient immédiatement disponible, même pendant une mission, et vous serez avertis via
la boîte de texte situé dans le coin en haut à droite de *StarCraft 2*.
L'acquisition d'un *item* est aussi indiquée dans le client d'Archipelago.

Les missions peuvent être lancées par le client *StarCraft 2 Archipelago*, via l'interface graphique de l'onglet
*StarCraft 2 Launcher*.
Les segments qui se passent sur l'*Hyperion*, un Léviathan et la *Spear of Adun* ne sont pas inclus.
De plus, les points de progression tels que les crédits ou la Solarite ne sont pas utilisés dans *StarCraft 2
Archipelago*.

## Quel est le but de ce jeu quand il est *randomized*?

Le but est de réussir la mission finale dans la disposition des missions (e.g. *blitz*, *grid*, etc.).
Les choix faits dans le fichier *yaml* définissent la disposition des missions et comment elles sont mélangées.

## Quelles sont les modifications non aléatoires comparativement à la version de base de *StarCraft 2*

1. Certaines des missions ont plus de *vespene geysers* pour permettre l'utilisation d'une plus grande variété d'unités.
2. Plusieurs unités et améliorations ont été ajoutées sous la forme d*items*.
Ils proviennent de la version *co-op*, *melee*, des autres campagnes, d'expansions ultérieures, de *Brood War*, ou de
l'imagination des développeurs de *StarCraft 2 Archipelago*.
3. Les structures de production, e.g. *Factory*, *Starport*, *Robotics Facility*, and *Stargate*, n'ont plus
d'exigences technologiques.
4. Les missions avec la race *Zerg* ont été modifiées pour que les joueurs débuttent avec un *Lair* lorsqu'elles
commençaient avec une *Hatchery*.
5. Les désavantages des améliorations ont été enlevés, e.g. *automated refinery* qui coûte plus cher ou les *tech
reactors* qui prennent plus de temps à construire.
6. La collision des unités dans les couloirs de la mission *Enemy Within* a été ajustée pour permettre des unités
plus larges de les traverser sans être coincés dans des endroits étranges.
7. Plusieurs *bugs* du jeu original ont été corrigés.

## Quels sont les *items* qui peuvent être dans le monde d'un autre joueur?

Par défaut, tous les *items* de *StarCraft 2 Archipelago* (voir la section précédente) peuvent être dans le monde d'un
autre joueur.
Consulter [*Advanced YAML Guide*](/tutorial/Archipelago/advanced_settings/en) pour savoir comment
changer ça.

## Commandes du client qui sont uniques à ce jeu

Les commandes qui suivent sont seulement disponibles uniquement pour le client de *StarCraft 2 Archipelago*.
Vous pouvez les afficher en utilisant la commande `/help` dans le client de *StarCraft 2 Archipelago*.
Toutes ces commandes affectent seulement le client où elles sont utilisées.

* `/download_data` Télécharge les versions les plus récentes des fichiers pour jouer à *StarCraft 2 Archipelago*.
Les fichiers existants vont être écrasés.
* `/difficulty [difficulty]` Remplace la difficulté choisie pour le monde.
* Les options sont *casual*, *normal*, *hard*, et *brutal*.
* `/game_speed [game_speed]` Remplace la vitesse du jeu pour le monde.
* Les options sont *default*, *slower*, *slow*, *normal*, *fast*, and *faster*.
* `/color [faction] [color]` Remplace la couleur d'une des *factions* qui est jouable.
* Les options de *faction*: raynor, kerrigan, primal, protoss, nova.
* Les options de couleur: *white*, *red*, *blue*, *teal*, *purple*, *yellow*, *orange*, *green*, *lightpink*,
*violet*, *lightgrey*, *darkgreen*, *brown*, *lightgreen*, *darkgrey*, *pink*, *rainbow*, *random*, *default*.
* `/option [option_name] [option_value]` Permet de changer un option normalement définit dans le *yaml*.
* Si la commande est lancée sans option, la liste des options qui sont modifiables va être affichée.
* Les options qui peuvent être changées avec cette commande incluent sauter les cinématiques automatiquement, la
présence de Kerrigan dans les missions, la disponibilité de la *Spear of Adun*, la quantité de ressources
supplémentaires données au début des missions, la capacité de contrôler les alliées IA, etc.
* `/disable_mission_check` Désactive les requit pour lancer les missions.
Cette option a pour but de permettre de jouer en mode coopératif en permettant à un joueur de jouer à la prochaine
mission de la chaîne qu'un autre joueur est en train d'entamer.
* `/play [mission_id]` Lance la mission correspondant à l'identifiant donné.
* `/available` Affiche les missions qui sont présentement accessibles.
* `/unfinished` Affiche les missions qui sont présentement accessibles et dont certains des objectifs permettant
l'accès à un *item* n'ont pas été accomplis.
* `/set_path [path]` Permet de définir manuellement où *StarCraft 2* est installé ce qui est pertinent seulement si la
détection automatique de cette dernière échoue.
22 changes: 15 additions & 7 deletions worlds/sc2/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,20 @@ Yaml files are configuration files that tell Archipelago how you'd like your gam
When you're setting up a multiworld, every world needs its own yaml file.

There are three basic ways to get a yaml:
* You can go to the [Player Options](https://archipelago.gg/games/Starcraft%202/player-options) page, set your options in the GUI, and export the yaml.
* You can generate a template, either by downloading it from the [Player Options](https://archipelago.gg/games/Starcraft%202/player-options) page or by generating it from the Launcher (ArchipelagoLauncher.exe). The template includes descriptions of each option, you just have to edit it in your text editor of choice.
* You can go to the [Player Options](/games/Starcraft%202/player-options) page, set your options in the GUI, and export the yaml.
* You can generate a template, either by downloading it from the [Player Options](/games/Starcraft%202/player-options) page or by generating it from the Launcher (ArchipelagoLauncher.exe). The template includes descriptions of each option, you just have to edit it in your text editor of choice.
* You can ask someone else to share their yaml to use it for yourself or adjust it as you wish.

Remember the name you enter in the options page or in the yaml file, you'll need it to connect later!

Check out [Creating a YAML](https://archipelago.gg/tutorial/Archipelago/setup/en#creating-a-yaml) for more game-agnostic information.
Check out [Creating a YAML](/tutorial/Archipelago/setup/en#creating-a-yaml) for more game-agnostic information.

### Common yaml questions
#### How do I know I set my yaml up correctly?

The simplest way to check is to test it out. Save your yaml to the Players/ folder within your Archipelago installation and run ArchipelagoGenerate.exe. You should see a new .zip file within the output/ folder of your Archipelago installation if things worked correctly. It's advisable to run ArchipelagoGenerate through a terminal so that you can see the printout, which will include any errors and the precise output file name if it's successful. If you don't like terminals, you can also check the log file in the logs/ folder.
The simplest way to check is to use the website [validator](/check).

You can also test it by attempting to generate a multiworld with your yaml. Save your yaml to the Players/ folder within your Archipelago installation and run ArchipelagoGenerate.exe. You should see a new .zip file within the output/ folder of your Archipelago installation if things worked correctly. It's advisable to run ArchipelagoGenerate through a terminal so that you can see the printout, which will include any errors and the precise output file name if it's successful. If you don't like terminals, you can also check the log file in the logs/ folder.

#### What does Progression Balancing do?

Expand Down Expand Up @@ -64,9 +66,15 @@ start_inventory:

An empty mapping is just a matching pair of curly braces: `{}`. That's the default value in the template, which should let you know to use this syntax.

#### How do I know the exact names of items?
#### How do I know the exact names of items and locations?

The [*datapackage*](/datapackage) page of the Archipelago website provides a complete list of the items and locations for each game that it currently supports, including StarCraft 2.

You can also look up a complete list of the item names in the [Icon Repository](https://matthewmarinets.github.io/ap_sc2_icons/) page.
This page also contains supplementary information of each item.
However, the items shown in that page might differ from those shown in the datapackage page of Archipelago since the former is generated, most of the time, from beta versions of StarCraft 2 Archipelago undergoing development.

You can look up a complete list if item names in the [Icon Repository](https://matthewmarinets.github.io/ap_sc2_icons/).
As for the locations, you can see all the locations associated to a mission in your world by placing your cursor over the mission in the 'StarCraft 2 Launcher' tab in the client.

## How do I join a MultiWorld game?

Expand All @@ -86,7 +94,7 @@ specific description of what's going wrong and attach your log file to your mess

## Running in macOS

To run StarCraft 2 through Archipelago in macOS, you will need to run the client via source as seen here: [macOS Guide](https://archipelago.gg/tutorial/Archipelago/mac/en). Note: when running the client, you will need to run the command `python3 Starcraft2Client.py`.
To run StarCraft 2 through Archipelago in macOS, you will need to run the client via source as seen here: [macOS Guide](/tutorial/Archipelago/mac/en). Note: to launch the client, you will need to run the command `python3 Starcraft2Client.py`.

## Running in Linux

Expand Down
Loading

0 comments on commit 5275593

Please sign in to comment.