Upstream/Waterfall
1
0
Fork 0
mirror of https://github.com/PaperMC/Waterfall.git synced 2024-11-18 16:25:14 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #202 from sammwyy/master

Browse Source 
doc: enhance readme, code_of_conduct.md and security.md file
This commit is contained in:
Juan Cruz Linsalata 2023-02-25 17:02:02 -03:00 committed by GitHub
commit 27470c2844
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 183 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored Normal file
View File

@ -0,0 +1,2 @@
# Ensuring github workflows eol for all platform is lf
* eol=lf

133
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,133 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

44
README.md
View File

@ -1,12 +1,10 @@
# FlameCord
![Download](https://img.shields.io/badge/Download-%244.99-blue?style=flat-square) ![Discord](https://img.shields.io/discord/442079515498381312?style=flat-square&color=%237289da&label=Discord&logo=discord&logoColor=%237289da) ![GitHub](https://img.shields.io/github/license/2lstudios-mc/flamecord?style=flat-square)
FlameCord is a Waterfall fork or modification that adds antibot features, exploit prevention systems, performance improvements, removal of unused features, library updates and application layer ddos mitigation.
## Links
<a href="https://builtbybit.com/resources/13492/"><img src="https://archive.org/download/download-button-png/download-button-png.png" width=25% height=25%><img/><a/> <a href="https://discord.gg/gF36AT3"><img src="https://i.imgur.com/NyGBnuJ.png" width=25% height=25%><img/><a/>
## Features
## ⭐ Features
FlameCord being a fork of Waterfall, has all its features, and some of its own, such as:
@ -16,26 +14,48 @@ FlameCord being a fork of Waterfall, has all its features, and some of its own,
* **Performance Improvements**: FlameCord tries to improve performance by removing unused features and disabling exception logs.
## Why fork Waterfall?
## 💻 Why fork Waterfall?
FlameCord was forked out of a desire for greater protection to be afforded to a Bungeecord-based proxy, which Waterfall currently cannot offer.
FlameCord will track upstream Waterfall and merge changes as needed.
## How to (Server Admins)
## 🌱 Get Started
### How to (Server Admins)
Just drag an drop FlameCord.jar into your server folder and run it.
You can customize many FlameCord features in the flamecord.yml file.
## How To (Compiling from source)
### How To (Compiling from source)
To compile FlameCord, you need JDK8 or above, git, bash, maven, and an internet connection.
To compile FlameCord, you need JDK 8 or above, git, bash, maven, and an internet connection.
Clone this repo, run `./flamecord b` from *bash*, get jar from `FlameCord-Proxy/bootstrap/target`
```bash
# Clone this repo.
git clone https://github.com/2lstudios-mc/FlameCord
# Navigate to the cloned repository.
cd FlameCord
# Build project.
./flamecord b
```
> **Note:**
> To compile on Windows you must do it from a [git-bash](https://git-scm.com/downloads) terminal or [WSL](https://learn.microsoft.com/windows/wsl/install).
The jar will be generated in the directory `FlameCord-Proxy/bootstrap/target`
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/2lstudios-mc/flamecord).
FlameCord is compiled like Waterfall does; Please follow the [CONTRIBUTING.md](https://github.com/2lstudios-mc/FlameCord/blob/master/CONTRIBUTING.md) file. If you need help you can always contact us on Discord.
## Contribute
## 📝 License
* Feel free to open a PR! We accept contributions.
Copyright © 2018-2023 [2LStudios](https://github.com/2lstudios-mc).
This project is [MIT License](LICENSE.txt) licensed.

16
SECURITY.md Normal file
View File

@ -0,0 +1,16 @@
# Security Policy
> **Warning**
> To avoid major problems please report all vulnerabilities privately.
## Report a Vulnerability
If you suspect or confirm a possible vulnerability, let us know privately by DM. You can find us on our [Discord server](https://discord.gg/gF36AT3). Due to the limited time, it is possible that the issue will not be answered or fixed, if so, it is because the team considers that it is not of vital importance. It will still be taken into consideration.
In your report, please include as much detail as possible:
- The version or git sha of FlameCord you are running.
- Your operating system distribution & version.
- Steps to reproduce.
- Expected behavior.
- Obtained behavior.