Skip to content
This repository has been archived by the owner on Jan 19, 2025. It is now read-only.

[GH Repo] Fixed some stuff in the repository #2735

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Re-added DocFX
skManux committed Jul 20, 2024
commit e68397720441274632851b39143b7fb0d59473fe
44 changes: 44 additions & 0 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"metadata": [
{
"src": [
{
"files": [ "EXILED.sln" ]
}
],
"dest": "obj/docs/api",
"filter": "docs/filterConfig.yml"
}
],
"build": {
"content": [
{
"src": "obj/docs/",
"files": ["**/*.yml"]
},
{
"src": "docs",
"files": ["**/*.md"]
},
{
"files": ["toc.yml", "docs/articles/toc.yml"]
}
],
"resource": [
{
"files": ["assets/**"]
}
],
"dest": "_site",
"globalMetadata": {
"_appTitle": "EXILED Docs",
"_enableSearch": true,
"_gitContribute": {
"repo": "https://github.com/Exiled-Team/EXILED",
"branch": "dev"
},
"_appLogoPath": "assets/logo.png",
"_appFaviconPath": "assets/logo.png"
}
}
}
21 changes: 21 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
/package-lock.json
6 changes: 6 additions & 0 deletions docs/App.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
</startup>
</configuration>
17 changes: 17 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# EXILED Docs

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation of Dependencies

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
3 changes: 3 additions & 0 deletions docs/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
57 changes: 57 additions & 0 deletions docs/docs.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<AssemblyName>docs</AssemblyName>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<Configurations>Debug;Release;Installer</Configurations>
<Platforms>AnyCPU</Platforms>
</PropertyGroup>

<Import Project="../EXILED.props" />

<ItemGroup>
<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
<_Parameter1>Exiled.API</_Parameter1>
</AssemblyAttribute>
</ItemGroup>

<ItemGroup>
<PackageReference Include="StyleCop.Analyzers" Version="$(StyleCopVersion)" IncludeAssets="All" PrivateAssets="All" />
<PackageReference Include="System.Memory" Version="4.5.5" />
<PackageReference Include="Lib.Harmony" Version="$(HarmonyVersion)" />
</ItemGroup>
<ItemGroup>
<None Include="App.config" />
<None Include="docs\Resources\Intro.md">
<AutoGen>True</AutoGen>
<DesignTime>True</DesignTime>
<DependentUpon>Intro.tt</DependentUpon>
</None>
</ItemGroup>
<ItemGroup>
<Content Include="docs\Resources\Intro.tt">
<Generator>TextTemplatingFileGenerator</Generator>
<LastGenOutput>Intro.md</LastGenOutput>
</Content>
</ItemGroup>
<ItemGroup>
<Reference Include="Assembly-CSharp">
<HintPath>$(EXILED_REFERENCES)\Assembly-CSharp-Publicized.dll</HintPath>
</Reference>
<Reference Include="Assembly-CSharp-firstpass" HintPath="$(EXILED_REFERENCES)\Assembly-CSharp-firstpass.dll" Private="false" />
<Reference Include="CommandSystem.Core" HintPath="$(EXILED_REFERENCES)\CommandSystem.Core.dll" Private="false" />
<Reference Include="Pooling" HintPath="$(EXILED_REFERENCES)\Pooling.dll" Private="false" />
<Reference Include="Mirror" HintPath="$(EXILED_REFERENCES)\Mirror.dll" Private="false" />
<Reference Include="NorthwoodLib" HintPath="$(EXILED_REFERENCES)\NorthwoodLib.dll" Private="false" />
<Reference Include="PluginAPI" HintPath="$(EXILED_REFERENCES)\PluginAPI.dll" Private="false" />
<Reference Include="UnityEngine" HintPath="$(EXILED_REFERENCES)\UnityEngine.dll" Private="false" />
<Reference Include="UnityEngine.CoreModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.CoreModule.dll" Private="false" />
<Reference Include="UnityEngine.PhysicsModule" HintPath="$(EXILED_REFERENCES)\UnityEngine.PhysicsModule.dll" Private="false" />
<Reference Include="YamlDotNet" HintPath="$(EXILED_REFERENCES)\YamlDotNet.dll" Private="false" />
</ItemGroup>
<ItemGroup>
<Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
</ItemGroup>

</Project>
41 changes: 41 additions & 0 deletions docs/docs/Contributing/Intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1
---
# Contributing to EXILED

This is a simple tutorial guiding you to contribute to our framework.

