Skip to content

Commit

Permalink
Reorganization
Browse files Browse the repository at this point in the history
  • Loading branch information
louis1706 committed Jul 15, 2024
1 parent a36e028 commit edfa38f
Show file tree
Hide file tree
Showing 905 changed files with 1,057 additions and 11,074 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 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, 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
.
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.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
115 changes: 115 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<h1 align="center">Exiled</h1>
<h6 align="center">EXtended In-runtime Library for External Development</h6>
<div align="center">
Join our
<a href="https://discord.gg/PyUkWTg">Discord</a>
for support.
<p></p>
</div>

<div align="center">

[![Version](https://img.shields.io/github/v/release/Exiled-Official/EXILED?sort=semver&style=flat-square&color=8DBBE9&label=Version)]()
[![License](https://img.shields.io/github/license/Exiled-Official/EXILED?style=flat-square&label=License&color=df967f)]()
[![Contributors](https://img.shields.io/github/contributors-anon/Exiled-Official/EXILED?color=90E59A&style=flat-square&label=Contributors)]()
[![GitHub Issues](https://img.shields.io/github/issues/Exiled-Official/EXILED.svg?style=flat-square&label=Issues&color=d77982)](https://github.com/Exiled-Official/EXILED/issues)
[![Discord](https://img.shields.io/discord/656673194693885975?color=738adb&label=Discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/PyUkWTg)

</div>

<p align="center">
<img alt="EXILED Development" src="https://repobeats.axiom.co/api/embed/28884ad6594de5dc7a7153c63389ec2759aeeb7d.svg">
</p>

<h1 align="center">
Localized READMEs
</h1>

<div align="center">
<div>
<img src="https://flagsapi.com/US/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/README.md">English</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/RU/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-Русский.md">Русский</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/CN/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-中文.md">中文</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/ES/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-ES.md">Español</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/PL/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-PL.md">Polski</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/BR/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-BR.md">Português-BR</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/IT/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-IT.md">Italiano</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/CZ/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-CS.md">Čeština</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/DK/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-DK.md">Dansk</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/TR/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-TR.md">Türkçe</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/DE/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-DE.md">German</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/FR/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-FR.md">Français</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/KR/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-KR.md">한국어</a>
</div>
<br>
<div>
<img src="https://flagsapi.com/TH/flat/64.png" height=30>
<br>
<a href="https://github.com/Exiled-Official/EXILED/blob/master/.github/documentation/localization/README-ไทย.md">ไทย</a>
</div>
</div>

<h5 align="center">This repo is a fork of <a href="https://github.com/Exiled-Team/EXILED">Exiled-Team/EXILED</a> after the old repository was taken hostage by the old lead developer.</h5>
<h6 align="center">You can access the commit this update was forked from <a href="https://github.com/Exiled-Team/EXILED/tree/8b03fe7d9d2fe7ebffd5e6d1d038fc3881cdeb70">here</a>.</h6>
13 changes: 13 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security Policy

## Supported Versions

Only the latest version released supports security updates. Some prereleases may also support them.

## Reporting a Vulnerability

Exiled-Official takes the confidentiality and integrity of its user data very seriously.

If you have detected a vulnerability on our codebase please report it to us inmediately.

To contact us use the following discord server: https://discord.gg/PyUkWTg
File renamed without changes.
43 changes: 8 additions & 35 deletions README.md → .github/documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,27 @@
<h1 align="center">EXILED - EXtended In-runtime Library for External Development</h1>
<div align="center">

[<img src="https://img.shields.io/github/actions/workflow/status/Exiled-Team/EXILED/main.yml?style=for-the-badge&logo=githubactions&label=build" alt="CI"/>](https://github.com/Exiled-Team/EXILED/actions/workflows/main.yml/badge.svg?branch=master)
<a href="https://github.com/Exiled-Team/EXILED/releases"><img src="https://img.shields.io/github/v/release/Exiled-Team/EXILED?display_name=tag&style=for-the-badge&logo=gitbook&label=Release" href="https://github.com/Exiled-Team/EXILED/releases" alt="GitHub Releases"></a>
<img src="https://img.shields.io/github/downloads/Exiled-Team/EXILED/total?style=for-the-badge&logo=github" alt="Downloads">
![Github Commits](https://img.shields.io/github/commit-activity/w/Exiled-Team/EXILED/apis-rework?style=for-the-badge&logo=git)
<a href="https://discord.gg/PyUkWTg">
<img src="https://img.shields.io/discord/656673194693885975?style=for-the-badge&logo=discord" alt="Chat on Discord">
</a>

</div>

# EXILED
EXILED is a high-level plugin framework for SCP: Secret Laboratory servers. It offers an event system for developers to hook into in order to manipulate or change game code or implement their own functions.
All EXILED events are coded with Harmony, meaning they require no direct editing of server assemblies to function, which allows for two unique benefits.

- Firstly, the entirety of the framework’s code can be freely published and shared, allowing developers to better understand *how* it works and offer suggestions for adding to or changing its features.
- Secondly, since all the code related to the framework is done outside of the server assembly, things like small game updates will have little, if any, effect on the framework. Making it most likely to be compatible with future game updates, as well as making it easier to update when it *is* necessary to do so.

# Localized READMEs
- [Русский](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-Русский.md)
- [中文](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-中文.md)
- [Español](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-ES.md)
- [Polski](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-PL.md)
- [Português-BR](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-BR.md)
- [Italiano](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-IT.md)
- [Čeština](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-CS.md)
- [Dansk](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-DK.md)
- [Türkçe](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-TR.md)
- [German](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-DE.md)
- [Français](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-FR.md)
- [한국어](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-KR.md)
- [ไทย](https://github.com/Exiled-Team/EXILED/blob/master/Localization/README-ไทย.md)


# Installation
Installation of EXILED is quite simple. It loads itself through Northwood’s Plugin API. That's why there are two folders inside the ``Exiled.tar.gz`` in release files. ``SCP Secret Laboratory`` contains the necessary files to load EXILED features in ``EXILED`` folder. All you need to do is move these two folders into the appropriate path, which are explained below, and you are done!

If you choose to use the installer it will, if run correctly, take care of installing all EXILED features.

# Windows
### Automatic installation ([more information](https://github.com/Exiled-Team/EXILED/blob/master/Exiled.Installer/README.md))
### Automatic installation ([more information](https://github.com/Exiled-Official/EXILED/blob/master/EXILED/Exiled.Installer/README.md))
**Note**: Make sure you're on the user that runs the server, or you have Admin privileges before running the Installer.

- Download the **`Exiled.Installer-Win.exe` [from here](https://github.com/Exiled-Team/EXILED/releases)** (click on Assets -> click the Installer)
- Download the **`Exiled.Installer-Win.exe` [from here](https://github.com/Exiled-Official/EXILED/releases)** (click on Assets -> click the Installer)
- Place it on your server folder (download the dedicated server if you haven't)
- Double click the **`Exiled.Installer.exe`** or **[download this .bat](https://www.dropbox.com/s/xny4xus73ze6mq9/install-prerelease.bat?dl=1)** and place it in the server folder to install the latest pre-release
- To get and install plugins, check the [Installing plugins](#installing-plugins) section down below.
**Note:** If you are installing EXILED on a remote server, make sure you run the .exe as the same user that runs your SCP:SL servers (or one with Admin privileges)

### Manual installation
- Download the **`Exiled.tar.gz` [from here](https://github.com/Exiled-Team/EXILED/releases)**
- Download the **`Exiled.tar.gz` [from here](https://github.com/Exiled-Official/EXILED/releases)**
- Extract its contents with [7Zip](https://www.7-zip.org/) or [WinRar](https://www.win-rar.com/download.html?&L=6)
- Move the **``EXILED``** folder to **`%appdata%`** *Note: This folder needs to go in ``C:\Users\%UserName%\AppData\Roaming``, and ***NOT*** ``C:\Users\%UserName%\AppData\Roaming\SCP Secret Laboratory``, and **IT MUST** be in (...)\AppData\Roaming, not (...)\AppData\!*
- Move **``SCP Secret Laboratory``** to **`%appdata%`**.
Expand All @@ -64,19 +37,19 @@ That's it, EXILED should now be installed and active the next time you boot up y
- Move it to: ``C:\Users\%UserName%\AppData\Roaming\EXILED\Plugins`` (move here by pressing Win + R, then writing `%appdata%`)

# Linux
### Automatic installation ([more information](https://github.com/Exiled-Team/EXILED/blob/master/Exiled.Installer/README.md))
### Automatic installation ([more information](https://github.com/Exiled-Official/EXILED/blob/master/EXILED/Exiled.Installer/README.md))

**Note:** If you are installing EXILED on a remote server, make sure you run the Installer as the same user that runs your SCP:SL servers (or root)

- Download the **`Exiled.Installer-Linux` [from here](https://github.com/Exiled-Team/EXILED/releases)** (click on Assets -> download the Installer)
- Download the **`Exiled.Installer-Linux` [from here](https://github.com/Exiled-Official/EXILED/releases)** (click on Assets -> download the Installer)
- Install it by either typing **`./Exiled.Installer-Linux --path /path/to/server`** or move it inside the server folder directly, move to it with the terminal (`cd`) and type: **`./Exiled.Installer-Linux`**.
- If you want the latest pre-release, simply add **`--pre-releases`**. Example: **`./Exiled.Installer-Linux /home/scp/server --pre-releases`**
- Another example, if you placed `Exiled.Installer-Linux` in your server folder: **`/home/scp/server/Exiled.Installer-Linux --pre-releases`**
- To get and install plugins, check the [Installing plugins](#installing-plugins-1) section down below.

### Manual installation
- **Ensure** you are logged in on the user that runs the SCP servers.
- Download the **`Exiled.tar.gz` [from here](https://github.com/Exiled-Team/EXILED/releases)** (SSH: right click and to get the `Exiled.tar.gz` link, then type: **`wget (link_to_download)`**)
- Download the **`Exiled.tar.gz` [from here](https://github.com/Exiled-Official/EXILED/releases)** (SSH: right click and to get the `Exiled.tar.gz` link, then type: **`wget (link_to_download)`**)
- To extract it to your current folder, type **``tar -xzvf EXILED.tar.gz``**
- Move the **`EXILED`** folder to **``~/.config``**. *Note: This folder needs to go in ``~/.config``, and ***NOT*** ``~/.config/SCP Secret Laboratory``* (SSH: **`mv EXILED ~/.config/`**)
- Move the **`SCP Secret Laboratory`** folder to **``~/.config``**. *Note: This folder needs to go in ``~/.config``, and ***NOT*** ``~/.config/SCP Secret Laboratory``* (SSH: **`mv SCP Secret Laboratory ~/.config/`**)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit edfa38f

Please sign in to comment.