Update documentation

README.md

@@ -8,79 +8,112 @@ for documentation for latest SNAPSHOT**
 
 [at 85780a0]: https://github.com/anatawa12/mod-patching/tree/85780a0a28c9a7473d394b40ceef69f93f1bd906
 
-Features (checked means implemented)
-
-- [x] downloading mods from curse forge
-- [x] obfuscating mods
-- [x] decompiling mods
-- [x] making binary patch
-- [x] making source patch
-  - [ ] for workaround of decompiler bugs
-  - [x] for commits
-- [ ] making git hooks
-    - [ ] for commit patches
-- [ ] making merge controller
-
-```groovy
-buildscript {
-  mavenCentral()
-  maven {
-    name = "forge"
-    url = "https://files.minecraftforge.net/maven"
-  }
-  dependencies {
-    classpath("com.anatawa12.forge:ForgeGradle:2.3-1.0.+") {
-      changing = true
-    }
-    classpath("com.anatawa12.mod-patching:mod-patching-gradle-plugin:1.0-SNAPSHOT")
-  }
+## Common (mod downloader)
+
+This plugin adds task to download mod from mod providers. Currently, supports [curseforge].
+
+### Configuration
+
+```kotlin
+plugins {
+    id("com.anatawa12.mod-patching.common") version "2.0.0"
+}
+
+// add mod to download. the returned instance will be 
+// used by binary or source patcher
+val mod = mods.curse(id = "id", version = "version") {
+    // slag of mod. e.g. "cofh-core"
+    id = "id"
+    // the version name contain in mod jar name.
+    version = "version"
+    // the target minecraft versions.
+    targetVersions("1.12.2")
+}
+```
+
+### Tasks
+
+#### `downloadMods` - lifecycle task
+
+Running this task will download all mods to cache directory.
+
+#### `prepareMods` - lifecycle task
+
+Running this task will prepare all mods to ready to use by develop with source/binary patching. With source patching
+plugin, running this task will de-obfuscate mods.
+
+#### `preparePatchingEnvironment` - lifecycle task
+
+Running this task will make the workspace ready to patch. With source patching plugin, running this task will decompile
+mods.
+
+## Binary (bsdiff generator)
+
+This plugin will add task to generate and embed bsdiff binary patches. To allow make binary patches after reobf task by
+ForgeGradle, Generating binary patches is This depends on Common so `"com.anatawa12.mod-patching.common"` will
+automatically be applied.
+
+```kotlin
+plugins {
+    id("com.anatawa12.mod-patching.binary") version "2.0.0"
+}
+
+binPatching {
+    // the mod instance by common
+    patch(mod)
+    // the base directory in jar to bsdiff.
+    // with "your/package/bsdiff", the bsdiff patch for
+    // "some/mod/SomeClass.class" will be 
+    // at "your/package/bsdiff/some/mod/SomeClass.class.bsdiff"
+    bsdiffPrefix = "your/package/bsdiff"
+    // patching-mod appends this string to source name in class file.
+    // "SomeClass.java" will be "SomeClass.java(modified by mod-name)"
+    sourceNameSuffix = "(modified by mod-name)"
 }
 
-apply plugin: "com.anatawa12.mod-patching"
 ```
 
+## Source (decompile+patch based mod developing)
+
+This plugin will add tasks to develop a mod with decompiled source and applying&generating source patches.
+See [documentation][source-patching-development] for more details.
+
 ```kotlin
