Skip to content

Commit

Permalink
Consolidate all documentation PR's (#666, #667, #673) (#683)
Browse files Browse the repository at this point in the history
* Improve wording

* Description in `pom.xml` now matches README (shortened)

* Use proper Markdown syntax throughout README

* Switch README JitPack references from `Steveice10` to `GeyserMC`
(resolves #666, resolves #673)

* Changed meta references of "Steveice10" to "GeyserMC" (resolves #667)

* Added GeyserMC org to Maven `<developers>` list

* Changed `Steveice10` in example URL to `GeyserMC`

* Switch Maven repo references to Open Collab

* Added note regarding snapshot builds
  • Loading branch information
Josh Moore authored Feb 15, 2022
1 parent 7211f65 commit d124218
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 27 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,58 @@
# 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)

This comment has been minimized.

Copy link
@KTibow

KTibow Nov 17, 2022

it should be

https://github.com/GeyserMC/MCProtocolLib/tree/master/example/src/main/java/com/github/steveice10/mc/protocol/test

not

https://github.com/GeyserMC/MCProtocolLib/tree/master/example/com/github/steveice10/mc/protocol/test
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

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
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:
### Maven

```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
<id>opencollab</id>
<url>https://repo.opencollab.dev/maven-releases/</url>
</repository>
</repositories>

<dependency>
<groupId>com.github.Steveice10</groupId>
<artifactId>MCProtocolLib</artifactId>
<groupId>com.github.steveice10</groupId>
<artifactId>mcprotocollib</artifactId>
<version>(version here)</version>
</dependency>
```

Gradle:
### Gradle

```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
maven { url 'https://repo.opencollab.dev/maven-releases/' }
}
}
dependencies {
implementation 'com.github.Steveice10:MCProtocolLib:(version here)'
implementation 'com.github.steveice10:mcprotocollib:(version here)'
}
```

### Snapshots

To use snapshot builds, switch the URL to `https://repo.opencollab.dev/maven-snapshots/`.

## 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)**.

25 changes: 16 additions & 9 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
<packaging>jar</packaging>

<name>MCProtocolLib</name>
<description>A library for communicating with a Minecraft client or server.</description>
<url>http://github.com/Steveice10/MCProtocolLib/</url>
<description>MCProtocolLib is a simple library for communicating with Minecraft clients and servers.</description>
<url>http://github.com/GeyserMC/MCProtocolLib/</url>

<scm>
<connection>scm:git:git@github.com:Steveice10/MCProtocolLib.git</connection>
<developerConnection>scm:git:git@github.com:Steveice10/MCProtocolLib.git</developerConnection>
<url>git@github.com:Steveice10/MCProtocolLib/</url>
<connection>scm:git:git@github.com:GeyserMC/MCProtocolLib.git</connection>
<developerConnection>scm:git:git@github.com:GeyserMC/MCProtocolLib.git</developerConnection>
<url>git@github.com:GeyserMC/MCProtocolLib/</url>
</scm>

<properties>
Expand All @@ -39,11 +39,18 @@
<name>Steveice10</name>
<email>Steveice10@gmail.com</email>
</developer>
<developer>
<id>GeyserMC</id>
<name>GeyserMC</name>
<url>https://geysermc.org/</url>
<organization>GeyserMC</organization>
<organizationUrl>https://github.com/GeyserMC</organizationUrl>
</developer>
</developers>

<issueManagement>
<system>GitHub</system>
<url>https://github.com/Steveice10/MCProtocolLib/issues</url>
<url>https://github.com/GeyserMC/MCProtocolLib/issues</url>
</issueManagement>

<repositories>
Expand Down Expand Up @@ -75,19 +82,19 @@

<dependencies>
<dependency>
<groupId>com.github.steveice10</groupId>
<groupId>com.github.GeyserMC</groupId>
<artifactId>opennbt</artifactId>
<version>1.4</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.github.steveice10</groupId>
<groupId>com.github.GeyserMC</groupId>
<artifactId>packetlib</artifactId>
<version>2.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.github.steveice10</groupId>
<groupId>com.github.GeyserMC</groupId>
<artifactId>mcauthlib</artifactId>
<version>6f3d6aada5</version>
<scope>compile</scope>
Expand Down

0 comments on commit d124218

Please sign in to comment.