diff --git a/fml/CREDITS-fml.txt b/fml/CREDITS-fml.txt index 943d13d919..97122f5d34 100644 --- a/fml/CREDITS-fml.txt +++ b/fml/CREDITS-fml.txt @@ -2,13 +2,14 @@ This is Forge Mod Loader. You can find the source code at all times at https://github.com/MinecraftForge/FML -This minecraft mod is a clean open source implementation of a mod loader for -minecraft servers, minecraft bukkit servers, and minecraft clients. +This minecraft mod is a clean open source implementation of a mod loader for minecraft servers +and minecraft clients. The code is authored by cpw. -It (partially) implements API defined by the client side ModLoader, authored by Risugami. +It began by partially implementing an API defined by the client side ModLoader, authored by Risugami. http://www.minecraftforum.net/topic/75440- +This support has been dropped as of Minecraft release 1.7, as Risugami no longer maintains ModLoader. It also contains suggestions and hints and generous helpings of code from LexManos, author of MinecraftForge. http://www.minecraftforge.net/ diff --git a/fml/README.txt b/fml/README.txt index 8ee6089705..1935ba6973 100644 --- a/fml/README.txt +++ b/fml/README.txt @@ -2,9 +2,7 @@ This is Forge Mod Loader, or FML for short, by cpw. More information can be found at https://github.com/MinecraftForge/FML/wiki -It is a clean reimplementation of a mod loading system for client, server and -bukkit use, incorporating API implementations of client side ModLoader by -Risugami. +It is a clean reimplementation of a mod loading system for client and server. It can be installed on its own, or as part of Minecraft Forge. @@ -14,25 +12,14 @@ About Forge Mod Loader Environments and compatibility ============================== -FML covers the three main environments: client, server and bukkit. All -environments share the main mod loading code base, with additional varying hooks -based on the specific environment. Compatibility is almost 100% with all -ModLoader based mods- any mod with any difficulty (unless noted below) should -be reported as a ticket to the github, please. +FML covers two main environments: client and server. All environments share +the main mod loading code base, with additional varying hooks based on the +specific environment. -Client side mods should be 100% compatible with ModLoader. The only exception is -Optifine, however new versions of optifine are compatible. There are some very -visible changes to the client when FML is installed. +There are some very visible changes to the client when FML is installed. -Server side mods are mostly compatible with previous MLMP based incarnations, -however, this compatibility is not guaranteed. Most mods have adapted to FML -and MLMP is not assured and will cause errors. Ask your mod author to update -to FML. - -Bukkit side modding is an adaptation of the server side mod code to the bukkit -environment. Mods need to be recompiled against the bukkit decompilation to work -however there are guides and tools in development to make this process easier. -Consult mcportcentral.co.za for more information. +There are some bukkit compatibility hooks available, consult MCPC+ for more +information. Minecraft Forge in all cases bundles FML as it's modloading technology of choice because FML is open source, freely distributable, and can be easily updated by @@ -46,12 +33,6 @@ Minecraft Forge installation. FML will detect and ensure the good operation of Optifine (you can see it in your client as an additional data line on the bottom left). -Client notes -============ -FML does provide a standard pattern for mods to provide HD textures. This is why -optifine needed integration code. FML supports HD texture packs -up to 128x resolution. - Mod information =============== FML exposes the mod information through a mod list visible on the main screen as @@ -68,45 +49,41 @@ or server): Installation ============ To install on a server, simply execute the FML or Forge jar file, with a copy of -minecraft_server.jar placed in the same directory. FML will launch it's patched -copy. +minecraft_server-@MC_VERSION@.jar placed in the same directory. FML will launch +it's patched copy. -To install on a client, FIRST delete META-INF from the minecraft.jar file, then -copy the contents of the FML or Forge jar file into it. FML and Forge provide -their own META-INF data which should *not* be deleted. +To install on a client, run the installer by executing java -jar .jar. +It will identify the location of you minecraft installation (this can be customized) +and create a new profile "FML" there. Forge Installation ================== This code also ships as a part of Minecraft Forge. You do not need to install it separately from your Minecraft Forge installation. Minecraft Forge contains the -exact same code as this. Generally, you should not install FML if you are also -installing Minecraft Forge. +exact same code as this. You should not install FML if you are also installing +Minecraft Forge. ------------------------------------------- Source installation information for modders ------------------------------------------- This code follows the Minecraft Forge installation methodology. It will apply -some small patches to your MCP extracted source code, giving you and it access +some small patches to the vanilla MCP source code, giving you and it access to some of the data and functions you need to build a successful mod. -Note also that the patches are built against "unrenamed" MCP source code- this -means that you will not be able to read them directly against normal code. +Note also that the patches are built against "unrenamed" MCP source code (aka +srgnames) - this means that you will not be able to read them directly against +normal code. Source pack installation information: Standalone source installation ============================== -To install this source code for development purposes, extract this zip file -into an mcp installation containing vanilla jars only. It should create a new -folder "fml" inside that installation. - -Be sure that you have both vanilla client jars, and the vanilla server jar installed -as per the MCP install instructions. Both are required for FML to run properly. - -Once extracted, run the install.sh or install.bat script provided from the fml -directory. It should decompile and patch your MCP source code for the client -and server. +To install this source code for development purposes, extract this zip file. +It ships with a demonstration mod. Run "gradle setupDevWorkspace" to create +a gradle environment primed with FML. Run gradle eclipse or gradle idea to +create an IDE workspace of your choice. +Refer to ForgeGradle for more information about the gradle environment Forge source installation =========================