Skip to content

Commit

Permalink
Merge branch 'dev' into new-custom-stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
VALERA771 authored Sep 26, 2024
2 parents d950085 + 816e979 commit 9ce88ec
Show file tree
Hide file tree
Showing 77 changed files with 709 additions and 413 deletions.
2 changes: 1 addition & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</div>

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

<h1 align="center">
Expand Down
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Only the latest version released supports security updates. Some prereleases may

## Reporting a Vulnerability

Exiled-Official takes the confidentiality and integrity of its user data very seriously.
ExMod-Team 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.

Expand Down
4 changes: 2 additions & 2 deletions .github/documentation/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ It also allows plugin developers to not have to change their code after every up
This documentation will show you the bare basics of making an Exiled Plugin. From here you can start showing the world what creative things you can make with this framework!

### Example Plugin
The [Example Plugin](https://github.com/galaxy119/EXILED/tree/master/Exiled.Example) which is a simple plugin that shows off events and how to properly make them. Using this example will help you learn how to properly use Exiled. There are a couple of things in that plugin that are important, lets talk about them
The [Example Plugin](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Example) which is a simple plugin that shows off events and how to properly make them. Using this example will help you learn how to properly use Exiled. There are a couple of things in that plugin that are important, lets talk about them

#### On Enable + On Disable Dynamic Updates
Exiled is a framework that has a **Reload** command which can be used to reload all the plugins and get new ones. This means you must make your plugins **Dynamically Updatable.** This means that every variable, event, coroutine, etc *must* be assigned when enabled and nullified when disabled. The **On Enable** method should enable it all, and the **On Disable** method should disable it all. But you might be wondering what about **On Reload**? That void is meant to carry over static variables, as in every static constant you make won't be wiped. So you could do something like this:
Expand Down Expand Up @@ -203,4 +203,4 @@ If you want more information you should join our [discord!](https://discord.gg/P

We have a #resources channel that you might find useful, as well as exiled contributors and plugin developers who would be willing to assist you in the creation of your plugin(s).

Or you could read all the events that we have! If you want to check them out [here!](https://github.com/galaxy119/EXILED/tree/master/Exiled.Events/EventArgs)
Or you could read all the events that we have! If you want to check them out [here!](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Events/EventArgs)
18 changes: 9 additions & 9 deletions .github/documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ Installation of EXILED is quite simple. It loads itself through Northwood’s Pl
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-Official/EXILED/blob/master/EXILED/Exiled.Installer/README.md))
### Automatic installation ([more information](https://github.com/ExMod-Team/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-Official/EXILED/releases)** (click on Assets -> click the Installer)
- Download the **`Exiled.Installer-Win.exe` [from here](https://github.com/ExMod-Team/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
- Double click the **`Exiled.Installer.exe`** or **[download this .bat](https://www.dropbox.com/scl/fi/7yh0r3q0vdn6ic4rhuu3l/install-prerelease.bat?rlkey=99fwjbwy1xg61qgtak0qzb9rd&st=8xs4xks8&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-Official/EXILED/releases)**
- Download the **`Exiled.tar.gz` [from here](https://github.com/ExMod-Team/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 @@ -37,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-Official/EXILED/blob/master/EXILED/Exiled.Installer/README.md))
### Automatic installation ([more information](https://github.com/ExMod-Team/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-Official/EXILED/releases)** (click on Assets -> download the Installer)
- Download the **`Exiled.Installer-Linux` [from here](https://github.com/ExMod-Team/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-Official/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/ExMod-Team/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 All @@ -69,9 +69,9 @@ However, some plugins might get their config settings from other locations on th

# For Developers

If you wish to make a plugin for EXILED, it's quite simple to do so. If you would like more of a tutorial please visit our [Getting Started Page.](https://exiled.to/Archive/GettingStarted).
If you wish to make a plugin for EXILED, it's quite simple to do so. If you would like more of a tutorial please visit our [Getting Started Page.](GettingStarted.md).

For more comprehensive and actively updated tutorials, see [the EXILED website](https://exiled.to/Archive/Documentation).
For more comprehensive and actively updated tutorials, see [the EXILED website](https://exmod-team.github.io/EXILED/).

But make sure to follow these rules when publishing your plugins:

Expand Down
4 changes: 2 additions & 2 deletions .github/documentation/localization/GettingStarted-BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Isso também permite que desenvolvedores de plug-in não precisem atualizar seus
Esse documento mostrará a você os básicos de como se fazer um Plug-in para o Exiled. A partir daqui, você poderá mostrar ao mundo as coisas criativas que você pode criar com essa framework!

### Exemplo de Plug-in
Um [Exemplo de Plug-in](https://github.com/galaxy119/EXILED/tree/master/Exiled.Example) que é um plug-in simples que mostra eventos e como fazer eles adequadamente. Usar esse exemplo ajudará você a aprender a como usar o Exiled apropriadamente. Há alguns aspectos nesse plug-in que são importantes, falaremos sobre eles.
Um [Exemplo de Plug-in](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Example) que é um plug-in simples que mostra eventos e como fazer eles adequadamente. Usar esse exemplo ajudará você a aprender a como usar o Exiled apropriadamente. Há alguns aspectos nesse plug-in que são importantes, falaremos sobre eles.

#### Atualizações Dinâmicas em On Enable + On Disable
Exiled é uma framework que tem um comando de **Reload** que pode ser usado para recarregar todos os plug-ins e obter novos. Isso significa que você deve fazer com que seus plug-ins sejam **Dinamicamente Atualizáveis.** Isso significa que toda variável, evento, corrotina, etc *deve* ser atribuída quando ativada e anulada quando desativada. O método **On Enable** deve ativar todos, e o método **On Disable** deve desativar todos. Mas talvez você esteja se perguntando 'E o **On Reload**'? Essa função tem como objetivo carregar variáveis estáticas para que toda constante estática que você fizer não seja apagada. Então você poderia fazer algo assim:
Expand Down Expand Up @@ -203,4 +203,4 @@ Se você quiser mais informações, você deve entrar no nosso [discord!](https:

Nós temos um canal de #resources que você pode considerar útil, assim como colaboradores do EXILED e desenvolvedores de plug-in que estariam dispostos a ajudá-lo na criação de seus plug-ins.

Ou você poderia ler sobre todos os eventos que nós temos! Se você deseja verificá-los, veja [aqui!](https://github.com/galaxy119/EXILED/tree/master/Exiled.Events/EventArgs)
Ou você poderia ler sobre todos os eventos que nós temos! Se você deseja verificá-los, veja [aqui!](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Events/EventArgs)
4 changes: 2 additions & 2 deletions .github/documentation/localization/GettingStarted-FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Cela permet aussi au developpeurs de plugin à ne pas avoir à constament mettre
Ce document ci-joint va vous apprendre les bases pour la création d'un plugin Exiled.D'ici là vous pouvez motrer au monde entier toute la créativitée que vous avez en vous et pourrez créé grace à ce-ci!

### Exemple de Plugin
Un [Exemple de Plugin](https://github.com/galaxy119/EXILED/tree/master/Exiled.Example) qui est un simple plugin montrant les différents évenements et comment les mettre en place proprement. Cette exemple vous permettra d'apprende à utiliser correctement Exiled. Plusieurs choses sont important dans ce plugin, nous allons donc les voir.
Un [Exemple de Plugin](https://github.com/Exmod-Team/EXILED/tree/master/EXILED/Exiled.Example) qui est un simple plugin montrant les différents évenements et comment les mettre en place proprement. Cette exemple vous permettra d'apprende à utiliser correctement Exiled. Plusieurs choses sont important dans ce plugin, nous allons donc les voir.

#### On Enable + On Disable Mise à jour Dynamique
Exiled est un framework qui dispose d'une commande de **Rechargement** qui peut être utilisée pour recharger tous les plugins et en obtenir de nouveaux. Cela signifie que vous devez rendre vos plugins **Dynamiquement à jour.** Cela signifie que chaque variable, événement, coroutine, etc. *doit* être assigné lorsqu'il est activé et annulé lorsqu'il est désactivé. La méthode **On Enable** devrait tout activer, et la méthode **On Disable** devrait tout désactiver. Mais vous vous demandez peut-être ce qu'il en est de **On Reload**? Cette fonction est destinée à transférer les variables statiques, c'est-à-dire que toutes les constantes statiques que vous créez ne seront pas effacées. Vous pouvez donc faire quelque chose comme cela :
Expand Down Expand Up @@ -202,4 +202,4 @@ Si vous voulez plus d'informations, vous devriez rejoindre notre [discord!](http

Nous avons un canal #resources que vous pourriez trouver utile, ainsi que des contributeurs Exiled et des développeurs de plugins qui seraient prêts à vous aider dans la création de votre/vos plugin(s).

Ou vous pourriez consulter tous les événements que nous avons ! Si vous voulez les consulter, [ici!](https://github.com/galaxy119/EXILED/tree/master/Exiled.Events/EventArgs)
Ou vous pourriez consulter tous les événements que nous avons ! Si vous voulez les consulter, [ici!](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Events/EventArgs)
4 changes: 2 additions & 2 deletions .github/documentation/localization/GettingStarted-KR.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Exiled는 불필요한 부분 없이 게임에서 함수를 직접적으로 호
이 문서는 Exiled 플러그인을 만들기 위한 가장 기본적인 부분을 설명하고 있습니다. 여기서부터 Exiled와 함께 당신의 창의력으로 무엇이든지 만들어보세요!

### 플러그인 예제
[플러그인 예제](https://github.com/galaxy119/EXILED/tree/master/Exiled.Example)는 이벤트를 사용하는 방법과 기본적인 구조를 설정하는 방법을 잘 나타내고 있습니다. 이것을 통해 Exiled를 제대로 사용하는 방법을 알 수 있으며, 이 플러그인 예제 안에는 몇 가지의 중요한 부분이 있습니다. 한번 볼까요?
[플러그인 예제](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Example)는 이벤트를 사용하는 방법과 기본적인 구조를 설정하는 방법을 잘 나타내고 있습니다. 이것을 통해 Exiled를 제대로 사용하는 방법을 알 수 있으며, 이 플러그인 예제 안에는 몇 가지의 중요한 부분이 있습니다. 한번 볼까요?

#### OnEnable + OnDisable 동적 업데이트
Exiled는 **Reload** 명령어를 통해 원래 있던 모든 플러그인과 새 플러그인들을 리로드 할 수 있습니다. 이 말은 여러분이 여러분들의 플러그인을 **동적으로 업데이트** 할 수 있게 만들어야 한다는 뜻입니다. 모든 변수, 이벤트, 코루틴 등등은 *무조건* 활성화되었을 때 할당되고 비활성화되었을 때 null이 되어야 합니다. **OnEnable** 메소드는 모든 것들을 활성화시켜야 하고, **OnDisable** 메소드는 모든 것을 비활성화시켜야 합니다. 그러면 **OnReload**는 뭘까요? 정적인 변수들은 리로드 될 때 지워지지 않으므로, 이 메소드는 변수들을 지워지게 놔두고 싶지 않을 때 사용합니다. 예를 들어:
Expand Down Expand Up @@ -211,4 +211,4 @@ public override OnEnabled()

#resources 채널에 들어가 유용한 정보들을 찾을 수 있으며, 여러분의 플러그인 개발을 기꺼이 도와줄 Exiled 기여자분들 또는 플러그인 개발자분들이 준비되어 있습니다.

...아니면 현재 존재하는 이벤트를 모두 읽고 싶으시다면 [여기](https://github.com/galaxy119/EXILED/tree/master/Exiled.Events/EventArgs)를 클릭해주세요!
...아니면 현재 존재하는 이벤트를 모두 읽고 싶으시다면 [여기](https://github.com/ExMod-Team/EXILED/tree/master/Exiled.Events/EventArgs)를 클릭해주세요!
Loading

0 comments on commit 9ce88ec

Please sign in to comment.