diff --git a/Writerside/i.tree b/Writerside/i.tree new file mode 100644 index 0000000..33d87e1 --- /dev/null +++ b/Writerside/i.tree @@ -0,0 +1,12 @@ + + + + + + + + + \ No newline at end of file diff --git a/Writerside/topics/I-New-Minecraft-version.md b/Writerside/topics/I-New-Minecraft-version.md new file mode 100644 index 0000000..51ac545 --- /dev/null +++ b/Writerside/topics/I-New-Minecraft-version.md @@ -0,0 +1,25 @@ +# Updating to a new Minecraft version + +## Pre-release phase + +While mojang is still publishing pre-releases, check in the mc source for potential problems & breaking changes. + +## Preparing + +Do this before paper released the first dev bundle. + +1. copy the ``implementation_(PREVIOUS VERSION)`` module +2. paste the module and change the version ('1_20_2' -> '1_20_3') +3. add ``include("implementation_(NEW VERSION)")`` to settings.gradle.kts +4. add ``implementation(project(":implementation_(NEW VERSION)", configuration = "reobf"))`` in build.gradle.kts +5. add the new version in Plugin#onLoad and Plugin#SUPPORTED_VERSIONS +6. (add the new version in AttributeManagerImpl#init) +7. update the latest version in README + +## Actually updating + +1. update ``mcVersion`` in build.gradle.kts +2. update ``minecraftVersion`` in the new implementation module +3. test if it compiles +4. fix compile & mapping errors +5. [publish new plugin version](I-Releases.md) and hope nothing is broke \ No newline at end of file diff --git a/Writerside/topics/I-Releases.md b/Writerside/topics/I-Releases.md new file mode 100644 index 0000000..cf5e7d0 --- /dev/null +++ b/Writerside/topics/I-Releases.md @@ -0,0 +1,14 @@ +# Releases + +1. change the version in ``./build.gradle.kts`` +2. commit & push +3. publish api to maven-repo (the ``api`` module only) +4. run jenkins build +5. create a github release + 1. create a new tag (v.1.2.3) + 2. title: just the version + 3. attach the compiled jar +6. create spigotmc release +7. create hangar release +8. create modrinth release +9. make discord announcement \ No newline at end of file diff --git a/Writerside/topics/internal.md b/Writerside/topics/internal.md new file mode 100644 index 0000000..b3ed8a6 --- /dev/null +++ b/Writerside/topics/internal.md @@ -0,0 +1,3 @@ +# Internal docs + +This is a collection of internal documentation for the FancyNpcs & FancyHolograms projects. \ No newline at end of file diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg index 090e2d9..7d27c44 100644 --- a/Writerside/writerside.cfg +++ b/Writerside/writerside.cfg @@ -7,4 +7,5 @@ + \ No newline at end of file