Updated Getting Started (markdown)
parent
dfc93057f6
commit
95493cab55
@ -1,21 +1,22 @@
|
|||||||
### Download
|
## Download
|
||||||
Latest binary builds are always available at:
|
Latest binary builds are always available at:
|
||||||
- [GitHub](https://github.com/RaidMax/IW4M-Admin/releases)
|
- [GitHub](https://github.com/RaidMax/IW4M-Admin/releases)
|
||||||
- [RaidMax](https://raidmax.org/IW4MAdmin)
|
- [RaidMax](https://raidmax.org/IW4MAdmin)
|
||||||
|
|
||||||
---
|
## Setup
|
||||||
### Setup
|
|
||||||
**IW4MAdmin** requires minimal effort to get up and running.
|
**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 .
|
||||||
|
|
||||||
#### Prerequisites
|
## Prerequisites
|
||||||
* [.NET Core 3.1.x Runtime](https://www.microsoft.com/net/download) *or newer*
|
* [.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.6-windows-hosting-bundle-installer)
|
* [Direct Download (Windows)](https://dotnet.microsoft.com/download/dotnet-core/thank-you/runtime-aspnetcore-3.1.6-windows-hosting-bundle-installer)
|
||||||
* [Package Installation (Linux)](https://docs.microsoft.com/en-us/dotnet/core/install/linux-package-manager-ubuntu-1910)
|
* [Package Installation (Linux)](https://docs.microsoft.com/en-us/dotnet/core/install/linux-package-manager-ubuntu-1910)
|
||||||
#### Installation
|
|
||||||
|
## Installation
|
||||||
1. Install .NET Core Runtime
|
1. Install .NET Core Runtime
|
||||||
2. Extract `IW4MAdmin-<version>.zip`
|
2. Extract `IW4MAdmin-<version>.zip`
|
||||||
#### Launching
|
|
||||||
|
## Launching
|
||||||
Windows
|
Windows
|
||||||
1. Run `StartIW4MAdmin.cmd`
|
1. Run `StartIW4MAdmin.cmd`
|
||||||
2. Configure **IW4MAdmin**
|
2. Configure **IW4MAdmin**
|
||||||
@ -25,18 +26,16 @@ Linux
|
|||||||
2. Run `./StartIW4MAdmin.sh`
|
2. Run `./StartIW4MAdmin.sh`
|
||||||
3. Configure **IW4MAdmin**
|
3. Configure **IW4MAdmin**
|
||||||
|
|
||||||
### First Steps
|
## First Steps
|
||||||
1. Go ingame and type via the **ingame chat** `!owner` to claim ownership (full admin permissions) of the server
|
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
|
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
|
* You will need to retrieve your login credentials by typing `!rt` ingame
|
||||||
|
|
||||||
### Updating
|
## Updating
|
||||||
1. Download the latest version of **IW4MAdmin**
|
1. Download the latest version of **IW4MAdmin**
|
||||||
2. Extract the newer version of **IW4MAdmin** into pre-existing **IW4MAdmin** folder and overwrite existing files
|
2. Extract the newer version of **IW4MAdmin** into pre-existing **IW4MAdmin** folder and overwrite existing files
|
||||||
|
_Your configuration and database will be saved_
|
||||||
|
|
||||||
_Your configuration and database will be saved_
|
## Help
|
||||||
|
|
||||||
---
|
|
||||||
### Help
|
|
||||||
Feel free to join the **IW4MAdmin** [Discord](https://discord.gg/ZZFK5p3)
|
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)
|
If you come across an issue, bug, or feature request please post an [issue](https://github.com/RaidMax/IW4M-Admin/issues)
|
Loading…
x
Reference in New Issue
Block a user