-mods {
-   curse {
-      id = "id" // slag of mod. e.g. "cofh-core"
-      version = "version"
-      deobf = true // by default
-      addToMods = true // by default if not patching
-
-      // null if not add to configure
-      // "compileOnly" by default if not patching.
-      // if for patching, defaults null
-      configurationAddTo = "compileOnly"
-
-      // the target minecraft versions
-      targetVersions("1.12.2")
-   }
+plugins {
+    id("com.anatawa12.mod-patching.source") version "2.0.0"
 }
 
-val rtm = mods.curse(id = "id", version = "version")
-
-patching {
-   patch(rtm) {
-      sourceTreeName = "" // by default, id.
-      onRepo = OnRepoPatchSource.MODIFIED // default
-//      onRepo = OnRepoPatchSource.ALL
-//      onVCS = OnVCSPatchSource.MODIFIED
-      onVCS = OnVCSPatchSource.PATCHES // default
-//      onVCS = OnVCSPatchSource.ALL_FILES
-   }
+sourcePatching {
+    // the name of mcp mapping.
+    mappingName = "stable_39"
+    // the mapping mc version.
+    mcVersion = "1.12"
+    // the version of forgeFlower, decompiler
+    forgeFlowerVersion = "1.5.498.12"
+    // true if you want to install pm.* utilities automatically
+    autoInstallCli = true
+    // the mod instance by common
+    patch(mod) {
+        // the name of directory to source files patches applied and patches
+        // src/main/<sourceTreeName> for patched files and
+        // src/main/<sourceTreeName>-patches for patch files
+        sourceTreeName = mod.name
+    }
 }
 ```
 
 default source format
+
 ```
 src/main
-// not yet implemented
-// +- <sourceTreeName>-pre-patches 
-// |    // patch source of <id> for workaround of decompiler bugs
  +- <sourceTreeName>
  |    // java source of <id>
  |    // if onRepo is PATCHES, gitignored.
  `- <sourceTreeName>-patches
       // patch source of <id>
       // is onRepo is not PATCHES, never created
 ```
+
+[curseforge]: https://www.curseforge.com/minecraft/modpacks
+
+[source-patching-development]: ./docs/source-patching-development.md

docs/source-patching-development.md

@@ -0,0 +1,39 @@
+# Source Patching Development
+
+This document explains the purpose of source patching development and How to use source patching development.
+
+## The purpose of source patching development
+
+If the mod you want to modify doesn't have public source code or redistributing sources is not allowed, the only way to
+modify sources is applying patches.
+
+It's not good to use source patching development for source published mods. Please use forking mod.
+
+## How to use source patching development by this plugin
+
+Before do those steps, please configure `com.anatawa12.mod-patching.source` gradle plugin. See README for configuring
+information.
+
+### Step 1: run ``preparePatchingEnvironment`` task
+
+Please run `preparePatchingEnvironment` gradle task added by this plugin. Running this prepares mods will be modified.
+
+### Step 2: run ``./pm.apply-patches``
+
+To apply existing patches, please execute ``./pm.apply-patches``.
+
+### Step 3: run ``./pm.add-modify``
+
+If you want to modify classes already existing in patched java sources, this step is not required. If you want to add
+classes to be modified, run ``./pm.add-modify`` and select class from list. If your terminal emulator supports, mouse
+click and scroll can be used to select java files.
+
+### Step 3: modify java files
+
+Please edit the files you want to modify.
+
+### Step 4: run ``./pm.create-diff``
+
+Before commit, please run ``./pm.create-diff`` to generate patch files. Without this, your changes will not be added to
+git repository.
+

gradle-plugin/src/main/java/com/anatawa12/modPatching/binary/BinaryPatch.kt

@@ -5,9 +5,4 @@ import org.gradle.api.Named
 
 interface BinaryPatch : Named {
     val mod: DownloadingMod
-
-    /**
-     * name of files on source tree
-     */
-    var sourceTreeName: String
 }

gradle-plugin/src/main/java/com/anatawa12/modPatching/binary/internal/BinaryPatchImpl.kt

@@ -7,7 +7,6 @@ import com.anatawa12.modPatching.binary.internal.BinaryConstants.CHECK_SIGNATURE
 import com.anatawa12.modPatching.binary.internal.BinaryConstants.COPY_MODIFIED_CLASSES
 import com.anatawa12.modPatching.binary.internal.BinaryConstants.GENERATE_BSDIFF_PATCH
 import com.anatawa12.modPatching.common.internal.AbstractDownloadingMod
-import com.anatawa12.modPatching.common.internal.Delegates
 import com.anatawa12.modPatching.common.internal.FreezableContainer
 import com.anatawa12.modPatching.internal.asFile
 import org.gradle.api.file.FileTreeElement
@@ -20,7 +19,6 @@ import java.util.zip.ZipFile
 class BinaryPatchImpl(
     override val mod: AbstractDownloadingMod,
 ) : BinaryPatch, FreezableContainer by FreezableContainer.Impl("added") {
-    override var sourceTreeName: String by Delegates.freezable(mod.name)
     override fun getName(): String = mod.name
 
     fun onAdd() {