diff --git a/_config.yml b/_config.yml index 5b9984b..f7cd45b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,4 @@ +favicon_ico: "https://cedmod.nl/favicon.ico" title: CedMod Documentation description: Documentation for Installation and Usage of CedMod theme: just-the-docs @@ -6,10 +7,36 @@ color_scheme: dark url: https://docs.cedmod.nl baseurl: / +aux_links: + "CedMod on GitHub": + - "https://github.com/CedModV2" + +nav_external_links: + - title: CedMod on GitHub + url: https://github.com/CedModV2 + - title: CedMod Panel + url: https://cedmod.nl/ + - title: Changelog + url: https://demo.cedmod.nl/Changelog + callouts: warning: title: Warning color: red note: title: Note - color: purple \ No newline at end of file + color: blue + attention: + title: Attention + color: yellow + +footer_content: "CedMod All Rights Reserved. CedMod is owned by ced777ric - Repository" + +last_edit_timestamp: true +last_edit_time_format: "%b %e %Y at %I:%M %p" + +gh_edit_link: true +gh_edit_link_text: "Contribute to this page." +gh_edit_repository: "https://github.com/CedModV2/docs" +gh_edit_branch: "main" +gh_edit_view_mode: "tree" \ No newline at end of file diff --git a/docs/Setup/Installation/exiled.md b/docs/Setup/Installation/exiled.md index f5c1c23..adf77fd 100644 --- a/docs/Setup/Installation/exiled.md +++ b/docs/Setup/Installation/exiled.md @@ -5,6 +5,50 @@ grand_parent: Setup layout: default --- -## Installation for Exiled +# Installation for Exiled -For the installation with exiled first download the latest cedmod release. \ No newline at end of file +{: .warning } +CedMod does currently not support the Exiled Reboot 9.0.0 beta. + +[Exiled](https://github.com/ExMod-Team/EXILED){: .btn .btn-purple .mr-2 } +[Exiled Reboot](https://github.com/Exiled-Team/EXILED){: .btn .btn-purple .mr-2 } + +## How to install Exiled + +Download the latest compatible release of either **Exiled** or **Exiled Reboot**. +It is not relevant +which of them you use but due note that they have to completely different development teams +and are aiming for different goals. + +On a guide on how to install Exiled/Exiled Reboot on their official docs. +For Exiled go [here](https://github.com/ExMod-Team/EXILED/blob/master/.github/documentation/README.md#installation), +for Exiled Reboot look [here](https://github.com/Exiled-Team/EXILED?tab=readme-ov-file#installation). +The guides are practically identical but could change in the future when development of the two changes more and more. + +## Getting the CedMod release + +After installing exiled, you need to download the CedMod release compatible with it. +All releases will have a section that marks the compatibility with the exiled and game version. + +{: .attention } +Make sure the CedMod release you are downloading has **EXILED** and not **NWAPI** in its title as only the exiled versions are meant for exiled installation + +1. Go to the [cedmod releases tab](https://github.com/CedModV2/CedMod/releases) and download your desired version +2. Drag and drop it into your plugins folder +3. Reboot your server + +Your CedMod installation is done. + +## After the Installation + +After you install CedMod and restart your server, a message will be displayed in your console: +``` +CedMod requires additional Setup, the plugin will not function and some features will not work if the plugin is not setup. +Please follow the setup guide on https://cedmod.nl/Servers/Create +``` + +Go to the page [displayed in the message](https://cedmod.nl/Servers/Create), +and then follow the [instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/create.html) + +{: .note } +If you already have a CedMod instance, then go to the queryserver page in your panel and create a new queryserver or copy the setup command of an existing one diff --git a/docs/Setup/Installation/index.md b/docs/Setup/Installation/index.md index ff6b7ad..c75547e 100644 --- a/docs/Setup/Installation/index.md +++ b/docs/Setup/Installation/index.md @@ -5,4 +5,8 @@ layout: default has_children: true --- -Instance \ No newline at end of file +# Installation +{: .fs-9 } + +Installation guides to install exiled for NWAPI or Exiled/Exiled Reboot +{: .fs-6 .fw-300 } \ No newline at end of file diff --git a/docs/Setup/Installation/nwapi.md b/docs/Setup/Installation/nwapi.md index 32a205b..3018116 100644 --- a/docs/Setup/Installation/nwapi.md +++ b/docs/Setup/Installation/nwapi.md @@ -5,4 +5,32 @@ grand_parent: Setup layout: default --- -Installation for NWApi +# Installation for NWAPI + +NWAPI is the preinstalled plugins api for SCP: Secret Laboratory servers and does not need any extra installation + +## Getting the CedMod release + +{: .note } +Installation with nwapi requires the [NWAPIPermissionSystem](https://github.com/CedModV2/NWAPIPermissionSystem) to function properly + +{: .attention } +Make sure the CedMod release you are downloading has **NWAPI** and not **EXILED** in its title as only the exiled versions are meant for exiled installation + +1. Go to the [cedmod releases tab](https://github.com/CedModV2/CedMod/releases) and download your desired version +2. Drag and drop it into your plugins folder +3. Reboot your server + +## After the Installation + +After you install CedMod and restart your server, a message will be displayed in your console: +``` +CedMod requires additional Setup, the plugin will not function and some features will not work if the plugin is not setup. +Please follow the setup guide on https://cedmod.nl/Servers/Create +``` + +Go to the page [displayed in the message](https://cedmod.nl/Servers/Create), +and then follow the [instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/create.html) + +{: .note } +If you already have a CedMod instance, then go to the queryserver page in your panel and create a new queryserver or copy the setup command of an existing one diff --git a/docs/Setup/Instance/index.md b/docs/Setup/Instance/index.md index 7094f71..dbfc02a 100644 --- a/docs/Setup/Instance/index.md +++ b/docs/Setup/Instance/index.md @@ -5,4 +5,4 @@ layout: default has_children: true --- -Installation +Instance diff --git a/docs/Setup/index.md b/docs/Setup/index.md index a7fd5b6..370a98a 100644 --- a/docs/Setup/index.md +++ b/docs/Setup/index.md @@ -5,4 +5,10 @@ nav_order: 2 has_children: true --- -Setup +# Setup +{: .fs-9 } + +Cedmod requires additional setup to work. +These guides explain how to set up an instance, +configure it and a bit of its usage. +{: .fs-6 .fw-300 } diff --git a/index.md b/index.md index 770eca3..28409e1 100644 --- a/index.md +++ b/index.md @@ -15,7 +15,7 @@ Aimed towards assisting in server moderation by providing a web based ban manage This documentation is currently not complete and is still WIP [Get started](#getting-started){: .btn .mr-2 } -[Visit the website](https://docs.cedmod.nl/docs/Setup/){: .btn .mr-2 } +[Visit the website](https://cedmod.nl){: .btn .mr-2 } [Join our Discord](https://discord.com/invite/p69SGfwxxm){: .btn .mr-2 } [GitHub](https://github.com/CedModV2/CedMod){: .btn .mr-2 }