Skip to content

Commit

Permalink
Merge branch 'master' into Dev
Browse files Browse the repository at this point in the history
  • Loading branch information
budak7273 committed Jul 1, 2024
2 parents 0b038aa + dc42dc1 commit 4b0c37e
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 23 deletions.
1 change: 1 addition & 0 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ exclude = [
# These will always be 404s unless you're authed
"https://github.com/satisfactorymodding/UnrealEngine/",
"https://github.com/EpicGames/UnrealEngine/",
"https://github.com/EpicGames-Mirror-A/UnrealEngine/",
"https://github.com/SatisfactoryModdingUE/UnrealEngine/",
# Site seems to disallow robots
"https://cable.ayra.ch/satisfactory/editor.php",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can learn more about how holograms work on the xref:Development/Satisfactory
====

As you can see in the `Components` pane in the top left, the actor already contains a few components.
But not any visuals, so, now add a new instanced static mesh component in the center of the viewport.
But not any visuals, so, now add a new FGColoredInstancedMeshProxy component in the center of the viewport.
The build gun uses the origin when targeting the mesh to be built or snapped.
You can use link:{attachmentsdir}/BeginnersGuide/simpleMod/Mesh_DocBuild.fbx[this example Mesh], the Plantpot of Knowledge, for your buildable.

Expand Down Expand Up @@ -90,7 +90,7 @@ If you load up the game now, you should be able to build the Doc Build in game,

=== Placing the building creates nothing in the world

Make sure that your building has an instanced static mesh component
Make sure that your building has an FGColoredInstancedMeshProxy component
and that a mesh is assigned to it.

=== Building has a gray checkerboard texture
Expand Down
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
46 changes: 26 additions & 20 deletions modules/ROOT/pages/Development/BeginnersGuide/dependencies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,13 @@ as well as making sure you're logged into your linked GitHub account when you fo

Verify this step has worked by visiting this repository link:
https://github.com/EpicGames/UnrealEngine/
If it worked, you will see a private GitHub repository
Close that browser tab - we don't need any files this repository.
(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

0 comments on commit 4b0c37e

Please sign in to comment.