From 398939964e255687b8007f05e27f55e257740350 Mon Sep 17 00:00:00 2001 From: RaidMax Date: Sun, 11 Jun 2023 18:10:18 -0500 Subject: [PATCH] aaa --- Getting-Started.md | 42 +++++++++++++++++++++++++++--------------- Home.md | 16 ++++++++++------ 2 files changed, 37 insertions(+), 21 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index ad56806..b24933f 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -1,19 +1,26 @@ ## Download -Latest binary builds are always available at: -- [GitHub](https://github.com/RaidMax/IW4M-Admin/releases) -- [RaidMax](https://raidmax.org/IW4MAdmin) +Grab the latest builds from [GitHub Releases](https://github.com/RaidMax/IW4M-Admin/releases). + +|:information_source: **See [Versions](https://github.com/RaidMax/IW4M-Admin/wiki#versions) to determine the right release cadence for you** | +|-| ## Setup **IW4MAdmin** requires minimal effort to get up and running. -See the [FAQ](https://github.com/RaidMax/IW4M-Admin/wiki/FAQ) for walkthrough videos . +See the [FAQ](https://github.com/RaidMax/IW4M-Admin/wiki/FAQ) for walkthrough videos and [Knowledge Base](https://github.com/RaidMax/IW4M-Admin/wiki/Knowledge-Base) for additional information. ## Prerequisites -* [.NET Core 6.0.x Runtime](https://www.microsoft.com/net/download) - * [Direct Download (Windows)](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-6.0.1-windows-hosting-bundle-installer) - * [Package Installation Instructions (Linux)](https://docs.microsoft.com/en-us/dotnet/core/install/linux) +**ASP.NET Core Runtime 6.0.x** + +|| +|-| +| [Direct Download (Windows)](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-6.0.16-windows-hosting-bundle-installer) | +| [Package Installation Instructions (Linux)](https://docs.microsoft.com/en-us/dotnet/core/install/linux) | + +|:information_source: Hosting bundle is required for Windows installs | +|-| ## Installing -1. Install .NET Core Runtime +1. Install ASP.NET Core Runtime 2. Extract `IW4MAdmin-.zip` ## Launching @@ -29,16 +36,21 @@ Linux **If you run into an issue or error, take a look at the [FAQ](https://github.com/RaidMax/IW4M-Admin/wiki/FAQ) for common issues and the [Knowledge Base](https://github.com/RaidMax/IW4M-Admin/wiki/Knowledge-Base) for extra insights.** ## First Steps -1. Go ingame and type via the **ingame chat** `!owner` to claim ownership (full admin permissions) of the server -2. Login to the webfront by accessing http://:1624 and clicking on the key icon - * You will need to retrieve your login credentials by typing `!rt` ingame +Go ingame and type via the **ingame chat** `!owner` to claim ownership (full admin permissions) of the server. +Login to the webfront by accessing http://:1624 and clicking on the key icon. +Use the webconsole to set a permanent password. -### Updating +|:information_source: You will need to retrieve your initial login credentials by typing `!rt` **ingame** | +|-| + + +## Updating **Manually** 1. Download the latest version of **IW4MAdmin** 2. Extract the newer version of **IW4MAdmin** into pre-existing **IW4MAdmin** folder and overwrite existing files - _Your configuration and database will be saved_ +|:information_source: **Your configuration and database will be saved** | +|-| **OR** Use the provided `UpdateIW4MAdmin` script to download and install automatically @@ -51,6 +63,6 @@ Use the provided `UpdateIW4MAdmin` script to download and install automatically | -Directory (d) | Directory to install to | ## Help -Feel free to join the **IW4MAdmin** [Discord](https://discord.gg/ZZFK5p3) +Feel free to join the **IW4MAdmin** [Discord](https://discord.gg/ZZFK5p3). Take a look at the [FAQ](https://github.com/RaidMax/IW4M-Admin/wiki/FAQ) for common issues and the [Knowledge Base](https://github.com/RaidMax/IW4M-Admin/wiki/Knowledge-Base) for extra insights. -If you come across an issue, bug, or feature request please post an [issue](https://github.com/RaidMax/IW4M-Admin/issues) +If you come across an issue, bug, or feature request please post an [issue](https://github.com/RaidMax/IW4M-Admin/issues). diff --git a/Home.md b/Home.md index 12ce221..1723f23 100644 --- a/Home.md +++ b/Home.md @@ -1,19 +1,23 @@ +# Overview **IW4MAdmin** is an administration tool for [IW4x](#), [IW6x](#), [Plutonium T6](https://forum.plutonium.pw/category/6/plutonium-t6), [Plutonium IW5](https://forum.plutonium.pw/category/14/plutonium-iw5), [Plutonium T5](https://forum.plutonium.pw/category/51/plutonium-t5), [Plutonium T4](https://forum.plutonium.pw/category/36/plutonium-t4), [CoD4x](https://cod4x.me), [H1-Mod](https://h1.gg/), [TeknoMW3](https://github.com/Musta1337/TeknoMW3), and most Call of Duty® dedicated servers. It allows complete control of your server; from changing maps, to banning players, **IW4MAdmin** monitors and records activity on your game server(s). Also included is a fully featured and mobile friendly web interface that allows you to watch over and administrate your game servers even on the go. With plugin support, you can extend **IW4MAdmins** functionality to fit all your needs. -#### If you are new to IW4MAdmin, check out the [Getting Started](https://github.com/RaidMax/IW4M-Admin/wiki/Getting-Started) page. +#### If you are new to IW4MAdmin, check out the [Getting Started](https://github.com/RaidMax/IW4M-Admin/wiki/Getting-Started) and [Features](https://github.com/RaidMax/IW4M-Admin/wiki/Features) page. *** -### Versions -#### Verified -This version type is released at a slower pace and includes features after they have been adopted and tested for some time. +# Versions -#### Prerelease (recommended) -This version type is released as new feature requests and bug-fixes are pushed. +## Prerelease (recommended) +This version type is released as new features are requested and bug-fixes are pushed. Both versions are tested before release, but the `prerelease` version has a higher chance of small unintentional bugs while implementing new features. +## Verified +This version type is released at a slower pace and includes features after they have been adopted and tested for some time. +|⚠️ **There may be a significant time interval between _verified_ releases** | +|-| + _Unless otherwise specified all documentation is valid for the pre-release version of **IW4MAdmin**. As such, you may find documentation for features that are not yet available in the latest `verified` version_ \ No newline at end of file