Duplicate from readme

Chase Hall 2020-08-06 08:11:17 -05:00
parent 17dea2a42e
commit 844c6bf76c

46
Quick-Start-Guide.md Normal file

@ -0,0 +1,46 @@
# IW4MAdmin
### Quick Start Guide
### Version 2.4
_______
### About
**IW4MAdmin** is an administration tool for [IW4x](https://iw4xcachep26muba.onion.link/), [Pluto T6](https://forum.plutonium.pw/category/6/plutonium-t6), [Pluto IW5](https://forum.plutonium.pw/category/14/plutonium-iw5), [CoD4x](https://cod4x.me/), [TeknoMW3](https://www.teknomw3.pw/), 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 server(s). With plugin support, extending its functionality is a breeze.
### Download
Latest binary builds are always available at:
- [GitHub](https://github.com/RaidMax/IW4M-Admin/releases)
- [RaidMax](https://raidmax.org/IW4MAdmin)
---
### Setup
**IW4MAdmin** requires minimal effort to get up and running.
#### Prerequisites
* [.NET Core 3.1.x Runtime](https://www.microsoft.com/net/download) *or newer*
* [Direct Download (Windows)](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-aspnetcore-3.1.4-windows-hosting-bundle-installer)
* [Package Installation (Linux)](https://docs.microsoft.com/en-us/dotnet/core/install/linux-package-manager-ubuntu-1910)
#### Installation
1. Install .NET Core Runtime
2. Extract `IW4MAdmin-<version>.zip`
#### Launching
Windows
1. Run `StartIW4MAdmin.cmd`
2. Configure **IW4MAdmin**
Linux
1. Execute `chmod +x StartIW4MAdmin.sh`
2. Run `./StartIW4MAdmin.sh`
3. Configure **IW4MAdmin**
### 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://<machine_ip_here>:1624 and clicking on the key icon
* You will need to retrieve your login credentials by typing `!rt` ingame
### Updating
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_
---
### Help
Feel free to join the **IW4MAdmin** [Discord](https://discord.gg/ZZFK5p3)
If you come across an issue, bug, or feature request please post an [issue](https://github.com/RaidMax/IW4M-Admin/issues)