search

Radfordhound / SLW-Mod-Loader

A Mod Loader for Sonic Lost World on the PC!
MIT License
7 stars 1 forks source link

readme

THIS MOD LOADER IS OUTDATED! Please use Hedge Mod Manager instead.

Sonic Lost World Mod Loader

A mod loader for Sonic Lost World on the PC! This is currently a work in progress and is not in any way finished.

How do I use this?

After downloading the latest binary, simply make a "mods" folder within your Sonic Lost World installation directory, then place a bunch of folders inside said mods directory (one for each mod) each containing all the modified files you'd like the game to load. Then, just fire up the mod loader (SLWModLoader.exe), check the checkbox(es) next to the mods you'd like to use in-game, and click "Play!"

Mod installation tutorial by "Mac" (made for 1.4 but still applies to later revisions):

Mod installation tutorial

How do I release mods for this?

The following section is for mod developers only. If all you want to do is play with some mods made by others, simply follow the above steps.

Mods designed for the mod loader come in the form of folders that contain the following:

So long as the structure of your mod remains in this way, virtually any file in the game can be modified and released as part of your mod.

As an example, the extremely basic "Tanic the Hedgehog" recolor mod has a file/folder structure that goes like so:

Wereas the "MLG Speedrun Zone 1" mod (which modifies certain files not on the root of the .cpk) has a file/folder structure that goes like so:

The mod.ini file

The mod.ini file is a mod configuration file that details all the user-friendly information about your mod, as well as how CPKREDIR should load the mod.

The version of the format used in the SLW Mod Loader is a variation on the format used in SonicGMI, with some minor changes/additions here and there.

Here's an example of a mod.ini file:

[Main]
IncludeDir0="."
IncludeDirCount=1
UpdateServer="https://dl.dropboxusercontent.com/s/xkapkbby1vu4snk/Sonic06UpdateFile.txt"

[Desc]
Title="SLW '06 Project"
Description="What if Sonic '06 stages were fully playable in an engine that not only perfectly fit it's level design/gameplay, but was actually GOOD? \n\nIntroducing the SLW '06 Project! A mega mod for Lost World that ports as much of Sonic '06 as humanly possible without the glitches and unattractive visuals!  \n\nCredits:\n UltimateDarkman for making the wonderful '06-esque animations.\n Death for his wonderful beta-testing work. \n Gotta Play Fast and Slash for porting the Sonic '06 player models to Lost World. \n Radfordhound for ripping the stages, rendering GIA/generating lightfields, drawing vertex colors, and porting the HUD/music. \n Radfordhound, Gotta Play Fast, Slash, and Beatz for porting the stages and doing object placement. "
Version="Alpha 1.0"
Date="4/20/16"
Author="Radfordhound & Beatz & GPF & Death & UltimateDarkman"
AuthorURL="https://www.youtube.com/user/Radfordhound & https://www.youtube.com/channel/UCEjwges-3BTaWsMwOGJDoGQ & https://www.youtube.com/channel/UCZfOGBkXRKICFozWU5bE0Xg & https://www.youtube.com/user/DeathwolvesProjects & https://www.youtube.com/user/UltimateDarkman2010"
URL="https://onedrive.live.com/redir?resid=A0D011638C5973B3!5011&authkey=!AJXTG3vsMq0OXFc&ithint=folder%2c"

The following is a list of the most important values that can be used in a mod.ini file:

Main

IncludeDir0-?? Specifies which folders will be included with your mod, allowing you to modify the default file/folder structure mentioned above.

IncludeDirCount Specifies how many folders will be included with your mod.

UpdateServer A modification of the existing SonicGMI value that specifies the link to a raw .txt file containing URLs in a particular format. This feature has not yet been added, and will be further detailed once it is. However, I recommend linking a .txt file just in case anyway, as it will allow you to release auto-downloading updates to your mods once the mod loader has been updated to support this feature.

Desc

Title The name of your mod as shown in the mod loader.

Description A description of your mod that is shown when your mod is highlighted in the mod loader. Typing a "\n" in this value will indicate a new line within the mod loader, which should be done to keep your mods loadable!

Date The date the mod was originally created as shown in the mod loader.

Author The author(s) of the mod. You can include multiple authors in this value! Simply seperate the authors via a space, followed by an ampersand, and another space. (Like this: "Radfordhound & Gotta Play Fast") They will be loaded as seperate authors within the mod loader, allowing you to link to them seperately.

AuthorURL The URL(s) to the author(s) of the mod. (Such as websites, YouTube channels, and social media accounts.) You can include multiple authors in this value! Simply seperate the authors' URLs via a space, followed by an ampersand, and another space. (Like this: "https://www.youtube.com/user/Radfordhound & https://www.youtube.com/channel/UCZfOGBkXRKICFozWU5bE0Xg") They will be loaded as seperate URLs within the mod loader and automatically linked with the data contained in the "Author" value, allowing you to link to them seperately.

URL The URL of the mod (aka mod homepages/threads/release videos).

There are many other values that can be used in a mod.ini file, many of which are already being used in several mods. So keep an eye out for them in other released mods!