warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Updates installation docs for the main site. (#911)

Browse source
This commit is contained in:
Kamron Batman 2022-01-03 19:05:28 -08:00 • committed by GitHub
parent 4fd8b4d307
commit 573ddfa27b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 30 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -19,16 +19,17 @@ ModernUO [![Discord](https://img.shields.io/discord/751317910504603701?logo=disc
![MacOS 10.15/11/12](https://img.shields.io/badge/-monterey-222222?logo=apple&logoColor=white) ![MacOS 10.15/11/12](https://img.shields.io/badge/-monterey-222222?logo=apple&logoColor=white)
[![Debian 10/11](https://img.shields.io/badge/-bullseye-A81D33?logo=debian)](https://www.debian.org/distrib/) [![Debian 10/11](https://img.shields.io/badge/-bullseye-A81D33?logo=debian)](https://www.debian.org/distrib/)
[![Ubuntu 16/18/20 LTS](https://img.shields.io/badge/-20LTS-E95420?logo=ubuntu&logoColor=white)](https://ubuntu.com/download/server) [![Ubuntu 16/18/20 LTS](https://img.shields.io/badge/-20LTS-E95420?logo=ubuntu&logoColor=white)](https://ubuntu.com/download/server)
[![Linux Mint 17/18/19/20](https://img.shields.io/badge/-20-87CF3E?logo=linux%20mint&logoColor=white)](https://linuxmint.com/download.php)
[![CentOS 7/8](https://img.shields.io/badge/-8.5-262577?logo=centos&logoColor=white)](https://www.centos.org/download/) [![CentOS 7/8](https://img.shields.io/badge/-8.5-262577?logo=centos&logoColor=white)](https://www.centos.org/download/)
[![Fedora 32/33/34](https://img.shields.io/badge/-fedora%2034-0B57A4)](https://getfedora.org/en/server/download/) [![Fedora 32/33/34](https://img.shields.io/badge/-fedora%2034-0B57A4)](https://getfedora.org/en/server/download/)
[![RedHat 7/8](https://img.shields.io/badge/-8-BE0000?logo=red%20hat&logoColor=white)](https://access.redhat.com/downloads) [![RedHat 7/8](https://img.shields.io/badge/-8-BE0000?logo=red%20hat&logoColor=white)](https://access.redhat.com/downloads)
#### Running the server #### Running the server
[![.NET](https://img.shields.io/badge/.NET-%206.0-5C2D91)](https://dotnet.microsoft.com/download/dotnet/6.0) [![.NET](https://img.shields.io/badge/-6.0-5C2D91?logo=.NET)](https://dotnet.microsoft.com/download/dotnet/6.0)
#### Development #### Development
[![git](https://img.shields.io/badge/-git-F05032?logo=git&logoColor=white)](https://git-scm.com/downloads) [![git](https://img.shields.io/badge/-git-F05032?logo=git&logoColor=white)](https://git-scm.com/downloads)
[![.NET](https://img.shields.io/badge/.NET-%206.0%20SDK-5C2D91)](https://dotnet.microsoft.com/download/dotnet/6.0) [![.NET](https://img.shields.io/badge/-%206.0%20SDK-5C2D91?logo=.NET)](https://dotnet.microsoft.com/download/dotnet/6.0)
#### Supported IDEs #### Supported IDEs
       
@ -51,11 +52,12 @@ Rider 2021.3+           &
- `win` - Windows 10/11/2016/2019/2022 - `win` - Windows 10/11/2016/2019/2022
- `osx` - MacOS 10.15/11.0+/12.0+ (Catalina, Big Sur, Monterey) - `osx` - MacOS 10.15/11.0+/12.0+ (Catalina, Big Sur, Monterey)
- `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04` - Ubuntu LTS - `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04` - Ubuntu LTS
- `linuxmint.17`, `linuxmint.18`, `linuxmint.19` - Linux Mint
- `debian.10`, `debian.11` - Debian - `debian.10`, `debian.11` - Debian
- `centos.7`, `centos.8` - CentOS - `centos.7`, `centos.8` - CentOS
- `fedora.32`, `fedora.33`, `fedora.34` - Fedora - `fedora.32`, `fedora.33`, `fedora.34` - Fedora
- `rhel.7`, `rhel.8` - Redhat - `rhel.7`, `rhel.8` - Redhat
- If blank, the operating system running the build is used - If blank, the operating system running the build is used. Linux Mint 20 is not supported directly yet, so build explicitly against `ubuntu.20.04` instead.
**Note:** Building in Visual Studio (or Rider) will not run the schema migration. The schema migration ensures future changes **Note:** Building in Visual Studio (or Rider) will not run the schema migration. The schema migration ensures future changes
to the code will be backward compatible. to the code will be backward compatible.
@ -64,6 +66,9 @@ to the code will be backward compatible.
- Follow the [publish](https://github.com/modernuo/ModernUO#publishing-builds) instructions - Follow the [publish](https://github.com/modernuo/ModernUO#publishing-builds) instructions
- Run `ModernUO.exe` or `dotnet ModernUO.dll` from the `Distribution` directory on the server - Run `ModernUO.exe` or `dotnet ModernUO.dll` from the `Distribution` directory on the server
**Note:** If you are running a version of linux that isn't listed above, then you may have to install the following using a package manager:
* `libargon2-dev`, `libz-dev`, and `zstd`
## Thanks ## Thanks
- RunUO Team & Community - RunUO Team & Community
- ServUO Team & Community - ServUO Team & Community

4
docs/assets/stylesheets/extra.css
View file

@ -82,6 +82,10 @@ html .md-footer-meta.md-typeset a:hover {
color: #e95420; color: #e95420;
} }
.linuxmint {
color: #87CF3E;
}
.debian { .debian {
color: #d70a53; color: #d70a53;
} }

4
docs/building-server.md
View file

@ -23,6 +23,8 @@ The operating system to build the server against. If not specified then the serv
:fontawesome-brands-windows:{: .windows } `win`<br> :fontawesome-brands-windows:{: .windows } `win`<br>
:fontawesome-brands-apple:{: .apple } `osx`<br> :fontawesome-brands-apple:{: .apple } `osx`<br>
:fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`<br> :fontawesome-brands-ubuntu:{: .ubuntu } `ubuntu.14.04` `ubuntu.16.04`, `ubuntu.18.04` `ubuntu.20.04`<br>
:brands-linuxmint:{: .linuxmint } `linuxmint.17` `linuxmint.18`, `linuxmint.19`<br>
:brands-debian:{: .debian } `debian.9`, `debian.10`<br> :brands-debian:{: .debian } `debian.9`, `debian.10`<br>
:fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8` :fontawesome-brands-centos:{: .centos } `centos.7`, `centos.8`
:fontawesome-brands-redhat:{: .redhat } `redhat.7`, `redhat.8`

6
docs/installation.md
View file

@ -6,7 +6,7 @@ title: Installation
=== "Windows" === "Windows"
### Prerequisites ### Prerequisites
1. Download and install the latest [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0)
1. Download and install from [here](https://git-scm.com/download/win) 1. Download and install from [here](https://git-scm.com/download/win)
!!! Tip !!! Tip
@ -22,7 +22,7 @@ title: Installation
=== "OSX" === "OSX"
<h3>Prerequisites</h3> <h3>Prerequisites</h3>
1. Download and install the latest [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) 1. Download and install the latest [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0)
1. Using _terminal_, install [homebrew](https://brew.sh) and git: 1. Using _terminal_, install [homebrew](https://brew.sh) and git:
```bash ```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
@ -37,7 +37,7 @@ title: Installation
=== "Linux" === "Linux"
<h3>Prerequisites</h3> <h3>Prerequisites</h3>
1. Download and install the latest [.NET Core SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) 1. Download and install the latest [.NET 6 SDK](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux))
1. Using _bash_, install git: 1. Using _bash_, install git:
```bash ```bash
sudo apt update && sudo apt install git sudo apt update && sudo apt install git

1
docs/overrides/.icons/brands/linuxmint.svg Normal file
View file

@ -0,0 +1 @@
<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Linux Mint</title><path d="M0 1.693v4.193h1.828c1.276 0 1.502.865 1.502 2.058l.01 7.412c0 3.84 3.44 6.951 7.68 6.951h10.464c1.342 0 2.516-.83 2.516-2.108V8.706c0-3.84-3.44-6.95-7.683-6.95h-4.405v-.013L0 1.693zm5.723 2.566h2.102V14.82c0 1.413.984 2.51 2.139 2.51l7.17.03c1.496 0 2.661-1.01 2.661-2.206l-.012-5.607a1.2 1.2 0 0 0-.386-.91 1.224 1.224 0 0 0-.917-.384c-.374 0-.65.12-.918.384a1.2 1.2 0 0 0-.386.91v4.798h-2.223V9.548c0-.364-.124-.648-.389-.91a1.208 1.208 0 0 0-.917-.384c-.366 0-.647.12-.914.384-.265.262-.39.546-.39.91v4.798H10.12V9.548c0-.95.36-1.792 1.042-2.466a3.445 3.445 0 0 1 2.485-1.022c.937 0 1.752.345 2.413.97a3.448 3.448 0 0 1 2.42-.97c.954 0 1.803.348 2.485 1.022a3.385 3.385 0 0 1 1.041 2.466l.009 5.991c-.105 1.004-.539 1.894-1.28 2.637h-.002a4.367 4.367 0 0 1-3.174 1.314H9.574v-.038c-.976-.103-1.846-.519-2.57-1.217-.845-.825-1.281-1.846-1.281-3.01V4.26z"/></svg>
Side by side

After

Width:  |  Height:  |  Size: 970 B

17
docs/quick-start.md
View file

@ -7,20 +7,25 @@ title: Quick Start
If you are familiar with RunUO, then follow these steps to get your ModernUO server running in less than 10 minutes: If you are familiar with RunUO, then follow these steps to get your ModernUO server running in less than 10 minutes:
=== "Windows" === "Windows"
1. Download and install the [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/5.0) 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0)
1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
1. Run publish.cmd
1. Navigate to the _Distribution_ folder. 1. Navigate to the _Distribution_ folder.
1. Run `ModernUO.exe` 1. Run `ModernUO.exe`
=== "OSX" === "OSX"
1. Download and install the [.NET 5 Runtime](https://dotnet.microsoft.com/download/dotnet/5.0) 1. Download and install the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0)
1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
1. Using _terminal_, navigate to the _ModernUO_ folder.
1. Run `./publish.cmd`
1. Using _terminal_, navigate to the _Distribution_ folder. 1. Using _terminal_, navigate to the _Distribution_ folder.
1. Run `dotnet ModernUO.dll` 1. Run `dotnet ModernUO.dll`
=== "Linux" === "Linux"
1. Download and install the [.NET 5 Runtime](instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/linux)) 1. Download and install the [.NET 6 Runtime](https://docs.microsoft.com/en-us/dotnet/core/install/linux)
1. Download and extract [ModernUO](https://github.com/modernuo/ModernUO/releases/latest) to a folder. 1. Using [git](https://git-scm.com/downloads), clone the ModernUO repository to a folder.
1. Using _bash_, navigate to the _ModernUO_ folder.
1. Run `./publish.cmd`
1. Using _bash_, navigate to the _Distribution_ folder. 1. Using _bash_, navigate to the _Distribution_ folder.
1. Run `dotnet ModernUO.dll` 1. Run `dotnet ModernUO.dll`