From cd8e5d841b6d1a71f980664836245b808d742aa6 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:35:37 -0700 Subject: [PATCH 1/9] Improve wording --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 29fc3f6b7..2ad96eae3 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ # MCProtocolLib -MCProtocolLib is a simple library for communicating with a Minecraft client/server. It aims to allow people to make -custom bots, clients, or servers for Minecraft easily. +MCProtocolLib is a simple library for communicating with Minecraft clients and servers. It allows developers to build custom bots, clients, or servers for Minecraft with ease. ## Example Code -See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java](https://github.com/Steveice10/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test) +See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java](https://github.com/Steveice10/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test) for sample usage. ## Adding as a Dependency -The recommended way of fetching MCProtocolLib is through jitpack.io. -See [here](https://jitpack.io/#Steveice10/MCProtocolLib) for more details on how to include MCProtocolLib in your +The recommended way of installing MCProtocolLib is through [JitPack](https://jitpack.io/). Visit [MCProtocolLib on JitPack](https://jitpack.io/#GeyserMC/MCProtocolLib) for more details on how to include MCProtocolLib in your project. Maven: @@ -46,13 +44,12 @@ dependencies { ## Building the Source -MCProtocolLib uses Maven to manage dependencies. Simply run 'mvn clean install' in the source's directory. +MCProtocolLib uses Maven to manage dependencies. To build the source code, run 'mvn clean install' in the project root directory. -## Support and development +## Support and Development -Please join us at https://discord.gg/geysermc under #mcprotocollib for discussion and support for this project. +Please join [the GeyserMC Discord server](https://discord.gg/geysermc) and visit the **#mcprotocollib** channel for discussion and support for this project. ## License MCProtocolLib is licensed under the **[MIT license](http://www.opensource.org/licenses/mit-license.html)**. - From b1fc47b75e2544b9e3d73f1b6ccb212558e9f87f Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:37:44 -0700 Subject: [PATCH 2/9] Description in `pom.xml` now matches README (shortened) --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index d6868b810..85d715173 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ jar MCProtocolLib - A library for communicating with a Minecraft client or server. + MCProtocolLib is a simple library for communicating with Minecraft clients and servers. http://github.com/Steveice10/MCProtocolLib/ From aaf653742a372bcb1153f6535ff1fd6885abef62 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:38:34 -0700 Subject: [PATCH 3/9] Use proper Markdown syntax throughout README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ad96eae3..d97264387 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java]( The recommended way of installing MCProtocolLib is through [JitPack](https://jitpack.io/). Visit [MCProtocolLib on JitPack](https://jitpack.io/#GeyserMC/MCProtocolLib) for more details on how to include MCProtocolLib in your project. -Maven: +### Maven ```xml @@ -28,7 +28,7 @@ Maven: ``` -Gradle: +### Gradle ```groovy allprojects { @@ -44,7 +44,7 @@ dependencies { ## Building the Source -MCProtocolLib uses Maven to manage dependencies. To build the source code, run 'mvn clean install' in the project root directory. +MCProtocolLib uses Maven to manage dependencies. To build the source code, run `mvn clean install` in the project root directory. ## Support and Development From 48afcae89ba8b8d0a6762b7a8c0460f9ff4a1780 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:40:44 -0700 Subject: [PATCH 4/9] Switch README JitPack references from `Steveice10` to `GeyserMC` (resolves GeyserMC/MCProtocolLib#666, resolves GeyserMC/MCProtocolLib#673) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d97264387..c53e48678 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ project. - com.github.Steveice10 + com.github.GeyserMC MCProtocolLib (version here) @@ -38,7 +38,7 @@ allprojects { } dependencies { - implementation 'com.github.Steveice10:MCProtocolLib:(version here)' + implementation 'com.github.GeyserMC:MCProtocolLib:(version here)' } ``` From 88fa9cad0a163b78a2183a63da9b59e1000129e4 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:48:38 -0700 Subject: [PATCH 5/9] Changed meta references of "Steveice10" to "GeyserMC" (resolves GeyserMC/MCProtocolLib#667) --- pom.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pom.xml b/pom.xml index 85d715173..e1ff0d2b0 100644 --- a/pom.xml +++ b/pom.xml @@ -10,12 +10,12 @@ MCProtocolLib MCProtocolLib is a simple library for communicating with Minecraft clients and servers. - http://github.com/Steveice10/MCProtocolLib/ + http://github.com/GeyserMC/MCProtocolLib/ - scm:git:git@github.com:Steveice10/MCProtocolLib.git - scm:git:git@github.com:Steveice10/MCProtocolLib.git - git@github.com:Steveice10/MCProtocolLib/ + scm:git:git@github.com:GeyserMC/MCProtocolLib.git + scm:git:git@github.com:GeyserMC/MCProtocolLib.git + git@github.com:GeyserMC/MCProtocolLib/ @@ -43,7 +43,7 @@ GitHub - https://github.com/Steveice10/MCProtocolLib/issues + https://github.com/GeyserMC/MCProtocolLib/issues @@ -75,19 +75,19 @@ - com.github.steveice10 + com.github.GeyserMC opennbt 1.4 compile - com.github.steveice10 + com.github.GeyserMC packetlib 2.1 compile - com.github.steveice10 + com.github.GeyserMC mcauthlib 6f3d6aada5 compile From 17efb11477b81030ed441486f00acbaf6aebbec3 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:49:12 -0700 Subject: [PATCH 6/9] Added GeyserMC org to Maven `` list --- pom.xml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pom.xml b/pom.xml index e1ff0d2b0..2bfb99c02 100644 --- a/pom.xml +++ b/pom.xml @@ -39,6 +39,13 @@ Steveice10 Steveice10@gmail.com + + GeyserMC + GeyserMC + https://geysermc.org/ + GeyserMC + https://github.com/GeyserMC + From 301d5f376dae67489531752eef8fb78e9e0de935 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 17 Jan 2022 16:54:07 -0700 Subject: [PATCH 7/9] Changed `Steveice10` in example URL to `GeyserMC` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c53e48678..d9c84ff00 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ MCProtocolLib is a simple library for communicating with Minecraft clients and s ## Example Code -See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java](https://github.com/Steveice10/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test) for sample usage. +See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java](https://github.com/GeyserMC/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test) for sample usage. ## Adding as a Dependency From 8ac1923b2d5610121fdf81b14cd2e7180f94a376 Mon Sep 17 00:00:00 2001 From: tycrek Date: Wed, 19 Jan 2022 12:17:24 -0700 Subject: [PATCH 8/9] Switch Maven repo references to Open Collab --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d9c84ff00..fd2ad6cbd 100644 --- a/README.md +++ b/README.md @@ -8,22 +8,21 @@ See [example/com/github/steveice10/mc/protocol/test/MinecraftProtocolTest.java]( ## Adding as a Dependency -The recommended way of installing MCProtocolLib is through [JitPack](https://jitpack.io/). Visit [MCProtocolLib on JitPack](https://jitpack.io/#GeyserMC/MCProtocolLib) for more details on how to include MCProtocolLib in your -project. +MCProtocolLib builds are published to the [Open Collaboration repository](https://repo.opencollab.dev/ui/packages/gav:%2F%2Fcom.github.steveice10:mcprotocollib). Follow the below steps to add MCProtocolLib as a dependency to your project. ### Maven ```xml - jitpack.io - https://jitpack.io + opencollab + https://repo.opencollab.dev/maven-releases/ - com.github.GeyserMC - MCProtocolLib + com.github.steveice10 + mcprotocollib (version here) ``` @@ -33,12 +32,12 @@ project. ```groovy allprojects { repositories { - maven { url 'https://jitpack.io' } + maven { url 'https://repo.opencollab.dev/maven-releases/' } } } dependencies { - implementation 'com.github.GeyserMC:MCProtocolLib:(version here)' + implementation 'com.github.steveice10:mcprotocollib:(version here)' } ``` From 51519c482532627da2d20aa2b5357e95f49a0ba1 Mon Sep 17 00:00:00 2001 From: tycrek Date: Wed, 19 Jan 2022 12:17:43 -0700 Subject: [PATCH 9/9] Added note regarding snapshot builds --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index fd2ad6cbd..413a101ce 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,10 @@ dependencies { } ``` +### Snapshots + +To use snapshot builds, switch the URL to `https://repo.opencollab.dev/maven-snapshots/`. + ## Building the Source MCProtocolLib uses Maven to manage dependencies. To build the source code, run `mvn clean install` in the project root directory.