MHServerEmu/docs/Index.md

79 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

2023-10-03 08:01:15 +03:00
# MHServerEmu Documentation
2023-11-13 23:40:30 +03:00
If you would like to ask questions or get up to date information, please feel free to join our [Discord](https://discord.gg/hjR8Bj52t3).
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
## Setup
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
If this is your first time using MHServerEmu, you may be interested in this.
2023-10-03 08:01:15 +03:00
2024-03-10 19:31:00 +03:00
- [Initial Setup](./Setup/InitialSetup.md) - stable build setup instructions.
- [Manual Setup](./Setup/ManualSetup.md) - manual setup instructions for advanced users.
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
- [Advanced Setup](./Setup/AdvancedSetup.md) - advanced setup instructions (enabling accounts, remote connections, etc.).
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
## Server Emulator
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
MHServerEmu-specific topics.
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
- [Server Commands](./ServerEmu/ServerCommands.md) - a list of available server commands.
2026-01-15 00:54:23 +03:00
- [Web API](./ServerEmu/WebApi.md) - web API documentation.
2023-10-03 08:01:15 +03:00
2024-09-19 20:05:24 +03:00
## Game
2024-02-26 09:24:55 +03:00
Topics concerning the game in general.
2024-09-19 20:05:24 +03:00
- [Glossary](./Game/Glossary.md) - a list of terms used by the game internally.
2025-05-04 12:43:15 +03:00
- [Live Tuning](./Game/LiveTuning.md) - an overview of the live tuning system.
2024-09-19 20:05:24 +03:00
- [Properties](./Game/Properties.md) - information about game properties (entity stats).
2024-02-26 09:24:55 +03:00
2023-11-13 23:40:30 +03:00
## Networking
2023-11-13 23:40:30 +03:00
Information about client <-> server communication.
2023-10-03 08:01:15 +03:00
- [Packet Structure](./Networking/PacketStructure.md) - an overview of the packet structure.
- [Authentication](./Networking/Authentication.md) - an overview of the authentication flow.
2023-10-03 08:01:15 +03:00
2023-11-14 02:33:10 +03:00
## Game Data
Information about how static game data is stored and processed by the game.
2023-11-14 03:44:39 +03:00
- [Overview](./GameData/Overview.md) - a general overview of how game data is implemented.
2023-11-14 02:33:10 +03:00
- [Pak File](./GameData/PakFile.md) - an overview of the custom archive format used by the game.
2023-11-27 00:39:41 +03:00
- [Data References](./GameData/DataReferences.md) - how static data is referenced by the game.
2023-11-14 04:28:34 +03:00
- [Calligraphy](./GameData/Calligraphy.md) - an overview of the Calligraphy data system.
2023-11-14 02:33:10 +03:00
- [Resources](./GameData/Resources.md) - an overview of resource prototype files.
- [Auxiliary Resource Prototypes](./GameData/AuxiliaryResourcePrototypes.md) - information about auxiliary prototypes used in resources (markers and NaviPatches).
2023-11-16 06:03:12 +03:00
- [Locale](./GameData/Locale.md) - a reference table of supported locales and locale file format information.
2023-11-13 23:40:30 +03:00
## Web
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
Information about various web assets that the client gets via HTTP.
2023-10-03 08:01:15 +03:00
2023-11-13 23:40:30 +03:00
- [SiteConfig](./Web/SiteConfig.md) - SiteConfig.xml file structure.
- [Embedded Browser](./Web/EmbeddedBrowser.md) - API documentation for the web browser embedded in the client.
## Client
Information about how the client functions.
- [Client Versions](./Client/ClientVersions.md) - information on various client versions and how to get them.
- [Client Launch Parameters](./Client/ClientLaunchParameters.md) - a list of various launch parameters that you can use when running the client (such as enabling verbose logging).
- [Client INI Files](./Client/ClientIniFiles.md) - information on Unreal Engine INI configuration files used by the client.
2023-11-13 23:40:30 +03:00
- [ClientConfig](./Client/ClientConfig.md) - ClientConfig.xml file structure.
- [Client Chat Commands](./Client/ClientChatCommands.md) - a list of chat commands available in the client.
- [Internal Console Commands](./Client/InternalConsoleCommands.md) - a list of console commands available in internal builds of the game.