Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Monmcgt authored Mar 22, 2023
1 parent d2e637c commit 5916c8a
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# LunarAgent-Weave
A rewrite of my old Lunar-Agent using Weave, a LunarClient mod loader.
**source at [gitlab](https://gitlab.com/Candicey/lunar-agent)**

# Lunar Agent
- A [Weave](https://github.com/Weave-MC) mod for improving LunarClient experience.
- Check out the old version [here](https://github.com/Monmcgt/Lunar-Agent). It is a pure java agent (not a Weave mod).

<br>

## Features
### Hypixel Bedwars Stats Checker
![](https://github.com/Monmcgt/Lunar-Agent/blob/master/assets/bedwars-stats.gif?raw=true)
#### Specify: `/lunaragent bedwars specify <player>`
#### Who (/who): `/lunaragent bedwars who`
#### Party (/party list): `/lunaragent bedwars party`

<br>

## How to use
1. [Download](#download) Lunar Agent mod.
2. Place the jar in your Weave mods folder.
1. Windows: `%userprofile%\.lunarclient\mods`
2. Unix: `~/.lunarclient/mods`
3. Add [Weave Loader](https://github.com/Weave-MC/Weave-Loader) to your java agent list.

<br>

## Download
- [Releases](https://gitlab.com/Candicey/lunar-agent/-/releases)

<br>

## Build
- Clone the repository.
- Run `./gradlew build` in the root directory.
- The built jar file will be in `build/libs`.

<br>

## Credits
- [Weave MC](https://github.com/Weave-MC) - For the mod loader.

<br>

## License
- Lunar Agent is licensed under the [GNU General Public License Version 3](https://gitlab.com/Candicey/lunar-agent/-/blob/master/LICENSE).
- (Actually, I want to use [Creative Commons Non-Commercial](https://creativecommons.org/licenses/by-nc/4.0/). But the Weave mod loader is licensed under the GPL 3.0.)

0 comments on commit 5916c8a

Please sign in to comment.