### Forking EXILED
First, create a fork of our [GitHub repository](https://github.com/Exiled-Team/EXILED).

Then, clone it to your computer like so: `git clone https://github.com/your-username/EXILED.git`

Open a terminal in your forked EXILED folder and run ```git checkout dev```. This will switch you to the dev branch, which all pull requests should be submitted to.

### Setting `EXILED_REFERENCES`

If you haven't already, install the `SCP: Secret Laboratory Dedicated Server` through Steam or extract [this zip file](https://exiled.host/build_deps/References.zip) to an easily accessible folder.

#### Windows users
Open the Environment Variables menu by searching for `Environment Variables` in the Start Menu.

Create a new environment variable titled `EXILED_REFERENCES`.

The value should point to `your_steamapps_directory/common/SCP Secret Laboratory Dedicated Server/SCPSL_Data/Managed`, or to the folder where you extracted the zip file mentioned earlier.

#### Linux users
Add `export EXILED_REFERENCES="PATH"` to your `~/.bashrc` or similar file.

PATH should point to `your_steamapps_directory/common/SCP Secret Laboratory Dedicated Server/SCPSL_Data/Managed`, or to the folder where you extracted the zip file mentioned earlier.

---

You should now be able to open the EXILED directory in your favorite IDE.


Once you are done, test your changes thoroughly, and then submit a pull request to the main EXILED repository. Make sure you are targeting the `dev` branch, not `master`!

Happy coding!

## Contributing docs
Documentation is built using [Docosaurus](https://docusaurus.io/docs)
4 changes: 4 additions & 0 deletions docs/docs/Contributing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Contributing",
"position": 5
}
43 changes: 43 additions & 0 deletions docs/docs/Installation/Automatic/Linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 2
---

# Automatic Linux Installation

Download `Exiled.Installer-Linux` from [here](https://github.com/Exiled-Team/EXILED/releases).

Move it into your **server directory** and run it using `./Exiled.Installer-Linux`
- Make sure the server directory is the one where LocalAdmin executable is found.

#### Usage
```
Usage:
Exiled.Installer [options] [[--] <additional arguments>...]]

Options:
-p, --path <path> (REQUIRED) Path to the folder with the SL server [default: YourWorkingFolder]
--appdata <appdata> (REQUIRED) Forces the folder to be the AppData folder (useful for containers when pterodactyl runs as root) [default: YourAppDataPath]
--pre-releases Includes pre-releases [default: False]
--target-version <target-version> Target version for installation
--github--token <github--token> Uses a token for auth in case the rate limit is exceeded (no permissions required)
--exit Automatically exits the application anyway
--get-versions Gets all possible versions for installation
--version Show version information
-?, -h, --help Show help and usage information

Additional Arguments:
Arguments passed to the application that is being run.
```

-----

#### Examples

- ##### Installation in a specific folder, specific version and specific appdata folder
```powershell title="Basic installation in the folder you are in"
.\Exiled.Installer-Linux --pre-releases
```

```powershell title="Installation in a specific folder, specific version and specific appdata folder"
.\Exiled.Installer-Linux -p /home/user/scpsl/server --appdata /home/user/scpsl --target-version 2.0.8
```
43 changes: 43 additions & 0 deletions docs/docs/Installation/Automatic/Windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
sidebar_position: 1
---

# Automatic Windows Installation

Download `Exiled.Installer-Win.exe` from [here](https://github.com/Exiled-Team/EXILED/releases).

Move it into your **server directory** and double click the .exe.
- Make sure the server directory is the one where LocalAdmin.exe is found.

#### Usage
```
Usage:
Exiled.Installer [options] [[--] <additional arguments>...]]

Options:
-p, --path <path> (REQUIRED) Path to the folder with the SL server [default: YourWorkingFolder]
--appdata <appdata> (REQUIRED) Forces the folder to be the AppData folder (useful for containers when pterodactyl runs as root) [default: YourAppDataPath]
--pre-releases Includes pre-releases [default: False]
--target-version <target-version> Target version for installation
--github--token <github--token> Uses a token for auth in case the rate limit is exceeded (no permissions required)
--exit Automatically exits the application anyway
--get-versions Gets all possible versions for installation
--version Show version information
-?, -h, --help Show help and usage information

Additional Arguments:
Arguments passed to the application that is being run.
```

-----

#### Examples
Using powershell.

```powershell title="Basic installation in the folder you are in"
.\Exiled.Installer-Win --pre-releases
```

```powershell title="Installation in a specific folder, specific version and specific appdata folder"
.\Exiled.Installer-Win -p D:\Games\SCPSL\Server --appdata C --target-version 2.0.8
```
23 changes: 23 additions & 0 deletions docs/docs/Installation/Intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 1
---

# Install automatically EXILED

## Automatic Installation

Exiled has a tool that allows you to install **automatically** the framework for you.

## Guides

- [Window Automatic Installation](/docs/Installation/Automatic/Windows).
- [Linux Automatic Installation](/docs/Installation/Automatic/Linux).

## Manual Installation

The old way.

## Guides

- [Window Installation](/docs/Installation/Manual/Windows%20or%20Linux).
- [Linux Installation](/docs/Installation/Manual/Windows%20or%20Linux).
26 changes: 26 additions & 0 deletions docs/docs/Installation/Manual/Windows or Linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
sidebar_position: 1
---

# Manual Installation

You can download exiled manually following this steps:

### Pick a release

You can select a release inside [our official GitHub repo](https://github.com/Exiled-Team/EXILED/releases/).

![Exiled Release](/img/docs/Release.png)

### Download the release

Download the `Exiled.tar.gz` file and extract it with your favourite tool, we recommend [7Zip](https://www.7-zip.org/) or [WinRar](https://www.win-rar.com/download.html?&L=6).

### Installation

1. Move the file **``Assembly-CSharp.dll``** to: **`(Your Server Folder)/SCPSL_Data/Managed`** and replace the file.
2. Move the **``EXILED``** folder to **`%appdata%`**

#### Note:
- Windows: This **`%appdata%`** folder is the one located inside **`AppData/Roaming`**, not just `AppData`.
- Linux: This **`%appdata%`** folder is the one called **`~/.config`**.
4 changes: 4 additions & 0 deletions docs/docs/Installation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Installation",
"position": 2
}
Loading