Browse Source

Beautify readme

master
elliot 3 years ago
parent
commit
fe62ffeca6
  1. 30
      README.md

30
README.md

@ -1,3 +1,26 @@
![Logo](https://cdn.discordapp.com/attachments/891242169283797042/891244128384462848/59033012418c6a156f458fe6c21bd3a73c16e372.png)
# Pretext
Over the years, multiple performance optimization guides, recommendations, and tools have come to try to address the ever-important issue of optimization.
To try to make optimization more accessible to beginner server owners, while also not omitting important information and nuance that is often required to properly bring results in your performance optimization attempts, we released a free discord bot that people can use to analyze their timings report.
It was forked off [Botflop](https://github.com/Pemigrade/botflop) and almost completely overhauled in terms of recommendations, alerts, etc.
# What can it do?
A tool is only as useful as the features it provides. I've made a list of details that the discord bot will provide to users:
* Recommended spigot.yml, paper.yml, bukkit.yml, server.properties, purpur.yml, tuinity.yml configurator
* Plugins list analyser. Checks for redundancies for features; notifies about plugins that may cause performance issues and need configured/replaced with alternatives.
* A calculation to verify if RAM is enough for the server.
* Verifying the server version used, and brings information and recommendations.
* Verifying java version (Hotspot, OpenJ9 notifications, old version checks, etc)
We're planning to expand the system significantly, to hopefully make the project more in-depth. From providing information based on game mode type (eg: Survival, SkyBlock, BedWars) to allowing free notifications of security issues and ways to resolve them via PM to warn people about issues in the mc community.
# How can I use it?
Currently, the bot is available in production on the [EntryRise discord server](https://discord.com/invite/MDus3JNwhc), by [adding the bot to your server](https://discord.com/api/oauth2/authorize?client_id=890999345195913276&permissions=34359740416&scope=bot) or on [our git repository](https://git.entryrise.com/elliot/EntryRiseChecker). We hope that you will contribute to the project, notify us about issues and help us make server timings analysis more easy and accessible to end users.
# Showcase
## Analyze timings reports ## Analyze timings reports
Paste a timings report to review an in-depth description of potential optimizations. You can try it out yourself on our [Discord](https://discord.gg/MDus3JNwhc) Paste a timings report to review an in-depth description of potential optimizations. You can try it out yourself on our [Discord](https://discord.gg/MDus3JNwhc)
@ -8,11 +31,8 @@ Paste a timings report to review an in-depth description of potential optimizati
## Automatically convert files to pastes ## Automatically convert files to pastes
![Paste](https://cdn.discordapp.com/attachments/891242169283797042/891242291803602964/unknown.png) ![Paste](https://cdn.discordapp.com/attachments/891242169283797042/891242291803602964/unknown.png)
## Add the bot to your server
[Invite Link](https://discord.com/api/oauth2/authorize?client_id=890999345195913276&permissions=34359740416&scope=bot)
# Misc commands
Ping command;
## Misc commands
Ping command:
![Ping](https://cdn.discordapp.com/attachments/891242169283797042/891243536140341248/unknown.png) ![Ping](https://cdn.discordapp.com/attachments/891242169283797042/891243536140341248/unknown.png)
# Forks # Forks

Loading…
Cancel
Save