Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
r4g3baby committed Oct 28, 2023
1 parent 047e9db commit 3ea64f5
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 8 deletions.
Binary file added .github/SimpleScore.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 58 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,62 @@
# SimpleScore
[![SimpleScore Logo]][GitHub]

[![Latest Release](https://img.shields.io/github/v/release/r4g3baby/SimpleScore)](https://github.com/r4g3baby/SimpleScore/releases/latest)
[![Spigot Downloads](https://img.shields.io/spiget/downloads/23243)](https://www.spigotmc.org/resources/simplescore.23243/)
[![Discord](https://img.shields.io/discord/217018114083127296)](https://discord.gg/cJnzTDGphE)
[![bStats Servers](https://img.shields.io/bstats/servers/644)](https://bstats.org/plugin/bukkit/SimpleScore/644)
[![bStats Players](https://img.shields.io/bstats/players/644)](https://bstats.org/plugin/bukkit/SimpleScore/644)
[![GitHub](https://img.shields.io/github/license/r4g3baby/SimpleScore)](https://github.com/r4g3baby/SimpleScore/blob/main/LICENSE)
[![Spigot Downloads](https://img.shields.io/spiget/downloads/23243)][SpigotMC]
[![Discord](https://img.shields.io/discord/217018114083127296)][Discord]
[![bStats Servers](https://img.shields.io/bstats/servers/644)][bStats]
[![bStats Players](https://img.shields.io/bstats/players/644)][bStats]
[![License](https://img.shields.io/github/license/r4g3baby/SimpleScore)](https://github.com/r4g3baby/SimpleScore/blob/main/LICENSE)

A simple animated scoreboard plugin for your minecraft server.
# Information
[SimpleScore][GitHub] is a plugin for Minecraft servers that allows server owners to display various information to their players using the built-in Minecraft scoreboard system.

https://www.spigotmc.org/resources/simplescore.23243/
Supports selecting and showing specific scoreboards to players based on their permissions, certain conditions, current world or even the [WorldGuard][WorldGuard] region they are inside with a very simple and intuitive configuration system.

Also comes with support for both [PlaceholderAPI][PlaceholderAPI] and [MVdWPlaceholderAPI][MVdWPlaceholderAPI] allowing you to hook into thousands of other plugins to retreive and display their information in real time or create a set of conditions the player must meet to be able to see a certain scoreboard.

## Main Features
- A lag-free fully animated scoreboard with no flickering
- Fully supports RGB colors on 1.16 servers or newer
- Supports every major Minecraft version from 1.8.x to 1.20.x
- Can display scoreboards based on permissions, conditions, worlds and regions
- No character limit on 1.13 servers or newer (limited to 32 chars on older versions)*
- Fully compatible with [mcMMO][mcMMO] and other plugins that temporarly change the scoreboard*
- Every message sent by the plugin can be changed either by the built-in translation system or by providing a custom messages file

*This feature requires [ProtocolLib][ProtocolLib]. Adding [ProtocolLib][ProtocolLib] to your server will improve plugin compatibility and also reduce the number of packets sent to the players thus increasing server/client performance and reducing network bandwidth usage.

## More Information
### [Installation](https://github.com/r4g3baby/SimpleScore/wiki/Installation) - [Configuration](https://github.com/r4g3baby/SimpleScore/wiki/Configuration) - [Commands](https://github.com/r4g3baby/SimpleScore/wiki/Commands)

### Download Links
[GitHub](https://github.com/r4g3baby/SimpleScore/releases/latest) - [SpigotMC][SpigotMC] - [PaperMC][PaperMC] - [Modrinth][Modrinth]

### Quick Links
[Discord][Discord] - [Issues](https://github.com/r4g3baby/SimpleScore/issues) - [Wiki](https://github.com/r4g3baby/SimpleScore/wiki) - [bStats][bStats]

## Supporting
If you find [SimpleScore][GitHub] useful and would like to support its development, please consider following, leaving a review or rating the project on its respective platform, such as [SpigotMC][SpigotMC], [PaperMC][PaperMC] or [Modrinth][Modrinth].

Starring the project on [GitHub][GitHub] or [following me](https://github.com/r4g3baby) is a simple way to show your support. It helps increase the visibility of [SimpleScore][GitHub] and encourages others to check it out.

I also do accept financial support via [GitHub Sponsors][Sponsors] or a one-time donation via [PayPal][PayPal] to show your appreciation for the project.


[SimpleScore Logo]: https://raw.githubusercontent.com/r4g3baby/SimpleScore/main/.github/SimpleScore.png

[GitHub]: https://github.com/r4g3baby/SimpleScore
[Modrinth]: https://modrinth.com/plugin/simplescore
[SpigotMC]: https://www.spigotmc.org/resources/23243/
[PaperMC]: https://hangar.papermc.io/r4g3baby/SimpleScore

[Discord]: https://discord.gg/cJnzTDGphE
[bStats]: https://bstats.org/plugin/bukkit/SimpleScore/644

[Sponsors]: https://github.com/sponsors/r4g3baby
[PayPal]: https://paypal.me/RageBaby

[mcMMO]: https://www.spigotmc.org/resources/64348/
[WorldGuard]: https://dev.bukkit.org/projects/worldguard
[PlaceholderAPI]: https://www.spigotmc.org/resources/6245/
[MVdWPlaceholderAPI]: https://www.spigotmc.org/resources/11182/
[ProtocolLib]: https://www.spigotmc.org/resources/1997/

0 comments on commit 3ea64f5

Please sign in to comment.