diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 000000000..87f2fe921 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: EndlessHostRoles # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +polar: # Replace with a single Polar username +buy_me_a_coffee: # Replace with a single Buy Me a Coffee username +thanks_dev: # Replace with a single thanks.dev username +custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..12ed57b3c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,72 @@ +# Code of Conduct for Endless Host Roles (EHR) + +This Code of Conduct applies to **all interactions** involving the EHR community, including: + +- Contributing to the GitHub repository +- Participating in the Discord server +- Playing games with the EHR mod + +Our goal is to ensure a **safe, fun, and fair environment** for everyone. + +--- + +## 1. Expected Behavior + +We encourage everyone to: + +- **Play fair** and follow the rules set by hosts +- **Have fun** and make sure others are having fun too +- **Pay attention** to instructions and read all relevant information before acting +- **Respect unfixable bugs**, do not abuse them for unfair advantage +- **Be considerate** of new players and other community members + +--- + +## 2. Unacceptable Behavior + +The following behaviors are **strictly prohibited**: + +- Harassment, discrimination, or any speech or actions that can be mentally harmful +- Abusing hosts or intentionally sabotaging the experience for others +- Cheating in ways that ruin fairness or fun + +**Note:** Light trolling is allowed as long as everyone involved enjoys it and it does not negatively impact anyone. + +--- + +## 3. Reporting Violations + +If you encounter violations of this Code of Conduct: + +1. Report abuse via the **EHR Discord server** using a support ticket. +2. Provide as much information as possible about the offender: + - Friend code + - Hashed PUID + - Discord ID + At least **one** of these is required. +3. Reports should be **attributed**, anonymous reports are not accepted. + +--- + +## 4. Enforcement + +Violations will be handled by the **project maintainer and Discord moderators**. Possible consequences include: + +- Warnings +- Temporary or permanent bans from **all EHR lobbies** +- Bans from the Discord server and partner communities + +Enforcement is applied **consistently** to ensure the community remains safe and fun for everyone. + +--- + +## 5. Additional Notes + +- **Jokes and playful behavior** are welcome as long as everyone understands them and enjoys them. +- The **top priority** is that everyone has fun and plays fairly. Do not ruin the experience for others. + +By participating in EHR, you agree to abide by this Code of Conduct. + +--- + +Thank you for helping keep EHR a fun, fair, and welcoming community! 💜 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e63070862 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributing to Endless Host Roles (EHR) + +Thanks for your interest in contributing! We appreciate any help, whether it's fixing bugs, improving features, or enhancing documentation. + +Please read through these guidelines before submitting your contributions. + +--- + +## 1. Getting in Touch + +If you have questions, ideas, or want to discuss changes before submitting them, reach out through the **[EHR Discord server](https://discord.gg/yourserverlink)**. + +You don’t need to get approval for every small fix or improvement, as long as the changes are sensible and helpful to the project. + +--- + +## 2. Workflow + +- This project uses a **single branch** (usually `main`). +- Pull Requests (PRs) should **squash commits** before merging. +- Linking PRs to issues is **not required**. +- Before making major changes to core features, please check with the community or ask in Discord to ensure it’s wanted. + +--- + +## 3. Coding Guidelines + +- Follow the **existing code style**. +- JetBrains Rider is recommended, as the editor settings are included in the repo, so they will sync automatically if used by contributors. +- Make sure your changes are consistent with the surrounding code. + +--- + +## 4. Issues & Bug Reports + +- There’s no formal requirement to create issues. +- If you notice something that doesn’t work or can be improved and you know how to fix it, feel free to make a PR directly. +- For discussion or questions, the **Discord server** is preferred over GitHub issues. + +--- + +## 5. Reviewing & Merging + +- All PRs are **reviewed personally** by the project maintainer. +- No automated approval or checks are required; every decision is made manually. +- Ensure your PR is **well-documented**, and any changes are clear in the description. + +--- + +## 6. Special Notes + +- Before modifying **major features**, check with the community or confirm that your change is desirable. +- Contributions to documentation, translations, or examples are always welcome! + +--- + +Thank you for helping make EHR better! 💜 diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..a81959a1c --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,43 @@ +# Security Policy for Endless Host Roles (EHR) + +Ensuring the security of our community and mod is a top priority. This document explains how to responsibly report security issues and what to expect. + +--- + +## 1. Reporting a Vulnerability + +If you discover a security vulnerability in EHR (either in-game exploits or issues in the mod code), please report it **privately** through the **[EHR Discord server](https://discord.gg/ehr)** by opening a support ticket. + +**Include as much information as possible:** + +- Steps to reproduce the issue +- Video footage or screenshots demonstrating the problem +- Logs from the mod (`log.html`, `LogOutput.log`, `Errorlog.log`) + +Providing all three is ideal to help us understand and fix the issue quickly. + +--- + +## 2. Response Time + +We aim to respond to all security reports **within the same day** whenever possible. + +--- + +## 3. Scope + +This policy applies to: + +- In-game exploits or bugs that could be abused +- Mod code vulnerabilities that could affect users or the community + +--- + +## 4. Disclosure + +- Please **do not publicly disclose** any vulnerabilities until a fix has been released. +- We will work to release a patch as soon as possible to resolve reported issues. + +--- + +Thank you for helping us keep EHR safe and fair for all players. 💜 diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 000000000..ba6b2f1d4 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,57 @@ +# Support for Endless Host Roles (EHR) + +If you need help with EHR, here’s how to get support for different situations: + +--- + +## 1. General Questions + +For gameplay questions, mod features, or general discussion: + +- Ask the **community** on the **[EHR Discord server](https://discord.gg/ehr)** +- Discuss ideas, tips, or suggestions democratically — the community decides what’s best + +--- + +## 2. Bug Reports + +If you encounter a bug or technical issue: + +- Submit a **bug report** through GitHub Issues or Discord +- Include as much information as possible: + - Steps to reproduce the issue + - Platform / version of the mod + - Any relevant logs or screenshots + +--- + +## 3. Reporting Abuse + +If a player is behaving inappropriately in-game or on Discord: + +- Open a **support ticket** on the **Discord server** +- Provide at least one of the following for identification: + - Friend code + - Hashed PUID + - Discord ID +- Include all relevant context and evidence for the report + +--- + +## 4. Response Times + +We aim to respond to **all support requests within 1 hour** whenever possible. + +--- + +## 5. Contributor Support + +If you’re contributing to EHR: + +- Discuss questions or ideas with the community first +- Check **CONTRIBUTING.md** for coding guidelines and workflow +- Respect the democratic decision-making of the project when suggesting major changes + +--- + +Thank you for helping make EHR fun and fair for everyone! 💜