Browse Source

Add required Python packaages at the bottom & fix formatting

master
elliot 3 years ago
parent
commit
2e28e111ca
  1. 24
      README.md

24
README.md

@ -1,12 +1,12 @@
![Logo](https://cdn.discordapp.com/attachments/891242169283797042/891244128384462848/59033012418c6a156f458fe6c21bd3a73c16e372.png)
# Pretext
## 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?
## 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.
@ -16,23 +16,29 @@ A tool is only as useful as the features it provides. I've made a list of detail
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 can be seen in production on the [EntryRise discord server](https://discord.com/invite/MDus3JNwhc), you can also [add the bot to your server](https://discord.com/api/oauth2/authorize?client_id=890999345195913276&permissions=34359740416&scope=bot) or you can see it 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.
## How can I use it?
Currently, the bot can be seen in production on the [EntryRise discord server](https://discord.com/invite/MDus3JNwhc), you can also [add the bot to your server](https://discord.com/api/oauth2/authorize?client_id=890999345195913276&permissions=34359740416&scope=bot) or you can see it on [our git repository](https://git.entryrise.com/elliot/EntryRiseChecker) (Required packages below). 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
## Feature: 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)
![Timings 1](https://cdn.discordapp.com/attachments/870607656732217365/891258611584630814/unknown.png)
![Timings 2](https://cdn.discordapp.com/attachments/891242169283797042/891242693089435668/unknown.png)
## Automatically convert files to pastes
## Feature: Automatically convert files to pastes
![Paste](https://cdn.discordapp.com/attachments/891242169283797042/891242291803602964/unknown.png)
## Misc commands
![Ping](https://cdn.discordapp.com/attachments/891242169283797042/891243536140341248/unknown.png)
# Forks
## Python packages
We require a few packges for this bot. You can easily install them via pip.
* discord
* aiohttp
* requests
* PyYAML
* python-decouple
## Forks
Feel free to fork. We request that you please give credit in some way, but you can do whatever you'd like with your forks.
Loading…
Cancel
Save