Skip to content

Commit

Permalink
Merge pull request #11 from Vxrpenter/main
Browse files Browse the repository at this point in the history
Fixes and additions
  • Loading branch information
ced777ric authored Dec 8, 2024
2 parents 78642a5 + 1e38b20 commit 7deec4f
Show file tree
Hide file tree
Showing 11 changed files with 53 additions and 22 deletions.
5 changes: 4 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
favicon_ico: "https://cedmod.nl/favicon.ico"
logo: "/assets/images/logo.png"
title: CedMod Documentation
description: Documentation for Installation and Usage of CedMod
theme: just-the-docs
Expand All @@ -7,10 +7,13 @@ color_scheme: dark
url: https://docs.cedmod.nl
baseurl: /

aux_links_new_tab: true
aux_links:
"CedMod on GitHub":
- "https://github.com/CedModV2"

heading_anchors: true

nav_external_links:
- title: CedMod on GitHub
url: https://github.com/CedModV2
Expand Down
Binary file added assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions docs/Setup/Installation/index.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,32 @@ layout: default
# Installation for Exiled

{: .warning }
CedMod does currently not support Exiled Reboot 9.0.0 beta.
CedMod does currently not support the Exiled Reboot 9.0.0 beta.

[Exiled](https://github.com/ExMod-Team/EXILED){: .btn .mr-2 }
[Exiled Reboot](https://github.com/Exiled-Team/EXILED){: .btn .mr-2 }
{: .no_toc }

---

## Table of Contents
{: .no_toc .text-delta }

1. TOC
{:toc}

## 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
which of them you use but due note that they have two completely different development teams
and are aiming for different goals.

On a guide on how to install Exiled/Exiled Reboot on their official docs.
If you want a guide on how to install Exiled/Exiled Reboot,
you can find them 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.
The guides are practically identical, but could change in the future when development of the two changes more and more.

## Getting the CedMod release

Expand Down
19 changes: 19 additions & 0 deletions docs/setup/installation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Installation
parent: Setup
layout: default
has_children: true
---

# Installation
{: .fs-9 }

Installation guides to install exiled for NWAPI or Exiled/Exiled Reboot
{: .fs-6 .fw-300 }

## What to choose?

The basic difference between **Exiled** and **NWAPI** is
that Exiled has an integrated permission system while NWAPI doesn't.
Meaning if you use Exiled for your permissions and everything you should stick with the CedMod versions for exiled.
If you already use NWAPIPermissionSystem you may want to consider using the NWAPI version of CedMod
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,16 @@ layout: default

# Installation for NWAPI

NWAPI is the preinstalled plugins api for SCP: Secret Laboratory servers and does not need any extra installation
NWAPI is the preinstalled plugin api for SCP: Secret Laboratory servers and does not need any extra installation
{: .no_toc }

---

## Table of Contents
{: .no_toc .text-delta }

1. TOC
{:toc}

## Getting the CedMod release

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 6 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ This documentation is currently not complete and is still WIP
[Join our Discord](https://discord.com/invite/p69SGfwxxm){: .btn .mr-2 }
[GitHub](https://github.com/CedModV2/CedMod){: .btn .mr-2 }

---

With CedMod you are able to moderate your server more easily than ever before.
Use the webpanel for managing bans, mutes, permissions and your staff permissions.
Use the webpanel for managing bans, mutes, and permissions.
CedMod is used by over **400** Servers worldwide and stores over **300.000** BanLogs and almost **100.000** Warnings.

## Getting Started
Expand All @@ -36,7 +38,7 @@ If you want to view a more complete installation guide,
go to [the instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/)

## About CedMod
CedMod All Rights Reserved by [ced777ric](https://github.com/ced777ric)
CedMod, All Rights Reserved by [ced777ric](https://github.com/ced777ric)

### Licence Agreements

Expand All @@ -50,8 +52,8 @@ You are free to contribute to CedMod development if you'd like.
Fork the [repository](https://github.com/CedModV2/CedMod),
commit your changes to the fork and then create a pull request to propose the changes to the maintainers.

{: .warning }
{: .attention }
When proposing changes, make sure they are well tested and don't break any other features. CedMod is used by many servers and has to be stable for optimal usage. Also make sure to explain exactly what you changed in the pull request.

{: .note }
The backend of CedMod is closed source and will remain that way. If you'd like to contribute to the development of the backend, you can apply for a staff position using the [application form](https://docs.google.com/forms/d/1JJKZOXOv6_ew8bExxGvLvaSBzdgCNlYteGnWNOMQPXU/edit). The CedMod team reviews your application and then decides if it is valid or not. You need to answer the questions truthfully for the best chances, lying won't bring you far
The backend of CedMod is closed source and will remain that way. If you'd like to contribute to the development of the backend, you can apply for a staff position with the [application form](https://docs.google.com/forms/d/1JJKZOXOv6_ew8bExxGvLvaSBzdgCNlYteGnWNOMQPXU/edit). The CedMod team reviews your application and then decides if it is valid or not. You need to answer the questions truthfully for the best chances, lying won't bring you far

0 comments on commit 7deec4f

Please sign in to comment.