Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Badbird5907 committed Mar 15, 2024
1 parent d3814d0 commit 28c3c43
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TerminatorPlus [BETA]

**This project is on pause indefinitely.**
**This project is on pause indefinitely. Updates are not guaranteed. Please do not use in a production server.**

Additionally, the readme and wiki may be outdated.

Expand All @@ -9,28 +9,34 @@ Additionally, the readme and wiki may be outdated.
![GitHub](https://img.shields.io/github/license/HorseNuggets/TerminatorPlus?color=violet&logo=GitHub&labelColor=000000&style=for-the-badge)
![Discord](https://img.shields.io/discord/357333217340162069?color=5865F2&label=Discord&logo=Discord&labelColor=23272a&style=for-the-badge)

**TerminatorPlus** is a Spigot plugin that allows the creation of server-side player bots. Unlike many NPC plugins that already exist, this project has an emphasis on making the bots as human-like as possible.
**TerminatorPlus** is a bukkit (paper) plugin that allows the creation of server-side player bots. Unlike many NPC
plugins that already exist, this project has an emphasis on making the bots as human-like as possible.

### Download

Releases are currently available on our Discord server, which can be found [here](https://discord.gg/vZVSf2D6mz).
Releases are currently available on our Discord server, which can be found [here](https://discord.gg/vZVSf2D6mz). You
can also find them on the [releases page](https://github.com/HorseNuggets/TerminatorPlus/releases)

### Machine Learning

TerminatorPlus currently utilizes classic population-based reinforcement learning for bot PVP training. Q-learning is a work in progress, along with variable A* pathfinding.

### API Support

The jar artifact can be used as a dependency for your own plugins, however stronger support will come in the future. Below is an exmaple of a simple bot creation method provided.
Built API artifacts are available on the [releases page](https://github.com/HorseNuggets/TerminatorPlus/releases), and
the Discord server.
See
the [API Module](https://github.com/HorseNuggets/TerminatorPlus/tree/master/TerminatorPlus-API/src/main/java/net/nuggetmc/tplus/api)
for available methods.

Example:
```java
Location loc = player.getLocation();
Bot bot = Bot.createBot(loc, "Dream");
Terminator terminator = TerminatorPlusAPI.getBotManager().createBot(location, "BotName", skin, skinSignature);
```

### Version Support

This plugin requires [Paper 1.20.1](https://papermc.io/downloads/all).
This plugin requires [Paper 1.20.4](https://papermc.io/downloads/all).

### Future Updates

Expand Down

0 comments on commit 28c3c43

Please sign in to comment.