Fixes readmes and adds some convenience scripts (#107)

This commit is contained in:
Kamron Batman 2020-04-13 01:54:37 -07:00 committed by GitHub
parent ec829316c9
commit e4037d2541
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 120 additions and 37 deletions

View file

@ -3,55 +3,50 @@ ModernUO
Ultima Online Server Emulator for the modern era!
### Join and Follow!
[Discord Channel](https://discord.gg/VdyCpjQ)
[Twitter](https://www.twitter.com/modernuo)
[Reddit](https://www.reddit.com/r/modernuo)
## Join and Follow!
- [Discord Channel](https://discord.gg/VdyCpjQ)
- [Twitter](https://www.twitter.com/modernuo)
- [Reddit](https://www.reddit.com/r/modernuo)
### Goals
## Goals
- See [Goals](./GOALS.md)
# Requirements to Compile
## Publishing a build
#### Requirements
- [.NET Core 3.1 SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1)
### Requirements to Run
#### Cleaning
- Linux or OSX: `./clean.sh`
- Windows: `clean.cmd`
#### Linux
- `apt get zlib libuv` or equiv for that distribution
- Optional: compile and install [Intel DRNG](https://github.com/modernuo/libdrng)
#### OSX
- `brew install zlib libuv`
- Optional: compile and install [Intel DRNG](https://github.com/modernuo/libdrng)
#### Publishing
- Linux: `./publish-linux.sh` or `publish-linux.cmd`
- OSX: `./publish-osx.sh` or `publish-osx.cmd`
- Windows `./publish-windows.sh` or `publish-windows.cmd`
### Building with .NET Core SDK
`dotnet publish /p:PublishProfile=[platform][-SelfContained]`
- `platform` can be `Windows`, `Linux`, or `OSX` (capitalization matters)
- Appending `-SelfContained` will export all .NET Core files required to run portably.
### Running
## Deploying / Running Server
- Follow the build instructions
- Go to `Distribution` directory
- Copy `Distribution` directory to production server
##### Windows
#### Requirements
- [.NET Core 3.1 Runtime](https://dotnet.microsoft.com/download/dotnet-core/3.1)
- Zlib
- Linux: `apt get zlib` or equiv for that distribution
- OSX: `brew install zlib`
- Windows is included during publishing
- Optional: compile and install [Intel DRNG](https://github.com/modernuo/libdrng)
#### Windows
- Run `ModernUO.exe` or `dotnet ModernUO.dll`
##### OSX or Linux
#### OSX and Linux
- Run `./ModernUO` or `dotnet ./ModernUO.dll`
### Thanks
## Thanks
- RunUO Team & Community
- ServUO Team & Community
- [Jaedan](https://github.com/jaedan) and the ClassicUO Community
### Troubleshooting / FAQ
##### Where do I go to run ModernUO?
Everything is run from the `Distribution` directory.
This folder is portable, so it can be moved to the production server for deployments.
##### My scripts folder is not compiling during runtime, what happened?
NET Core does not support dynamic compiling. Scripts are now compiled separately and moved to the `Distribution/Assemblies` directory.
This also allows us to divide content into packages that can be included by dropping in the DLL.
##### Why can't I run ModernUO on a 32-bit operating system?
ModernUO is optimized for performance and modern hardware.
## Troubleshooting / FAQ
- See [FAQ](./FAQ.md)