Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaks from discord discussions #304

Merged
merged 3 commits into from
Jun 30, 2024
Merged

Tweaks from discord discussions #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2affd8c
Fix formatting and add steps for if neither repo link worked
budak7273 Jun 29, 2024
aee49e3
Move dependencies SMM section earlier to improve flow for users who w…
budak7273 Jun 30, 2024
6e5cf5b
Clarify where to find the mod folder within the editor vs. on disk
budak7273 Jun 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion modules/ROOT/pages/Development/BeginnersGuide/SimpleMod/gameworldmodule.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ The Dependencies list should already be pre-populated with a dependency on the c

image:BeginnersGuide/simpleMod/EditPlugin.png[Edit your Plugin screenshot]

Creating your plugin with this wizard will create a plugin workspace folder inside the project folder under `<project>/Mods/<Mod Reference>`.
You can find your mod's files within the editor in the Plugins subfolder of any Content Browser.
On disk, the folder can be found inside your modding project folder at
`<project>/Mods/<Mod Reference>`.

All of the settings you selected in the wizard are stored in your mod's `.uplugin` file,
which you can optionally read more about
Expand Down
48 changes: 27 additions & 21 deletions modules/ROOT/pages/Development/BeginnersGuide/dependencies.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,14 @@ You will probably have to check your email and confirm from there,
as well as making sure you're logged into your linked GitHub account when you follow the upcoming link.

Verify this step has worked by visiting this repository link:
https://github.com/EpicGames/UnrealEngine/ (or https://github.com/EpicGames-Mirror-A/UnrealEngine/ since June 2024)
If it worked, you will see a private GitHub repository
Close that browser tab - we don't need any files from this repository.
https://github.com/EpicGames/UnrealEngine/
(or https://github.com/EpicGames-Mirror-A/UnrealEngine/ since June 2024)
If it worked, you will see a private GitHub repository.
If it didn't work, you'll get a 404 page, so try the other link.
If neither link works, try again in a few minutes and make sure you didn't miss any steps in Unreal's instructions.

Once you're sure it works, close that browser tab - we don't need any files from this repository.
Visiting there was just to verify that you have access.

[id="UnrealLinker"]
=== Link Your GitHub Account to Our Repository
Expand Down Expand Up @@ -289,6 +294,22 @@ You don't need to add any plugins,
so press `Select None` then `Install` in the bottom left to begin the installation process.
Accept the terms and conditions prompts that appear along the way.

== Satisfactory Mod Manager

xref:index.adoc#_satisfactory_mod_manager_aka_smm[Satisfactory Mod Manager]
offers a convenient developer mode that
automatically installs the correct version of SML and helps manage mod files for you.
To enable it, change your selected profile to `development`.
If you're using Satisfactory Mod Manager,
you can skip the below steps and move on to the next page of the tutorial.

If you're not using the mod manager, you can follow the
xref:ManualInstallDirections.adoc[manual install directions]
to get the relevant files set up.
Alternatively, once your modding environment is set up,
you can use Alpakit to automatically build and install SML.
This process is covered on the next page.

== Starter Project

The SML development team has an Unreal project prepared
Expand Down Expand Up @@ -319,8 +340,9 @@ from the Satisfactory Modding GitHub.

[TIP]
====
If you're planning to clone the project,
skip to the link:#_satisfactory_mod_manager[next heading].
If you're planning to use Git to clone the project,
skip this section and move to the xref:Development/BeginnersGuide/project_setup.adoc[next page]
which covers how (and where) to clone the project.
====

The below box will contain a link to the specific zip that you should download.
Expand Down Expand Up @@ -348,22 +370,6 @@ https://github.com/satisfactorymodding/SatisfactoryModLoader/archive/refs/heads/

Don't do anything with the downloaded files yet - this will be covered on the next page, Project Setup.

== Satisfactory Mod Manager

xref:index.adoc#_satisfactory_mod_manager_aka_smm[Satisfactory Mod Manager]
offers a convenient developer mode that
automatically installs the correct version of SML and helps manage mod files for you.
To enable it, change your selected profile to `development`.
If you're using Satisfactory Mod Manager,
you can skip the below steps and move on to the next page of the tutorial.

If you're not using the mod manager, you can follow the
xref:ManualInstallDirections.adoc[manual install directions]
to get the relevant files set up.
Alternatively, once your modding environment is set up,
you can use Alpakit to automatically build and install SML.
This process is covered on the next page.

== Next Steps

Now that all the dependencies are installed, you can move onto
Expand Down