Upstream
/
ViaVersion
mirror of https://github.com/ViaVersion/ViaVersion.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
ViaVersion/README.md

80 lines
2.4 KiB
Markdown
Raw Normal View History

version badge
2020-08-11 19:06:38 +02:00
# ViaVersion - Spigot, Sponge, BungeeCord, Velocity
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
version badge
2020-08-11 19:06:38 +02:00
[![Latest Release](https://img.shields.io/github/v/release/ViaVersion/ViaVersion)](https://viaversion.com)
Update build badge in readme
2021-04-05 13:32:15 +02:00
[![Build Status](https://github.com/ViaVersion/ViaVersion/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/ViaVersion/ViaVersion/actions)
Add discord server
2017-05-22 16:49:42 +02:00
[![Discord](https://img.shields.io/badge/chat-on%20discord-blue.svg)](https://viaversion.com/discord)
Missed a bit off the README
2016-08-21 16:52:59 +02:00
Add link to docs.
2016-07-01 18:13:01 +02:00
**Allows the connection of higher client versions to lower server versions**
Update README
2016-02-29 00:04:59 +01:00
Prepare for 1.0.0
2016-11-13 15:04:56 +01:00
Supported Versions:
Add 1.17 to table
2021-03-02 14:14:28 +01:00
![Table (https://i.imgur.com/uDM9HR8.png)](https://i.imgur.com/uDM9HR8.png)
Prepare for 1.0.0
2016-11-13 15:04:56 +01:00
Update README.md
2020-09-21 19:07:29 +02:00
On Paper you may also use ProtocolSupport, but ensure you have the right build for your server version.
Add link to docs.
2016-07-01 18:13:01 +02:00
**User Docs:** https://docs.viaversion.com/display/VIAVERSION/
Change the README back ;)
2016-03-27 22:50:49 +02:00
Sources:
--------
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
**[wiki.vg](https://wiki.vg)** (Used for information regarding packet structure, we also contribute back)
Change the README back ;)
2016-03-27 22:50:49 +02:00
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
**[Burger](https://github.com/Pokechu22/Burger)** (See [PAaaS](https://github.com/Matsv/Paaas))
Change the README back ;)
2016-03-27 22:50:49 +02:00
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
**[OpenNBT](https://github.com/ViaVersion/OpenNBT)**
Missed a bit off the README
2016-08-21 16:52:59 +02:00
Change the README back ;)
2016-03-27 22:50:49 +02:00
Releases / Dev Builds:
--------
You can find official releases here:
https://www.spigotmc.org/resources/viaversion.19254/history
----------
0.8.4 Release
2016-05-27 19:05:46 +02:00
You can find official dev builds here:
Change the README back ;)
2016-03-27 22:50:49 +02:00
0.8.4 Release
2016-05-27 19:05:46 +02:00
**Jenkins:** https://ci.viaversion.com
Change the README back ;)
2016-03-27 22:50:49 +02:00
0.8.4 Release
2016-05-27 19:05:46 +02:00
**JavaDocs:** https://jd.viaversion.com
Bongo bongo bongo
2016-03-18 22:25:41 +01:00
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
**Maven Repository:**
```xml
<repository>
<id>viaversion-repo</id>
<url>https://repo.viaversion.com</url>
</repository>
```
**API-artifact:**
```xml
<dependency>
<groupId>us.myles</groupId>
<artifactId>viaversion-api</artifactId>
<version>LATEST</version>
<scope>provided</scope>
</dependency>
```
Replace the version depending on your needs.
If you need access to the existing protocol or platform implementations, use the parent artifact `viaversion`.
Please note the [differences in licensing](#license).
Add JavaDocs link to README.md
2016-03-29 16:36:21 +02:00
Update README
2021-02-25 10:21:11 +01:00
Building:
--------
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
After cloning this repository, build the project with Gradle by running `/gradlew build` and take the created jar out of
the `build/libs` directory.
Update README
2021-02-25 10:21:11 +01:00
Update README
2016-02-29 00:04:59 +01:00
License:
Remove TODO, format README
2016-02-29 00:18:33 +01:00
--------
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
The entirety of the [API directory](api) is licensed under the MIT License; see [licenses/MIT.md](licenses/MIT.md) for
details.
Update README
2016-02-29 00:04:59 +01:00
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
Everything else, unless explicitly stated otherwise, is licensed under the GNU General Public License, including the end
product as a whole; see [licenses/GPL.md](licenses/GPL.md) for details.
Update README with chat, and change issue template
2016-03-03 11:37:10 +01:00
Split parts of common into api; We are now GPL, api is MIT This does not affect any previous states of this project; only future modifications as well as the project as a whole will be under the GNU General Public License from now on. The newly introduced api directory, partly split from common, is an exception to this, still being licensed under the MIT license. See the README for details.
2021-03-22 23:06:40 +01:00
Special thanks to all our [Contributors](https://github.com/ViaVersion/ViaVersion/graphs/contributors).