baseline: OpenMU upstream b5a0961 (fresh source)
This commit is contained in:
Acentech Dev
145
QuickStart.md
Normal file
145
QuickStart.md
Normal file
@@ -0,0 +1,145 @@
|
||||
# Quick Start OpenMU
|
||||
|
||||
General requirements:
|
||||
|
||||
* Free TCP ports:
|
||||
* 80 (admin panel)
|
||||
* 55901 - 55906 (game servers)
|
||||
* 44405 - 44406 (connect servers)
|
||||
* 44405: default connection port for the original client
|
||||
* 44406: connection port especially for the [open source client](https://github.com/sven-n/MuMain)
|
||||
* 55980 (chat server)
|
||||
|
||||
* A game client (check [our Discord](https://discord.gg/2u5Agkd) FAQs)
|
||||
* Knowledge or way to start the game client, so that it connects to the server. Our Launcher will do that.
|
||||
|
||||
* Launcher binaries: [MUnique.OpenMU.ClientLauncher v0.9.6.zip](https://github.com/MUnique/OpenMU/releases/download/v0.9.0/MUnique.OpenMU.ClientLauncher_0.9.6.zip)
|
||||
* It requires the [.NET 10 runtime](https://dotnet.microsoft.com/download/dotnet/10.0) or higher
|
||||
* If your server and client runs on your local host, use any IP of 127.x.x.x, except 127.0.0.1, because this one is blocked by the client. For example, you could use 127.127.127.127
|
||||
|
||||
This guide describes two ways of starting the server. Use Docker, if you just
|
||||
want to play around. If you want to develop or debug the server, choose the
|
||||
manual way.
|
||||
|
||||
As you can see on the connect server ports, the server is initialized for two different clients by default.
|
||||
They can connect to the same game servers through different ports. However, if you connect to the wrong port,
|
||||
it may currently still work all correctly, you'll just get warnings in the logs. However, as soon as
|
||||
we change encryption keys or methods, this will change.
|
||||
|
||||
## Docker
|
||||
|
||||
Please take a look at the deploy-folder of this project. There you'll find a more
|
||||
detailed guide about how to set up this project.
|
||||
|
||||
### Environment Variables
|
||||
|
||||
It's possible to define additional environment variables to influence the
|
||||
postgres database connection strings.
|
||||
|
||||
| Name | Description |
|
||||
|------|---------------------|
|
||||
| DB_HOST | The hostname of the database. If the local configuration file is still configured to use 'localhost', the value of this variable replaces it |
|
||||
| DB_ADMIN_USER | The user name of the postgres admin account. If the local configuration file is still configured to use 'postgres' for the user name of the admin (first entry in the ConnectionSettings.xml), the value of this variable replaces it. |
|
||||
| DB_ADMIN_PW | The password of the postgres admin account. If the local configuration file is still configured to use 'admin' for the user password of the admin (first entry in the ConnectionSettings.xml), the value of this variable replaces it. |
|
||||
|
||||
## Manually
|
||||
|
||||
Use this way, if you want to develop or debug for OpenMU.
|
||||
|
||||
Requirements:
|
||||
|
||||
* Windows OS, 10 or higher
|
||||
|
||||
* It runs under Linux and MacOS, too. However, this guide describes it for
|
||||
windows.
|
||||
|
||||
* PostgreSQL installed
|
||||
|
||||
* Visual Studio 2026 installed, with workloads for ASP.NET Web development
|
||||
and .NET Desktop development. Please keep it up-to-date to prevent any issues.
|
||||
|
||||
* Visual Studio Extension "Web Compiler 2022+", if you plan to edit SCSS files
|
||||
for the admin panel.
|
||||
* https://marketplace.visualstudio.com/items?itemName=Failwyn.WebCompiler64
|
||||
|
||||
* [.NET SDK 10](https://dotnet.microsoft.com/download/dotnet/10.0)
|
||||
(it should be included in Visual Studio 2026)
|
||||
* `winget install Microsoft.DotNet.SDK.10`
|
||||
|
||||
* [NodeJS 16+](https://nodejs.org) installed
|
||||
* `winget install OpenJS.NodeJS.LTS`
|
||||
|
||||
* This repository cloned
|
||||
|
||||
If you have that, you'll need to do:
|
||||
|
||||
* Open the solution of OpenMU with Visual Studio
|
||||
|
||||
* Right click the solution and 'Restore NuGet Packages'
|
||||
|
||||
* Edit src\Persistence\EntityFramework\ConnectionSettings.xml, so that the
|
||||
connection strings are correct - however only the user/password of the first
|
||||
and second connection string need to be correct. The server will try to create
|
||||
the other roles specified by the settings.
|
||||
|
||||
* Build the solution
|
||||
|
||||
* Start MUnique.OpenMU.Startup
|
||||
|
||||
* If required, it will create the database schemas, the required roles and
|
||||
gives permissions to this roles.
|
||||
|
||||
* Optional: You can reinitialize the database by adding a ```-reinit``` parameter.
|
||||
|
||||
* When the Admin Panel is initialized, go to <http://localhost/>. Then you
|
||||
should see three gameservers, the chat server and two connect servers. Start
|
||||
the connect servers and at least one gameserver.
|
||||
|
||||
* If you update to a newer state of the master-branch, it could be possible
|
||||
that you have to update the database and configuration.
|
||||
You can find updates in the admin panel.
|
||||
|
||||
* Then you can connect to the server through the game client.
|
||||
|
||||
## Helpful (optional) steps
|
||||
|
||||
* __Auto Start__: If you don't want to start each server listener after starting
|
||||
the process, you can either activate "Auto Start"
|
||||
|
||||
* in the admin panel at ```Configuration -> System```,
|
||||
|
||||
* or with the start parameter ```-autostart```.
|
||||
|
||||
* __IP Resolving__: If you encounter disconnects after selecting a server, it's most
|
||||
likely a wrong setting for the IP resolver. You can change it easily over the
|
||||
admin panel at ```Configuration -> System``` as well.
|
||||
You may also change the setting by providing start parameters or environment
|
||||
parameters, however I just recommend this for experienced users. Look at this
|
||||
[Readme](src/Startup/Readme.md) for more information.
|
||||
|
||||
* __Changing the game version__: If you want to player another version than
|
||||
season 6, you may initialize the database with another game version.
|
||||
You can do this over the admin panel as well, at the ```Setup``` page.
|
||||
|
||||
## Test Accounts
|
||||
|
||||
To test some features of the server, test accounts are created automatically
|
||||
when the database is initialized.
|
||||
|
||||
These are the user names:
|
||||
|
||||
* test0 - test9: General test accounts, level 1 to 90, in 10 level steps
|
||||
|
||||
Season 6 only:
|
||||
* test300: General test account with level 300
|
||||
* test400: General test account with level 400, master characters
|
||||
* testgm: Test account of a game master
|
||||
* testgm2: Test account of a game master with summoner and rage fighter characters
|
||||
* testunlock: Test account without characters, but unlocked character classes
|
||||
* quest1: Test account for the level 150 quests
|
||||
* quest2: Test account for the level 220 quests
|
||||
* quest3: Test account for the level 400 quests
|
||||
* ancient: Test account with ancient item sets, level 330 characters
|
||||
* socket: Test account with socket item sets, level 380 characters
|
||||
|
||||
The __passwords__ of these accounts are the __same as the user name__.
|
||||
Reference in New Issue
Block a user