Skip to content

Commit

Permalink
Updated example mod skeleton to not work until people fill in the SML…
Browse files Browse the repository at this point in the history
… and ContentLib versions
  • Loading branch information
budak7273 committed Aug 16, 2023
1 parent 7947073 commit 72b090f
Show file tree
Hide file tree
Showing 7 changed files with 115 additions and 11 deletions.
Binary file modified modules/ROOT/attachments/ExampleContentLibMod.zip
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[StageSettings]
+AdditionalNonUSFDirectories=Resources
+AdditionalNonUSFDirectories=ContentLib
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"FileVersion": 3,
"Version": 1,
"VersionName": "1.0.0",
"SemVersion": "1.0.0",
"FriendlyName": "Example ContentLib Mod",
"Description": "This mod is a example skeleton from the ContentLib documentation.",
"Category": "Modding",
"CreatedBy": "You, Robb",
"CreatedByURL": "",
"DocsURL": "https://docs.ficsit.app/contentlib/latest/index.html",
"MarketplaceURL": "",
"SupportURL": "",
"CanContainContent": true,
"IsBetaVersion": false,
"IsExperimentalVersion": false,
"Installed": false,
"Plugins": [
{
"Name": "SML",
"Enabled": true,
"SemVersion": "^SmlVersionReplaceMe"
},
{
"Name": "ContentLib",
"Enabled": true,
"SemVersion": "^ContentLibVersionReplaceMe"
}
]
}
44 changes: 44 additions & 0 deletions modules/ROOT/attachments/ExampleContentLibMod/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Example ContentLib Mod

This template was obtained from the
[ContentLib Documentation](https://docs.ficsit.app/contentlib/latest/index.html).

Before you release a mod from this template,
you must switch over some files to use your mod reference
instead of the current value of `ExampleContentLibMod`

Once you have decided on a
[Mod Reference](https://docs.ficsit.app/satisfactory-modding/latest/Development/BeginnersGuide/index.html#_mod_reference),
you will have to:

- Rename the folder (from `ExampleContentLibMod` to `YourModReferenceHere`)
- Rename the .uplugin file inside the folder
(from `ExampleContentLibMod.uplugin` to `YourModReferenceHere.uplugin`)
- (Optional) Replace `/Resources/Icon128.png` with image of your choice for the mod icon

Inside the .uplugin file:

- Edit the FriendlyName, Description, and CreatedBy fields to your preferences
- Replace the "SmlVersionReplaceMe" with the latest version number of SML found here:
https://ficsit.app/sml-versions, so that it follows the format `^The.Number.Here`.
Once you're done, that section will look similar to this:

```
{
"Name": "SML",
"Enabled": true,
"SemVersion": "^3.5.0"
},
```

- Replace the "ContentLibVersionReplaceMe" with the latest version number of ContentLib found here:
https://ficsit.app/sml-versions, so that it follows the format `^The.Number.Here`.
Once you're done, that section will look similar to this:

```
{
"Name": "ContentLib",
"Enabled": true,
"SemVersion": "^1.1.0"
},
```
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 10 additions & 5 deletions modules/ROOT/pages/Tutorials/PublishMod.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,20 @@ to set up a plugin structure for your mod files.

== Upload to SMR

If you followed the xref:Tutorials/Setup.adoc[Setup document],
If you followed the xref:Tutorials/Setup.adoc[Setup document]'s "Example Plugin Skeleton" approach
your files should already be in mod format.

You can now upload your mod to Satisfactory Mod Repository for anyone to download and use.
However, if you used the "Configs Folder" approach, you will need to go back and set up the
xref:Tutorials/Setup.adoc#_download_the_example_plugin_skeleton[Example Plugin Skeleton].
Remember to move your old ContentLib files out of the config folder when testing your new mod skeleton!

Once you have edited the skeleton to match your needs,
you're ready to upload your mod to Satisfactory Mod Repository for anyone to download and use.
You can follow the directions in the
https://docs.ficsit.app/satisfactory-modding/latest/UploadToSMR.html[main modding documentation]
to achieve this.

Make sure your mod depends on ContentLib as described in the
xref:Tutorials/Setup.adoc[Setup document],
or your mod won't do anything by itself!
Make sure your mod uplugin specifies ContentLib as a dependency as described in the
xref:Tutorials/Setup.adoc[Setup document]
or your mod won't do anything!
If you used the skeleton, it should already depend on ContentLib.
34 changes: 28 additions & 6 deletions modules/ROOT/pages/Tutorials/Setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,34 @@ Once you have decided on a mod reference, you will have to:
- Rename the folder (from `ExampleContentLibMod` to `YourModReferenceHere`)
- Rename the .uplugin file inside the folder
(from `ExampleContentLibMod.uplugin` to `YourModReferenceHere.uplugin`)
- Edit the FriendlyName, Description,
and CreatedBy fields of `YourModReferenceHere.uplugin`
- You may need to change the uplugin's SemVersion value of the SML dependency
to the latest SML version,
and/or the SemVersion of the dependency on ContentLib
to the latest ContentLib version.
- (Optional) Replace `/Resources/Icon128.png` with image of your choice for the mod icon

Inside the .uplugin file:

- Edit the FriendlyName, Description, and CreatedBy fields to your preferences
- Replace the "SmlVersionReplaceMe" with the latest version number of SML found
link:https://ficsit.app/sml-versions[here], so that it follows the format `^The.Number.Here`.
Once you're done, that section will look similar to this:

```
{
"Name": "SML",
"Enabled": true,
"SemVersion": "^3.5.0"
},
```

- Replace the "ContentLibVersionReplaceMe" with the latest version number of ContentLib found
link:https://ficsit.app/sml-versions[here], so that it follows the format `^The.Number.Here`.
Once you're done, that section will look similar to this:

```
{
"Name": "ContentLib",
"Enabled": true,
"SemVersion": "^1.1.0"
},
```

== Setting Up the Plugin Folder

Expand Down

0 comments on commit 72b090f

Please sign in to comment.