Skip to content

Commit

Permalink
added readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
rexlManu committed Jun 24, 2021
1 parent 1909915 commit 21b9edc
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Emmanuel Lampe

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# NickAPI

[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)

A nick api on packet level with fully support for uuid, skin or username change. Everything happens clientside and with
the functionality to declare filters, to check if the target will see the fake identity.

## Features

- UUID, username and skin seperated can be set
- Everything based on Reflection - Multi version support
- without Dependencies - uses [TinyProtocol](https://github.com/dmulloy2/ProtocolLib)

## Usage

You can find a implementation for the
NickAPI [here](plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPluginImplementationTest.java).

## Installation

### Gradle

```groovy
maven {
name "miopowered-repo"
url "https://repo.miopowered.eu/releases"
}
dependencies {
implementation('eu.miopowered.nickapi:api:1.0')
}
```

### Maven

```xml

<repository>
<id>miopowered-repo</id>
<url>https://repo.miopowered.eu/releases</url>
</repository>

<dependency>
<groupId>eu.miopowered.nickapi</groupId>
<artifactId>api</artifactId>
<version>1.0</version>
</dependency>
```

## Proof of concept

You also can find my proof of concept [here](plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPlugin.java).

## Known issues

- Before quiting as nicked, you need to remove him from the tab via

``NickUpdater#removeFromTab(nickUser.viewers(), nickUser.fakeIdentity().uniqueId())``

- Not possible that the player can see this fake skin

## License

[MIT](LICENSE)

0 comments on commit 21b9edc

Please sign in to comment.