From d817fdcfdb65138ec589d4c2627a98f9aa1fe397 Mon Sep 17 00:00:00 2001 From: black-sliver <59490463+black-sliver@users.noreply.github.com> Date: Fri, 29 Jul 2022 01:18:59 +0200 Subject: [PATCH] Doc: move Running from source from wiki to docs (#797) * Doc: move "Running from source" from wiki to docs/ * Doc: update links and reformat running from source * Doc: implement suggestions in "Running from source" thanks @alwaysintreble * Doc: update link to "Running from source" also link docs/ folder * Doc: Running from source: Apply suggestions from code review Co-authored-by: KonoTyran Co-authored-by: KonoTyran --- README.md | 4 +-- docs/running from source.md | 58 +++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 docs/running from source.md diff --git a/README.md b/README.md index a3a06d48..9403159c 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Archipelago was directly forked from bonta0's `multiworld_31` branch of ALttPEnt ## Running Archipelago For most people all you need to do is head over to the [releases](https://github.com/ArchipelagoMW/Archipelago/releases) page then download and run the appropriate installer. The installers function on Windows only. -If you are running Archipelago from a non-Windows system then the likely scenario is that you are comfortable running source code directly. Please see our wiki page on [running Archipelago from source](https://github.com/ArchipelagoMW/Archipelago/wiki/Running-from-source). +If you are running Archipelago from a non-Windows system then the likely scenario is that you are comfortable running source code directly. Please see our doc on [running Archipelago from source](docs/running%20from%20source.md). ## Related Repositories This project makes use of multiple other projects. We wouldn't be here without these other repositories and the contributions of their developers, past and present. @@ -68,7 +68,7 @@ Contributions are welcome. We have a few asks of any new contributors. Otherwise, we tend to judge code on a case to case basis. It is a generally good idea to stick to PEP-8 guidelines to ensure consistency with existing code. (And to make the linter happy.) -For adding a new game to Archipelago and other documentation on how Archipelago functions, please see the docs folder for the relevant information and feel free to ask any questions in the #archipelago-dev channel in our discord. +For adding a new game to Archipelago and other documentation on how Archipelago functions, please see [the docs folder](docs/) for the relevant information and feel free to ask any questions in the #archipelago-dev channel in our discord. ## FAQ For frequently asked questions see the website's [FAQ Page](https://archipelago.gg/faq/en/) diff --git a/docs/running from source.md b/docs/running from source.md new file mode 100644 index 00000000..4360b28c --- /dev/null +++ b/docs/running from source.md @@ -0,0 +1,58 @@ +# Running From Source + +If you just want to play and there is a compiled version available on the +[Archipelago releases page](https://github.com/ArchipelagoMW/Archipelago/releases), +use that version. These steps are for developers or platforms without compiled releases available. + +## General + +What you'll need: + * Python 3.8.7 or newer + * pip (Depending on platform may come included) + * A C compiler + * possibly optional, read OS-specific sections + +Then run any of the starting point scripts, like Generate.py, and the included ModuleUpdater should prompt to install or update the +required modules and after pressing enter proceed to install everything automatically. +After this, you should be able to run the programs. + + +## Windows + +Recommended steps + * Download and install a "Windows installer (64-bit)" from the [Python download page](https://www.python.org/downloads) + * Download and install full Visual Studio from + [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/) + or an older "Build Tools for Visual Studio" from + [Visual Studio Older Downloads](https://visualstudio.microsoft.com/vs/older-downloads/). + + * Refer to [Windows Compilers on the python wiki](https://wiki.python.org/moin/WindowsCompilers) for details + * This step is optional. Pre-compiled modules are pinned on + [Discord in #archipelago-dev](https://discord.com/channels/731205301247803413/731214280439103580/905154456377757808) + + * It is recommended to use [PyCharm IDE](https://www.jetbrains.com/pycharm/) + * Run Generate.py which will prompt installation of missing modules, press enter to confirm + + +## macOS + +Refer to [Guide to Run Archipelago from Source Code on macOS](../worlds/generic/docs/mac_en.md). + + +## Optional: A Link to the Past Enemizer + +Only required to generate seeds that include A Link to the Past with certain options enabled. You will receive an +error if it is required. + +You can get the latest Enemizer release at [Enemizer Github releases](https://github.com/Ijwu/Enemizer/releases). +It should be dropped as "EnemizerCLI" into the root folder of the project. Alternatively, you can point the Enemizer +setting in host.yaml at your Enemizer executable. + + +## Optional: SNI + +SNI is required to use SNIClient. If not integrated into the project, it has to be started manually. + +You can get the latest SNI release at [SNI Github releases](https://github.com/alttpo/sni/releases). +It should be dropped as "SNI" into the root folder of the project. Alternatively, you can point the sni setting in +host.yaml at your SNI folder.